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
  20
  21
  22 module com {  module sun {  module star {  module xml {  module sax {
  23
  24
  25 /** receives notification of general document events.
  26
  27     <p>This interface is an IDL version of the Java interface
  28     <em>org.xml.sax.DocumentHandler</em> with some smaller
  29     adaptations.</p>
  30  */
  31 published interface XDocumentHandler: com::sun::star::uno::XInterface
  32 {
  33
  34     /** receives notification of the beginning of a document.
  35      */
  36     void startDocument()
  37             raises( com::sun::star::xml::sax::SAXException );
  38
  39
  40     /** receives notification of the end of a document.
  41      */
  42     void endDocument()
  43             raises( com::sun::star::xml::sax::SAXException );
  44
  45
  46     /** receives notification of the beginning of an element .
  47      */
  48     void startElement( [in] string aName,
  49              [in] com::sun::star::xml::sax::XAttributeList xAttribs )
  50             raises( com::sun::star::xml::sax::SAXException );
  51
  52
  53     /** receives notification of the end of an element.
  54      */
  55     void endElement( [in] string aName )
  56             raises( com::sun::star::xml::sax::SAXException );
  57
  58
  59     /** receives notification of character data.
  60      */
  61     void characters( [in] string aChars )
  62             raises( com::sun::star::xml::sax::SAXException );
  63
  64
  65     /** receives notification of white space that can be ignored.
  66      */
  67     void ignorableWhitespace( [in] string aWhitespaces )
  68             raises( com::sun::star::xml::sax::SAXException );
  69
  70
  71     /** receives notification of a processing instruction.
  72      */
  73     void processingInstruction( [in] string aTarget,
  74              [in] string aData )
  75             raises( com::sun::star::xml::sax::SAXException );
  76
  77
  78     /** receives an object for locating the origin of SAX document events.
  79      */
  80     void setDocumentLocator( [in] com::sun::star::xml::sax::XLocator xLocator )
  81             raises( com::sun::star::xml::sax::SAXException );
  82
  83 };
  84
  85
  86 }; }; }; }; };
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */