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
  20
  21 module com { module sun { module star { module xml { module input {
  22
  23 /** Capsule around an XML element.
  24
  25     @internal
  26 */
  27 interface XElement : com::sun::star::uno::XInterface
  28 {
  29     /** Gets the parent context.
  30
  31         @return
  32                 parent context
  33     */
  34     XElement getParent();
  35
  36     /** Gets the local name of this element.
  37
  38         @return
  39                 local name of this element
  40     */
  41     string getLocalName();
  42
  43     /** Gets the namespace uid of this element.
  44
  45         @return
  46                 namespace uid of this element
  47     */
  48     long getUid();
  49
  50     /** Gets the attributes of this element.
  51
  52         @return
  53                 attributes of this element
  54     */
  55     XAttributes getAttributes();
  56
  57     /** Called upon each occurring child element.
  58
  59         @param uid
  60                namespace uid of element
  61         @param localName
  62                local name of element
  63         @param xAttributes
  64                attributes of element
  65         @return
  66                 child import context
  67     */
  68     XElement startChildElement(
  69         [in] long uid, [in] string localName, [in] XAttributes xAttributes )
  70         raises (com::sun::star::xml::sax::SAXException);
  71
  72     /** Called upon retrieval of characters.
  73
  74         @param chars
  75                characters
  76     */
  77     void characters( [in] string chars )
  78         raises (com::sun::star::xml::sax::SAXException);
  79
  80     /** Receives notification of white space that can be ignored.
  81
  82         @param whitespace
  83                white space characters
  84     */
  85     void ignorableWhitespace( [in] string whitespace )
  86         raises (com::sun::star::xml::sax::SAXException);
  87
  88     /** Receives notification of a processing instruction.
  89
  90         @param target
  91                target
  92         @param data
  93                data
  94     */
  95     void processingInstruction(
  96         [in] string target, [in] string data )
  97         raises (com::sun::star::xml::sax::SAXException);
  98
  99     /** Receives notification of element closing.
 100      */
 101     void endElement()
 102         raises (com::sun::star::xml::sax::SAXException);
 103 };
 104
 105 }; }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */