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

/**************************************************************
 *
 * 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_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