offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.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_XExtendedDocumentHandler_idl__
  20 #define __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
  21
  22 #include <com/sun/star/xml/sax/XDocumentHandler.idl>
  23
  24 #include <com/sun/star/xml/sax/SAXException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module xml {  module sax {
  29
  30
  31 /** this interface does not conform to the SAX-standard.
  32
  33     <p>Note: Whether or not every callback is supported is dependent
  34     on the parser implementation.
  35  */
  36 published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler
  37 {
  38     /** receives notification about the start of a CDATA section in the
  39         XML-source.
  40
  41         <p>Any string coming in via character handler may include chars,
  42         that would otherwise be interpreted as markup. </p>
  43      */
  44     void startCDATA()
  45             raises( com::sun::star::xml::sax::SAXException );
  46
  47     /** informs about the end of a CDATA-Section.
  48
  49         <p>Note that <code>startCDATA/endCDATA</code> MUST NOT enclose any
  50         <code>startElement/endElement</code>-call!</p>
  51      */
  52     void endCDATA()
  53             raises( com::sun::star::xml::sax::SAXException );
  54
  55     /** receives notification about a comment in the XML-source.
  56      */
  57     void comment( [in] string sComment )
  58             raises( com::sun::star::xml::sax::SAXException );
  59
  60     /** informs a writer that it is allowable to insert a line break and
  61         indentation before the next XDocumentHandler-call.
  62      */
  63     void allowLineBreak()
  64             raises( com::sun::star::xml::sax::SAXException );
  65
  66     /** notifies that any characters that cannot be handled by other callback
  67         methods are announced through this method.
  68      */
  69     void unknown( [in] string sString )
  70             raises( com::sun::star::xml::sax::SAXException );
  71 };
  72
  73
  74 }; }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */