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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
  20 #define __com_sun_star_xml_sax_XDocumentHandler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/xml/sax/SAXException.idl>
  25
  26 #include <com/sun/star/xml/sax/XAttributeList.idl>
  27
  28 #include <com/sun/star/xml/sax/XLocator.idl>
  29
  30
  31
  32 module com {  module sun {  module star {  module xml {  module sax {
  33
  34
  35 /** receives notification of general document events.
  36
  37     <p>This interface is an IDL version of the Java interface
  38     <em>org.xml.sax.DocumentHandler</em> with some smaller
  39     adaptations.</p>
  40  */
  41 published interface XDocumentHandler: com::sun::star::uno::XInterface
  42 {
  43
  44     /** receives notification of the beginning of a document.
  45      */
  46     void startDocument()
  47             raises( com::sun::star::xml::sax::SAXException );
  48
  49
  50     /** receives notification of the end of a document.
  51      */
  52     void endDocument()
  53             raises( com::sun::star::xml::sax::SAXException );
  54
  55
  56     /** receives notification of the beginning of an element .
  57      */
  58     void startElement( [in] string aName,
  59              [in] com::sun::star::xml::sax::XAttributeList xAttribs )
  60             raises( com::sun::star::xml::sax::SAXException );
  61
  62
  63     /** receives notification of the end of an element.
  64      */
  65     void endElement( [in] string aName )
  66             raises( com::sun::star::xml::sax::SAXException );
  67
  68
  69     /** receives notification of character data.
  70      */
  71     void characters( [in] string aChars )
  72             raises( com::sun::star::xml::sax::SAXException );
  73
  74
  75     /** receives notification of white space that can be ignored.
  76      */
  77     void ignorableWhitespace( [in] string aWhitespaces )
  78             raises( com::sun::star::xml::sax::SAXException );
  79
  80
  81     /** receives notification of a processing instruction.
  82      */
  83     void processingInstruction( [in] string aTarget,
  84              [in] string aData )
  85             raises( com::sun::star::xml::sax::SAXException );
  86
  87
  88     /** receives an object for locating the origin of SAX document events.
  89      */
  90     void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
  91             raises( com::sun::star::xml::sax::SAXException );
  92
  93 };
  94
  95
  96 }; }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */