xref: /aoo41x/main/offapi/com/sun/star/xml/sax/XParser.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XParser_idl__
24cdf0e10cSrcweir#define __com_sun_star_xml_sax_XParser_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_InputSource_idl__
31cdf0e10cSrcweir#include <com/sun/star/xml/sax/InputSource.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_SAXException_idl__
35cdf0e10cSrcweir#include <com/sun/star/xml/sax/SAXException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_io_IOException_idl__
39cdf0e10cSrcweir#include <com/sun/star/io/IOException.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
43cdf0e10cSrcweir#include <com/sun/star/xml/sax/XDocumentHandler.idl>
44cdf0e10cSrcweir#endif
45cdf0e10cSrcweir
46cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
47cdf0e10cSrcweir#include <com/sun/star/xml/sax/XErrorHandler.idl>
48cdf0e10cSrcweir#endif
49cdf0e10cSrcweir
50cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XDTDHandler_idl__
51cdf0e10cSrcweir#include <com/sun/star/xml/sax/XDTDHandler.idl>
52cdf0e10cSrcweir#endif
53cdf0e10cSrcweir
54cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XEntityResolver_idl__
55cdf0e10cSrcweir#include <com/sun/star/xml/sax/XEntityResolver.idl>
56cdf0e10cSrcweir#endif
57cdf0e10cSrcweir
58cdf0e10cSrcweir#ifndef __com_sun_star_lang_Locale_idl__
59cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl>
60cdf0e10cSrcweir#endif
61cdf0e10cSrcweir
62cdf0e10cSrcweir
63cdf0e10cSrcweir//=============================================================================
64cdf0e10cSrcweir
65cdf0e10cSrcweirmodule com {  module sun {  module star {  module xml {  module sax {
66cdf0e10cSrcweir
67cdf0e10cSrcweir//=============================================================================
68cdf0e10cSrcweir
69cdf0e10cSrcweir/** specifies a SAX parser.
70cdf0e10cSrcweir
71cdf0e10cSrcweir	<p>This interface is an IDL version of the Java interface
72cdf0e10cSrcweir	<em>org.xml.sax.Parser</em> with some minor adaptations.</p>
73cdf0e10cSrcweir */
74cdf0e10cSrcweirpublished interface XParser: com::sun::star::uno::XInterface
75cdf0e10cSrcweir{
76cdf0e10cSrcweir	//-------------------------------------------------------------------------
77cdf0e10cSrcweir	/** parses an XML document from a stream.
78cdf0e10cSrcweir
79cdf0e10cSrcweir		<p>Set the desired handlers before calling this method.</p>
80cdf0e10cSrcweir	 */
81cdf0e10cSrcweir	void parseStream( [in] com::sun::star::xml::sax::InputSource aInputSource )
82cdf0e10cSrcweir			raises( com::sun::star::xml::sax::SAXException,
83cdf0e10cSrcweir					com::sun::star::io::IOException );
84cdf0e10cSrcweir
85cdf0e10cSrcweir	//-------------------------------------------------------------------------
86cdf0e10cSrcweir	/** allows an application to register a document event handler.
87cdf0e10cSrcweir	 */
88cdf0e10cSrcweir	void setDocumentHandler( [in] com::sun::star::xml::sax::XDocumentHandler xHandler );
89cdf0e10cSrcweir
90cdf0e10cSrcweir	//-------------------------------------------------------------------------
91cdf0e10cSrcweir	/** allows an application to register an error event handler.
92cdf0e10cSrcweir
93cdf0e10cSrcweir		<p>Note that the error handler can throw an exception when an error or
94cdf0e10cSrcweir		warning occurs.  Note that an exception is thrown by the parser when
95cdf0e10cSrcweir		an unrecoverable (fatal) error occurs.</p>
96cdf0e10cSrcweir	 */
97cdf0e10cSrcweir	void setErrorHandler( [in] com::sun::star::xml::sax::XErrorHandler xHandler );
98cdf0e10cSrcweir
99cdf0e10cSrcweir	//-------------------------------------------------------------------------
100cdf0e10cSrcweir	/** allows an application to register a DTD-Handler.
101cdf0e10cSrcweir	 */
102cdf0e10cSrcweir	void setDTDHandler( [in] com::sun::star::xml::sax::XDTDHandler xHandler );
103cdf0e10cSrcweir
104cdf0e10cSrcweir	//-------------------------------------------------------------------------
105cdf0e10cSrcweir	/** allows an application to register a DTD-Handler.
106cdf0e10cSrcweir	 */
107cdf0e10cSrcweir	void setEntityResolver( [in] com::sun::star::xml::sax::XEntityResolver xResolver );
108cdf0e10cSrcweir
109cdf0e10cSrcweir	//-------------------------------------------------------------------------
110cdf0e10cSrcweir	/** sets a locale specified for localization of warnings and error messages.
111cdf0e10cSrcweir
112cdf0e10cSrcweir		<p>Set the language of the error messages. Useful when the parsing
113cdf0e10cSrcweir		errors will be presented to the user.</p>
114cdf0e10cSrcweir	 */
115cdf0e10cSrcweir	void setLocale( [in] com::sun::star::lang::Locale locale );
116cdf0e10cSrcweir};
117cdf0e10cSrcweir
118cdf0e10cSrcweir//=============================================================================
119cdf0e10cSrcweir
120cdf0e10cSrcweir}; }; }; }; };
121cdf0e10cSrcweir
122cdf0e10cSrcweir#endif
123