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