/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XExtendedDocumentHandler.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 10:13:33 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
#define __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__

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

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


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

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

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

/** this interface does not conform to the SAX-standard.

    <p>Note: Whether or not every callback is supported is dependent
    on the parser implementation.
 */
published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler
{
    //-------------------------------------------------------------------------
    /** receives notification about the start of a CDATA section in the
        XML-source.

        <p>Any string comming in via character handler may include chars,
        that would otherwise be interpreted as markup. </p>
     */
    void startCDATA()
            raises( com::sun::star::xml::sax::SAXException );

    //-------------------------------------------------------------------------
    /** informs about the end of a CDATA-Section.

        <p>Note that <code>startCDATA/endCDATA</code> MUST NOT enclose any
        <code>startElement/endElement</code>-call!</p>
     */
    void endCDATA();

    //-------------------------------------------------------------------------
    /** receives notification about a comment in the XML-source.
     */
    void comment( [in] string sComment )
            raises( com::sun::star::xml::sax::SAXException );

    //-------------------------------------------------------------------------
    /** informs a writer that it is allowable to insert a line break and
        indentation before the next <type>XDocumentHandler</type>-call.
     */
    void allowLineBreak()
            raises( com::sun::star::xml::sax::SAXException );

    //-------------------------------------------------------------------------
    /** notifies that any characters that cannot be handled by other callback
        methods are announced through this method.
     */
    void unknown( [in] string sString )
            raises( com::sun::star::xml::sax::SAXException );
};

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

}; }; }; }; };

#endif
