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