offapi/com/sun/star/xml/sax/XFastContextHandler.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_sax_XFastContextHandler_idl__
  20 #define __com_sun_star_xml_sax_XFastContextHandler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/xml/sax/SAXException.idl>
  25
  26 #include <com/sun/star/xml/sax/XFastAttributeList.idl>
  27
  28 #include <com/sun/star/xml/sax/XLocator.idl>
  29
  30
  31
  32 module com {  module sun {  module star {  module xml {  module sax {
  33
  34
  35 /** receives notification of sax document events from a
  36     XFastParser.
  37
  38     @see XFastDocumentHandler
  39  */
  40 interface XFastContextHandler: com::sun::star::uno::XInterface
  41 {
  42
  43     /** receives notification of the beginning of an element .
  44
  45         @param Element
  46             contains the integer token from the XFastTokenHandler
  47             registered at the XFastParser.<br>
  48
  49             If the element has a namespace that was registered with the
  50             XFastParser, <code>Element</code> contains the integer
  51             token of the elements local name from the XFastTokenHandler
  52             and the integer token of the namespace combined with an arithmetic
  53             <b>or</b> operation.
  54
  55         @param Attribs
  56             Contains a XFastAttrbitueList to access the attributes
  57             from the element.
  58
  59     */
  60     void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
  61             raises( com::sun::star::xml::sax::SAXException );
  62
  63
  64     /** receives notification of the beginning of an unknown element .
  65
  66         @param Namespace
  67             contains the namespace url (not the prefix!) of this element.
  68         @param Name
  69             contains the elements local name.
  70         @param Attribs
  71             Contains a XFastAttrbitueList to access the attributes
  72             from the element.
  73      */
  74     void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
  75             raises( com::sun::star::xml::sax::SAXException );
  76
  77
  78     /** receives notification of the end of an known element.
  79         @see startFastElement
  80      */
  81     void endFastElement( [in] long Element )
  82             raises( com::sun::star::xml::sax::SAXException );
  83
  84
  85     /** receives notification of the end of an known element.
  86         @see startUnknownElement
  87      */
  88     void endUnknownElement( [in] string Namespace, [in] string Name )
  89             raises( com::sun::star::xml::sax::SAXException );
  90
  91
  92     /** receives notification of the beginning of a known child element.
  93
  94         @param Element
  95             contains the integer token from the XFastTokenHandler
  96             registered at the XFastParser.
  97
  98             <br>If the element has a namespace that was registered with the
  99             XFastParser, <code>Element</code> contains the
 100             integer token of the elements local name from the
 101             XFastTokenHandler and the integer token of the
 102             namespace combined with an arithmetic <b>or</b> operation.
 103
 104         @param Attribs
 105             Contains a XFastAttrbitueList to access the attributes
 106             from the element.
 107      */
 108     XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs )
 109             raises( com::sun::star::xml::sax::SAXException );
 110
 111
 112     /** receives notification of the beginning of a unknown child element .
 113
 114         @param Namespace
 115             contains the namespace url (not the prefix!) of this element.
 116         @param Name
 117             contains the elements local name.
 118         @param Attribs
 119             Contains a XFastAttrbitueList to access the attributes
 120             the element.
 121      */
 122     XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
 123             raises( com::sun::star::xml::sax::SAXException );
 124
 125
 126     /** receives notification of character data.
 127      */
 128     void characters( [in] string aChars )
 129             raises( com::sun::star::xml::sax::SAXException );
 130   };
 131
 132
 133 }; }; }; }; };
 134
 135 #endif
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */