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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_xml_input_XElement_idl__
  20 #define __com_sun_star_xml_input_XElement_idl__
  21
  22 #include <com/sun/star/xml/input/XAttributes.idl>
  23 #include <com/sun/star/xml/sax/SAXException.idl>
  24
  25
  26 module com { module sun { module star { module xml { module input {
  27
  28 /** Capsule around an XML element.
  29
  30     @internal
  31 */
  32 interface XElement : com::sun::star::uno::XInterface
  33 {
  34     /** Gets the parent context.
  35
  36         @return
  37                 parent context
  38     */
  39     XElement getParent();
  40
  41     /** Gets the local name of this element.
  42
  43         @return
  44                 local name of this element
  45     */
  46     string getLocalName();
  47
  48     /** Gets the namespace uid of this element.
  49
  50         @return
  51                 namespace uid of this element
  52     */
  53     long getUid();
  54
  55     /** Gets the attributes of this element.
  56
  57         @return
  58                 attributes of this element
  59     */
  60     XAttributes getAttributes();
  61
  62     /** Called upon each occurring child element.
  63
  64         @param uid
  65                namespace uid of element
  66         @param localName
  67                local name of element
  68         @param xAttributes
  69                attributes of element
  70         @return
  71                 child import context
  72     */
  73     XElement startChildElement(
  74         [in] long uid, [in] string localName, [in] XAttributes xAttributes )
  75         raises (com::sun::star::xml::sax::SAXException);
  76
  77     /** Called upon retrieval of characters.
  78
  79         @param chars
  80                characters
  81     */
  82     void characters( [in] string chars )
  83         raises (com::sun::star::xml::sax::SAXException);
  84
  85     /** Receives notification of white space that can be ignored.
  86
  87         @param whitespace
  88                white space characters
  89     */
  90     void ignorableWhitespace( [in] string whitespace )
  91         raises (com::sun::star::xml::sax::SAXException);
  92
  93     /** Receives notification of a processing instruction.
  94
  95         @param target
  96                target
  97         @param data
  98                data
  99     */
 100     void processingInstruction(
 101         [in] string target, [in] string data )
 102         raises (com::sun::star::xml::sax::SAXException);
 103
 104     /** Receives notification of element closing.
 105      */
 106     void endElement()
 107         raises (com::sun::star::xml::sax::SAXException);
 108 };
 109
 110 }; }; }; }; };
 111
 112 #endif
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */