xref: /AOO41X/main/offapi/com/sun/star/xml/sax/XFastContextHandler.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_xml_sax_XFastContextHandler_idl__
24#define __com_sun_star_xml_sax_XFastContextHandler_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_xml_sax_SAXException_idl__
31#include <com/sun/star/xml/sax/SAXException.idl>
32#endif
33
34#ifndef __com_sun_star_xml_sax_XFastAttributeList_idl__
35#include <com/sun/star/xml/sax/XFastAttributeList.idl>
36#endif
37
38#ifndef __com_sun_star_xml_sax_XLocator_idl__
39#include <com/sun/star/xml/sax/XLocator.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module xml {  module sax {
46
47//=============================================================================
48
49/** receives notification of sax document events from a
50    <type>XFastParser</type>.
51
52    @see XFastDocumentHandler
53 */
54interface XFastContextHandler: com::sun::star::uno::XInterface
55{
56    //-------------------------------------------------------------------------
57
58    /** receives notification of the beginning of an element .
59
60        @param Element
61            contains the integer token from the <type>XFastTokenHandler</type>
62            registered at the <type>XFastParser</type>.<br>
63
64            If the element has a namespace that was registered with the
65            <type>XFastParser</type>, <param>Element</param> contains the integer
66            token of the elements local name from the <type>XFastTokenHandler</type>
67            and the integer token of the namespace combined with an arithmetic
68            <b>or</b> operation.
69
70        @param Attribs
71            Contains a <type>XFastAttrbitueList</type> to access the attributes
72            from the element.
73
74    */
75    void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
76            raises( com::sun::star::xml::sax::SAXException );
77
78    //-------------------------------------------------------------------------
79
80    /** receives notification of the beginning of an unknown element .
81
82        @param Namespace
83            contains the namespace url (not the prefix!) of this element.
84        @param Name
85            contains the elements local name.
86        @param Attribs
87            Contains a <type>XFastAttrbitueList</type> to access the attributes
88            from the element.
89     */
90    void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
91            raises( com::sun::star::xml::sax::SAXException );
92
93    //-------------------------------------------------------------------------
94
95    /** receives notification of the end of an known element.
96        @see startFastElement
97     */
98    void endFastElement( [in] long Element )
99            raises( com::sun::star::xml::sax::SAXException );
100
101    //-------------------------------------------------------------------------
102
103    /** receives notification of the end of an kown element.
104        @see startUnknownElement
105     */
106    void endUnknownElement( [in] string Namespace, [in] string Name )
107            raises( com::sun::star::xml::sax::SAXException );
108
109    //-------------------------------------------------------------------------
110
111    /** receives notification of the beginning of a known child element.
112
113        @param Element
114            contains the integer token from the <type>XFastTokenHandler</type>
115            registered at the <type>XFastParser</type>.
116
117            <br>If the element has a namespace that was registered with the
118            <type>XFastParser</type>, <param>Element</param> contains the
119            integer token of the elements local name from the
120            <type>XFastTokenHandler</type> and the integer token of the
121            namespace combined with an arithmetic <b>or</b> operation.
122
123        @param Attribs
124            Contains a <type>XFastAttrbitueList</type> to access the attributes
125            from the element.
126     */
127    XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs )
128            raises( com::sun::star::xml::sax::SAXException );
129
130    //-------------------------------------------------------------------------
131
132    /** receives notification of the beginning of a unknown child element .
133
134        @param Namespace
135            contains the namespace url (not the prefix!) of this element.
136        @param Name
137            contains the elements local name.
138        @param Attribs
139            Contains a <type>XFastAttrbitueList</type> to access the attributes
140            the element.
141     */
142    XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
143            raises( com::sun::star::xml::sax::SAXException );
144
145    //-------------------------------------------------------------------------
146
147    /** receives notification of character data.
148     */
149    void characters( [in] string aChars )
150            raises( com::sun::star::xml::sax::SAXException );
151  };
152
153//=============================================================================
154
155}; }; }; }; };
156
157#endif
158