/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XFastSerializer.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 10:12:27 $
 *
 *  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_XFastSerializer_idl__
#define __com_sun_star_xml_sax_XFastSerializer_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_XFastDocumentHanlder_idl__
#include <com/sun/star/xml/sax/XFastDocumentHandler.idl>
#endif

#ifndef __com_sun_star_io_XOutputStream_idl__
#include <com/sun/star/io/XOutputStream.idl>
#endif

#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
#include <com/sun/star/xml/sax/XFastTokenHandler.idl>
#endif


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

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

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

/** receives notification of sax document events to write into an XOutputStream.
 */
interface XFastSerializer: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** called by the parser when parsing of an xml stream is started.
     */
    void startDocument()
            raises( com::sun::star::xml::sax::SAXException );

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

    /** called by the parser after the last xml element of a stream is processed.
     */
    void endDocument()
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the beginning of an element .

        @param Element
            contains the integer token from the <type>XFastTokenHandler</type>
            registered at the <type>XFastParser</type>.<br>

            If the element has a namespace that was registered with the
            <type>XFastParser</type>, <param>Element</param> contains the integer
            token of the elements local name from the <type>XFastTokenHandler</type>
            and the integer token of the namespace combined with an arithmetic
            <b>or</b> operation.

        @param Attribs
            Contains a <type>XFastAttrbitueList</type> to access the attributes
            from the element.

    */
    void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the beginning of an unknown element .

        @param Namespace
            contains the namespace url (not the prefix!) of this element.
        @param Name
            contains the elements local name.
        @param Attribs
            Contains a <type>XFastAttrbitueList</type> to access the attributes
            from the element.
     */
    void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the end of an known element.
        @see startFastElement
     */
    void endFastElement( [in] long Element )
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the end of an known element.
        @see startUnknownElement
     */
    void endUnknownElement( [in] string Namespace, [in] string Name )
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the beginning of a single element .

        @param Element
            contains the integer token from the <type>XFastTokenHandler</type>
            registered at the <type>XFastParser</type>.<br>

            If the element has a namespace that was registered with the
            <type>XFastParser</type>, <param>Element</param> contains the integer
            token of the elements local name from the <type>XFastTokenHandler</type>
            and the integer token of the namespace combined with an arithmetic
            <b>or</b> operation.

        @param Attribs
            Contains a <type>XFastAttrbitueList</type> to access the attributes
            from the element.

    */
    void singleFastElement( [in] long Element, [in] XFastAttributeList Attribs )
            raises( com::sun::star::xml::sax::SAXException );

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

    /** receives notification of the beginning of a single unknown element .

        @param Namespace
            contains the namespace url (not the prefix!) of this element.
        @param Name
            contains the elements local name.
        @param Attribs
            Contains a <type>XFastAttrbitueList</type> to access the attributes
            from the element.
     */
    void singleUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
            raises( com::sun::star::xml::sax::SAXException );

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

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

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

    /**
     */
    void setOutputStream ( [in] com::sun::star::io::XOutputStream xOutputStream )
            /* raises( com::sun::star::xml::sax::SAXException ) */;

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

    /**
     */
    void setFastTokenHandler ( [in] com::sun::star::xml::sax::XFastTokenHandler xFastTokenHandler )
            /* raises( com::sun::star::xml::sax::SAXException ) */;
  };

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

}; }; }; }; };

#endif