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_XDocumentHandler_idl__
24#define __com_sun_star_xml_sax_XDocumentHandler_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_XAttributeList_idl__
35#include <com/sun/star/xml/sax/XAttributeList.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 general document events.
50
51	<p>This interface is an IDL version of the Java interface
52	<em>org.xml.sax.DocumentHandler</em> with some smaller
53	adaptations.</p>
54 */
55published interface XDocumentHandler: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58
59	/** receives notification of the beginning of a document.
60	 */
61	void startDocument()
62			raises( com::sun::star::xml::sax::SAXException );
63
64	//-------------------------------------------------------------------------
65
66	/** receives notification of the end of a document.
67	 */
68	void endDocument()
69			raises( com::sun::star::xml::sax::SAXException );
70
71	//-------------------------------------------------------------------------
72
73	/** receives notification of the beginning of an element .
74	 */
75	void startElement( [in] string aName,
76			 [in] com::sun::star::xml::sax::XAttributeList xAttribs )
77			raises( com::sun::star::xml::sax::SAXException );
78
79	//-------------------------------------------------------------------------
80
81	/** receives notification of the end of an element.
82	 */
83	void endElement( [in] string aName )
84			raises( com::sun::star::xml::sax::SAXException );
85
86	//-------------------------------------------------------------------------
87
88	/** receives notification of character data.
89	 */
90	void characters( [in] string aChars )
91			raises( com::sun::star::xml::sax::SAXException );
92
93	//-------------------------------------------------------------------------
94
95	/** receives notification of white space that can be ignored.
96	 */
97	void ignorableWhitespace( [in] string aWhitespaces )
98			raises( com::sun::star::xml::sax::SAXException );
99
100	//-------------------------------------------------------------------------
101
102	/** receives notification of a processing instruction.
103	 */
104	void processingInstruction( [in] string aTarget,
105			 [in] string aData )
106			raises( com::sun::star::xml::sax::SAXException );
107
108	//-------------------------------------------------------------------------
109
110	/** receives an object for locating the origin of SAX document events.
111	 */
112	void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
113			raises( com::sun::star::xml::sax::SAXException );
114
115};
116
117//=============================================================================
118
119}; }; }; }; };
120
121#endif
122