xref: /trunk/main/offapi/com/sun/star/xml/sax/XParser.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_xml_sax_XParser_idl__
#define __com_sun_star_xml_sax_XParser_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_xml_sax_InputSource_idl__
#include <com/sun/star/xml/sax/InputSource.idl>
#endif

#ifndef __com_sun_star_xml_sax_SAXException_idl__
#include <com/sun/star/xml/sax/SAXException.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
#include <com/sun/star/xml/sax/XDocumentHandler.idl>
#endif

#ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
#include <com/sun/star/xml/sax/XErrorHandler.idl>
#endif

#ifndef __com_sun_star_xml_sax_XDTDHandler_idl__
#include <com/sun/star/xml/sax/XDTDHandler.idl>
#endif

#ifndef __com_sun_star_xml_sax_XEntityResolver_idl__
#include <com/sun/star/xml/sax/XEntityResolver.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module xml {  module sax {

//=============================================================================

/** specifies a SAX parser.

	<p>This interface is an IDL version of the Java interface
	<em>org.xml.sax.Parser</em> with some minor adaptations.</p>
 */
published interface XParser: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** parses an XML document from a stream.

		<p>Set the desired handlers before calling this method.</p>
	 */
	void parseStream( [in] com::sun::star::xml::sax::InputSource aInputSource )
			raises( com::sun::star::xml::sax::SAXException,
					com::sun::star::io::IOException );

	//-------------------------------------------------------------------------
	/** allows an application to register a document event handler.
	 */
	void setDocumentHandler( [in] com::sun::star::xml::sax::XDocumentHandler xHandler );

	//-------------------------------------------------------------------------
	/** allows an application to register an error event handler.

		<p>Note that the error handler can throw an exception when an error or
		warning occurs.  Note that an exception is thrown by the parser when
		an unrecoverable (fatal) error occurs.</p>
	 */
	void setErrorHandler( [in] com::sun::star::xml::sax::XErrorHandler xHandler );

	//-------------------------------------------------------------------------
	/** allows an application to register a DTD-Handler.
	 */
	void setDTDHandler( [in] com::sun::star::xml::sax::XDTDHandler xHandler );

	//-------------------------------------------------------------------------
	/** allows an application to register a DTD-Handler.
	 */
	void setEntityResolver( [in] com::sun::star::xml::sax::XEntityResolver xResolver );

	//-------------------------------------------------------------------------
	/** sets a locale specified for localization of warnings and error messages.

		<p>Set the language of the error messages. Useful when the parsing
		errors will be presented to the user.</p>
	 */
	void setLocale( [in] com::sun::star::lang::Locale locale );
};

//=============================================================================

}; }; }; }; };

#endif