offapi/com/sun/star/xml/sax/XFastSerializer.idl

   1 /*************************************************************************
   2  *
   3  *  OpenOffice.org - a multi-platform office productivity suite
   4  *
   5  *  $RCSfile: XFastSerializer.idl,v $
   6  *
   7  *  $Revision: 1.7 $
   8  *
   9  *  last change: $Author: rt $ $Date: 2005/09/08 10:12:27 $
  10  *
  11  *  The Contents of this file are made available subject to
  12  *  the terms of GNU Lesser General Public License Version 2.1.
  13  *
  14  *
  15  *    GNU Lesser General Public License Version 2.1
  16  *    =============================================
  17  *    Copyright 2005 by Sun Microsystems, Inc.
  18  *    901 San Antonio Road, Palo Alto, CA 94303, USA
  19  *
  20  *    This library is free software; you can redistribute it and/or
  21  *    modify it under the terms of the GNU Lesser General Public
  22  *    License version 2.1, as published by the Free Software Foundation.
  23  *
  24  *    This library is distributed in the hope that it will be useful,
  25  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  27  *    Lesser General Public License for more details.
  28  *
  29  *    You should have received a copy of the GNU Lesser General Public
  30  *    License along with this library; if not, write to the Free Software
  31  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  32  *    MA  02111-1307  USA
  33  *
  34  ************************************************************************/
  35 #ifndef __com_sun_star_xml_sax_XFastSerializer_idl__
  36 #define __com_sun_star_xml_sax_XFastSerializer_idl__
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_xml_sax_SAXException_idl__
  43 #include <com/sun/star/xml/sax/SAXException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_xml_sax_XFastDocumentHanlder_idl__
  47 #include <com/sun/star/xml/sax/XFastDocumentHandler.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_io_XOutputStream_idl__
  51 #include <com/sun/star/io/XOutputStream.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
  55 #include <com/sun/star/xml/sax/XFastTokenHandler.idl>
  56 #endif
  57
  58
  59 //=============================================================================
  60
  61 module com {  module sun {  module star {  module xml {  module sax {
  62
  63 //=============================================================================
  64
  65 /** receives notification of sax document events to write into an XOutputStream.
  66  */
  67 interface XFastSerializer: com::sun::star::uno::XInterface
  68 {
  69     //-------------------------------------------------------------------------
  70
  71     /** called by the parser when parsing of an xml stream is started.
  72      */
  73     void startDocument()
  74             raises( com::sun::star::xml::sax::SAXException );
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** called by the parser after the last xml element of a stream is processed.
  79      */
  80     void endDocument()
  81             raises( com::sun::star::xml::sax::SAXException );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** receives notification of the beginning of an element .
  86
  87         @param Element
  88             contains the integer token from the <type>XFastTokenHandler</type>
  89             registered at the <type>XFastParser</type>.<br>
  90
  91             If the element has a namespace that was registered with the
  92             <type>XFastParser</type>, <param>Element</param> contains the integer
  93             token of the elements local name from the <type>XFastTokenHandler</type>
  94             and the integer token of the namespace combined with an arithmetic
  95             <b>or</b> operation.
  96
  97         @param Attribs
  98             Contains a <type>XFastAttrbitueList</type> to access the attributes
  99             from the element.
 100
 101     */
 102     void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
 103             raises( com::sun::star::xml::sax::SAXException );
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** receives notification of the beginning of an unknown element .
 108
 109         @param Namespace
 110             contains the namespace url (not the prefix!) of this element.
 111         @param Name
 112             contains the elements local name.
 113         @param Attribs
 114             Contains a <type>XFastAttrbitueList</type> to access the attributes
 115             from the element.
 116      */
 117     void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
 118             raises( com::sun::star::xml::sax::SAXException );
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** receives notification of the end of an known element.
 123         @see startFastElement
 124      */
 125     void endFastElement( [in] long Element )
 126             raises( com::sun::star::xml::sax::SAXException );
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** receives notification of the end of an known element.
 131         @see startUnknownElement
 132      */
 133     void endUnknownElement( [in] string Namespace, [in] string Name )
 134             raises( com::sun::star::xml::sax::SAXException );
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** receives notification of the beginning of a single element .
 139
 140         @param Element
 141             contains the integer token from the <type>XFastTokenHandler</type>
 142             registered at the <type>XFastParser</type>.<br>
 143
 144             If the element has a namespace that was registered with the
 145             <type>XFastParser</type>, <param>Element</param> contains the integer
 146             token of the elements local name from the <type>XFastTokenHandler</type>
 147             and the integer token of the namespace combined with an arithmetic
 148             <b>or</b> operation.
 149
 150         @param Attribs
 151             Contains a <type>XFastAttrbitueList</type> to access the attributes
 152             from the element.
 153
 154     */
 155     void singleFastElement( [in] long Element, [in] XFastAttributeList Attribs )
 156             raises( com::sun::star::xml::sax::SAXException );
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** receives notification of the beginning of a single unknown element .
 161
 162         @param Namespace
 163             contains the namespace url (not the prefix!) of this element.
 164         @param Name
 165             contains the elements local name.
 166         @param Attribs
 167             Contains a <type>XFastAttrbitueList</type> to access the attributes
 168             from the element.
 169      */
 170     void singleUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
 171             raises( com::sun::star::xml::sax::SAXException );
 172
 173     //-------------------------------------------------------------------------
 174
 175     /** receives notification of character data.
 176      */
 177     void characters( [in] string aChars )
 178             raises( com::sun::star::xml::sax::SAXException );
 179
 180     //-------------------------------------------------------------------------
 181
 182     /**
 183      */
 184     void setOutputStream ( [in] com::sun::star::io::XOutputStream xOutputStream )
 185             /* raises( com::sun::star::xml::sax::SAXException ) */;
 186
 187     //-------------------------------------------------------------------------
 188
 189     /**
 190      */
 191     void setFastTokenHandler ( [in] com::sun::star::xml::sax::XFastTokenHandler xFastTokenHandler )
 192             /* raises( com::sun::star::xml::sax::SAXException ) */;
 193   };
 194
 195 //=============================================================================
 196
 197 }; }; }; }; };
 198
 199 #endif