1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XParser.idl,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_xml_sax_XParser_idl__
31 #define __com_sun_star_xml_sax_XParser_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include
<com
/sun
/star
/uno
/XInterface.idl
>
37 #ifndef __com_sun_star_xml_sax_InputSource_idl__
38 #include
<com
/sun
/star
/xml
/sax
/InputSource.idl
>
41 #ifndef __com_sun_star_xml_sax_SAXException_idl__
42 #include
<com
/sun
/star
/xml
/sax
/SAXException.idl
>
45 #ifndef __com_sun_star_io_IOException_idl__
46 #include
<com
/sun
/star
/io
/IOException.idl
>
49 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
50 #include
<com
/sun
/star
/xml
/sax
/XDocumentHandler.idl
>
53 #ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
54 #include
<com
/sun
/star
/xml
/sax
/XErrorHandler.idl
>
57 #ifndef __com_sun_star_xml_sax_XDTDHandler_idl__
58 #include
<com
/sun
/star
/xml
/sax
/XDTDHandler.idl
>
61 #ifndef __com_sun_star_xml_sax_XEntityResolver_idl__
62 #include
<com
/sun
/star
/xml
/sax
/XEntityResolver.idl
>
65 #ifndef __com_sun_star_lang_Locale_idl__
66 #include
<com
/sun
/star
/lang
/Locale.idl
>
70 //=============================================================================
72 module com
{ module sun
{ module star
{ module xml
{ module sax
{
74 //=============================================================================
76 /** specifies a SAX parser.
78 <p>This interface is an IDL version of the Java interface
79 <em>org.xml.sax.Parser</em> with some minor adaptations.</p>
81 published
interface XParser
: com
::sun
::star
::uno
::XInterface
83 //-------------------------------------------------------------------------
84 /** parses an XML document from a stream.
86 <p>Set the desired handlers before calling this method.</p>
88 void parseStream
( [in] com
::sun
::star
::xml
::sax
::InputSource aInputSource
)
89 raises
( com
::sun
::star
::xml
::sax
::SAXException
,
90 com
::sun
::star
::io
::IOException
);
92 //-------------------------------------------------------------------------
93 /** allows an application to register a document event handler.
95 void setDocumentHandler
( [in] com
::sun
::star
::xml
::sax
::XDocumentHandler xHandler
);
97 //-------------------------------------------------------------------------
98 /** allows an application to register an error event handler.
100 <p>Note that the error handler can throw an exception when an error or
101 warning occurs. Note that an exception is thrown by the parser when
102 an unrecoverable (fatal) error occurs.</p>
104 void setErrorHandler
( [in] com
::sun
::star
::xml
::sax
::XErrorHandler xHandler
);
106 //-------------------------------------------------------------------------
107 /** allows an application to register a DTD-Handler.
109 void setDTDHandler
( [in] com
::sun
::star
::xml
::sax
::XDTDHandler xHandler
);
111 //-------------------------------------------------------------------------
112 /** allows an application to register a DTD-Handler.
114 void setEntityResolver
( [in] com
::sun
::star
::xml
::sax
::XEntityResolver xResolver
);
116 //-------------------------------------------------------------------------
117 /** sets a locale specified for localization of warnings and error messages.
119 <p>Set the language of the error messages. Useful when the parsing
120 errors will be presented to the user.</p>
122 void setLocale
( [in] com
::sun
::star
::lang
::Locale locale
);
125 //=============================================================================