xref: /AOO41X/main/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
24#define __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
25
26#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
27#include <com/sun/star/xml/sax/XDocumentHandler.idl>
28#endif
29
30#ifndef __com_sun_star_xml_sax_SAXException_idl__
31#include <com/sun/star/xml/sax/SAXException.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module xml {  module sax {
38
39//=============================================================================
40
41/** this interface does not conform to the SAX-standard.
42
43    <p>Note: Whether or not every callback is supported is dependent
44    on the parser implementation.
45 */
46published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler
47{
48    //-------------------------------------------------------------------------
49    /** receives notification about the start of a CDATA section in the
50        XML-source.
51
52        <p>Any string comming in via character handler may include chars,
53        that would otherwise be interpreted as markup. </p>
54     */
55    void startCDATA()
56            raises( com::sun::star::xml::sax::SAXException );
57
58    //-------------------------------------------------------------------------
59    /** informs about the end of a CDATA-Section.
60
61        <p>Note that <code>startCDATA/endCDATA</code> MUST NOT enclose any
62        <code>startElement/endElement</code>-call!</p>
63     */
64    void endCDATA();
65
66    //-------------------------------------------------------------------------
67    /** receives notification about a comment in the XML-source.
68     */
69    void comment( [in] string sComment )
70            raises( com::sun::star::xml::sax::SAXException );
71
72    //-------------------------------------------------------------------------
73    /** informs a writer that it is allowable to insert a line break and
74        indentation before the next <type>XDocumentHandler</type>-call.
75     */
76    void allowLineBreak()
77            raises( com::sun::star::xml::sax::SAXException );
78
79    //-------------------------------------------------------------------------
80    /** notifies that any characters that cannot be handled by other callback
81        methods are announced through this method.
82     */
83    void unknown( [in] string sString )
84            raises( com::sun::star::xml::sax::SAXException );
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92