xref: /aoo42x/main/offapi/com/sun/star/xml/sax/XDocumentHandler.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
#define __com_sun_star_xml_sax_XDocumentHandler_idl__

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

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

#ifndef __com_sun_star_xml_sax_XAttributeList_idl__
#include <com/sun/star/xml/sax/XAttributeList.idl>
#endif

#ifndef __com_sun_star_xml_sax_XLocator_idl__
#include <com/sun/star/xml/sax/XLocator.idl>
#endif


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

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

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

/** receives notification of general document events.

	<p>This interface is an IDL version of the Java interface
	<em>org.xml.sax.DocumentHandler</em> with some smaller
	adaptations.</p>
 */
published interface XDocumentHandler: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** receives notification of the beginning of a document.
	 */
	void startDocument()
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of the end of a document.
	 */
	void endDocument()
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of the beginning of an element .
	 */
	void startElement( [in] string aName,
			 [in] com::sun::star::xml::sax::XAttributeList xAttribs )
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of the end of an element.
	 */
	void endElement( [in] string aName )
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of character data.
	 */
	void characters( [in] string aChars )
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of white space that can be ignored.
	 */
	void ignorableWhitespace( [in] string aWhitespaces )
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives notification of a processing instruction.
	 */
	void processingInstruction( [in] string aTarget,
			 [in] string aData )
			raises( com::sun::star::xml::sax::SAXException );

	//-------------------------------------------------------------------------

	/** receives an object for locating the origin of SAX document events.
	 */
	void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
			raises( com::sun::star::xml::sax::SAXException );

};

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

}; }; }; }; };

#endif