offapi/com/sun/star/xml/sax/XFastContextHandler.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: XFastContextHandler.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef __com_sun_star_xml_sax_XFastContextHandler_idl__
  31 #define __com_sun_star_xml_sax_XFastContextHandler_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_xml_sax_SAXException_idl__
  38 #include <com/sun/star/xml/sax/SAXException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_xml_sax_XFastAttributeList_idl__
  42 #include <com/sun/star/xml/sax/XFastAttributeList.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_xml_sax_XLocator_idl__
  46 #include <com/sun/star/xml/sax/XLocator.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module xml {  module sax {
  53
  54 //=============================================================================
  55
  56 /** receives notification of sax document events from a
  57     <type>XFastParser</type>.
  58
  59     @see XFastDocumentHandler
  60  */
  61 interface XFastContextHandler: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** receives notification of the beginning of an element .
  66
  67         @param Element
  68             contains the integer token from the <type>XFastTokenHandler</type>
  69             registered at the <type>XFastParser</type>.<br>
  70
  71             If the element has a namespace that was registered with the
  72             <type>XFastParser</type>, <param>Element</param> contains the integer
  73             token of the elements local name from the <type>XFastTokenHandler</type>
  74             and the integer token of the namespace combined with an arithmetic
  75             <b>or</b> operation.
  76
  77         @param Attribs
  78             Contains a <type>XFastAttrbitueList</type> to access the attributes
  79             from the element.
  80
  81     */
  82     void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
  83             raises( com::sun::star::xml::sax::SAXException );
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** receives notification of the beginning of an unknown element .
  88
  89         @param Namespace
  90             contains the namespace url (not the prefix!) of this element.
  91         @param Name
  92             contains the elements local name.
  93         @param Attribs
  94             Contains a <type>XFastAttrbitueList</type> to access the attributes
  95             from the element.
  96      */
  97     void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
  98             raises( com::sun::star::xml::sax::SAXException );
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** receives notification of the end of an known element.
 103         @see startFastElement
 104      */
 105     void endFastElement( [in] long Element )
 106             raises( com::sun::star::xml::sax::SAXException );
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** receives notification of the end of an kown element.
 111         @see startUnknownElement
 112      */
 113     void endUnknownElement( [in] string Namespace, [in] string Name )
 114             raises( com::sun::star::xml::sax::SAXException );
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** receives notification of the beginning of a known child element.
 119
 120         @param Element
 121             contains the integer token from the <type>XFastTokenHandler</type>
 122             registered at the <type>XFastParser</type>.
 123
 124             <br>If the element has a namespace that was registered with the
 125             <type>XFastParser</type>, <param>Element</param> contains the
 126             integer token of the elements local name from the
 127             <type>XFastTokenHandler</type> and the integer token of the
 128             namespace combined with an arithmetic <b>or</b> operation.
 129
 130         @param Attribs
 131             Contains a <type>XFastAttrbitueList</type> to access the attributes
 132             from the element.
 133      */
 134     XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs )
 135             raises( com::sun::star::xml::sax::SAXException );
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** receives notification of the beginning of a unknown child element .
 140
 141         @param Namespace
 142             contains the namespace url (not the prefix!) of this element.
 143         @param Name
 144             contains the elements local name.
 145         @param Attribs
 146             Contains a <type>XFastAttrbitueList</type> to access the attributes
 147             the element.
 148      */
 149     XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
 150             raises( com::sun::star::xml::sax::SAXException );
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** receives notification of character data.
 155      */
 156     void characters( [in] string aChars )
 157             raises( com::sun::star::xml::sax::SAXException );
 158   };
 159
 160 //=============================================================================
 161
 162 }; }; }; }; };
 163
 164 #endif