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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDocumentHandler.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
  31 #define __com_sun_star_xml_sax_XDocumentHandler_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_xml_sax_SAXException_idl__
  38 #include <com/sun/star/xml/sax/SAXException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_xml_sax_XAttributeList_idl__
  42 #include <com/sun/star/xml/sax/XAttributeList.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_xml_sax_XLocator_idl__
  46 #include <com/sun/star/xml/sax/XLocator.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module xml {  module sax {
  53
  54 //=============================================================================
  55
  56 /** receives notification of general document events.
  57
  58     <p>This interface is an IDL version of the Java interface
  59     <em>org.xml.sax.DocumentHandler</em> with some smaller
  60     adaptations.</p>
  61  */
  62 published interface XDocumentHandler: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** receives notification of the beginning of a document.
  67      */
  68     void startDocument()
  69             raises( com::sun::star::xml::sax::SAXException );
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** receives notification of the end of a document.
  74      */
  75     void endDocument()
  76             raises( com::sun::star::xml::sax::SAXException );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** receives notification of the beginning of an element .
  81      */
  82     void startElement( [in] string aName,
  83              [in] com::sun::star::xml::sax::XAttributeList xAttribs )
  84             raises( com::sun::star::xml::sax::SAXException );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** receives notification of the end of an element.
  89      */
  90     void endElement( [in] string aName )
  91             raises( com::sun::star::xml::sax::SAXException );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** receives notification of character data.
  96      */
  97     void characters( [in] string aChars )
  98             raises( com::sun::star::xml::sax::SAXException );
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** receives notification of white space that can be ignored.
 103      */
 104     void ignorableWhitespace( [in] string aWhitespaces )
 105             raises( com::sun::star::xml::sax::SAXException );
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** receives notification of a processing instruction.
 110      */
 111     void processingInstruction( [in] string aTarget,
 112              [in] string aData )
 113             raises( com::sun::star::xml::sax::SAXException );
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** receives an object for locating the origin of SAX document events.
 118      */
 119     void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
 120             raises( com::sun::star::xml::sax::SAXException );
 121
 122 };
 123
 124 //=============================================================================
 125
 126 }; }; }; }; };
 127
 128 #endif