xref: /trunk/main/offapi/com/sun/star/xml/sax/XFastContextHandler.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_xml_sax_XFastContextHandler_idl__
28#define __com_sun_star_xml_sax_XFastContextHandler_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_xml_sax_SAXException_idl__
35#include <com/sun/star/xml/sax/SAXException.idl>
36#endif
37
38#ifndef __com_sun_star_xml_sax_XFastAttributeList_idl__
39#include <com/sun/star/xml/sax/XFastAttributeList.idl>
40#endif
41
42#ifndef __com_sun_star_xml_sax_XLocator_idl__
43#include <com/sun/star/xml/sax/XLocator.idl>
44#endif
45
46
47//=============================================================================
48
49module com {  module sun {  module star {  module xml {  module sax {
50
51//=============================================================================
52
53/** receives notification of sax document events from a
54    <type>XFastParser</type>.
55
56    @see XFastDocumentHandler
57 */
58interface XFastContextHandler: com::sun::star::uno::XInterface
59{
60    //-------------------------------------------------------------------------
61
62    /** receives notification of the beginning of an element .
63
64        @param Element
65            contains the integer token from the <type>XFastTokenHandler</type>
66            registered at the <type>XFastParser</type>.<br>
67
68            If the element has a namespace that was registered with the
69            <type>XFastParser</type>, <param>Element</param> contains the integer
70            token of the elements local name from the <type>XFastTokenHandler</type>
71            and the integer token of the namespace combined with an arithmetic
72            <b>or</b> operation.
73
74        @param Attribs
75            Contains a <type>XFastAttrbitueList</type> to access the attributes
76            from the element.
77
78    */
79    void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
80            raises( com::sun::star::xml::sax::SAXException );
81
82    //-------------------------------------------------------------------------
83
84    /** receives notification of the beginning of an unknown element .
85
86        @param Namespace
87            contains the namespace url (not the prefix!) of this element.
88        @param Name
89            contains the elements local name.
90        @param Attribs
91            Contains a <type>XFastAttrbitueList</type> to access the attributes
92            from the element.
93     */
94    void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
95            raises( com::sun::star::xml::sax::SAXException );
96
97    //-------------------------------------------------------------------------
98
99    /** receives notification of the end of an known element.
100        @see startFastElement
101     */
102    void endFastElement( [in] long Element )
103            raises( com::sun::star::xml::sax::SAXException );
104
105    //-------------------------------------------------------------------------
106
107    /** receives notification of the end of an kown element.
108        @see startUnknownElement
109     */
110    void endUnknownElement( [in] string Namespace, [in] string Name )
111            raises( com::sun::star::xml::sax::SAXException );
112
113    //-------------------------------------------------------------------------
114
115    /** receives notification of the beginning of a known child element.
116
117        @param Element
118            contains the integer token from the <type>XFastTokenHandler</type>
119            registered at the <type>XFastParser</type>.
120
121            <br>If the element has a namespace that was registered with the
122            <type>XFastParser</type>, <param>Element</param> contains the
123            integer token of the elements local name from the
124            <type>XFastTokenHandler</type> and the integer token of the
125            namespace combined with an arithmetic <b>or</b> operation.
126
127        @param Attribs
128            Contains a <type>XFastAttrbitueList</type> to access the attributes
129            from the element.
130     */
131    XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs )
132            raises( com::sun::star::xml::sax::SAXException );
133
134    //-------------------------------------------------------------------------
135
136    /** receives notification of the beginning of a unknown child element .
137
138        @param Namespace
139            contains the namespace url (not the prefix!) of this element.
140        @param Name
141            contains the elements local name.
142        @param Attribs
143            Contains a <type>XFastAttrbitueList</type> to access the attributes
144            the element.
145     */
146    XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
147            raises( com::sun::star::xml::sax::SAXException );
148
149    //-------------------------------------------------------------------------
150
151    /** receives notification of character data.
152     */
153    void characters( [in] string aChars )
154            raises( com::sun::star::xml::sax::SAXException );
155  };
156
157//=============================================================================
158
159}; }; }; }; };
160
161#endif
162