offapi/com/sun/star/xml/input/XElement.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XElement.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #if ! defined INCLUDED__com_sun_star_xml_input_XElement_idl__
  31 #define INCLUDED__com_sun_star_xml_input_XElement_idl__
  32
  33 #include <com/sun/star/xml/input/XAttributes.idl>
  34 #include <com/sun/star/xml/sax/SAXException.idl>
  35
  36
  37 module com { module sun { module star { module xml { module input {
  38
  39 /** Capsule around an XML element.
  40
  41     @internal
  42 */
  43 interface XElement : com::sun::star::uno::XInterface
  44 {
  45     /** Gets the parent context.
  46
  47         @return
  48                 parent context
  49     */
  50     XElement getParent();
  51
  52     /** Gets the localname of this element.
  53
  54         @return
  55                 localname of this element
  56     */
  57     string getLocalName();
  58
  59     /** Gets the namespace uid of this element.
  60
  61         @return
  62                 namespace uid of this element
  63     */
  64     long getUid();
  65
  66     /** Gets the attributes of this element.
  67
  68         @return
  69                 attributes of this element
  70     */
  71     XAttributes getAttributes();
  72
  73     /** Called upon each occuring child element.
  74
  75         @param uid
  76                namespace uid of element
  77         @param localName
  78                localname of element
  79         @param xAttributes
  80                attributes of element
  81         @return
  82                 child import context
  83     */
  84     XElement startChildElement(
  85         [in] long uid, [in] string localName, [in] XAttributes xAttributes )
  86         raises (com::sun::star::xml::sax::SAXException);
  87
  88     /** Called upon retrieval of characters.
  89
  90         @param chars
  91                characters
  92     */
  93     void characters( [in] string chars )
  94         raises (com::sun::star::xml::sax::SAXException);
  95
  96     /** Receives notification of white space that can be ignored.
  97
  98         @param whitespace
  99                white space characters
 100     */
 101     void ignorableWhitespace( [in] string whitespace )
 102         raises (com::sun::star::xml::sax::SAXException);
 103
 104     /** Receives notification of a processing instruction.
 105
 106         @param target
 107                target
 108         @param data
 109                data
 110     */
 111     void processingInstruction(
 112         [in] string target, [in] string data )
 113         raises (com::sun::star::xml::sax::SAXException);
 114
 115     /** Receives notification of element closing.
 116      */
 117     void endElement()
 118         raises (com::sun::star::xml::sax::SAXException);
 119 };
 120
 121 }; }; }; }; };
 122
 123 #endif