xref: /trunk/main/offapi/com/sun/star/xml/sax/XExtendedDocumentHandler.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
28#define __com_sun_star_xml_sax_XExtendedDocumentHandler_idl__
29
30#ifndef __com_sun_star_xml_sax_XDocumentHandler_idl__
31#include <com/sun/star/xml/sax/XDocumentHandler.idl>
32#endif
33
34#ifndef __com_sun_star_xml_sax_SAXException_idl__
35#include <com/sun/star/xml/sax/SAXException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module xml {  module sax {
42
43//=============================================================================
44
45/** this interface does not conform to the SAX-standard.
46
47    <p>Note: Whether or not every callback is supported is dependent
48    on the parser implementation.
49 */
50published interface XExtendedDocumentHandler: com::sun::star::xml::sax::XDocumentHandler
51{
52    //-------------------------------------------------------------------------
53    /** receives notification about the start of a CDATA section in the
54        XML-source.
55
56        <p>Any string comming in via character handler may include chars,
57        that would otherwise be interpreted as markup. </p>
58     */
59    void startCDATA()
60            raises( com::sun::star::xml::sax::SAXException );
61
62    //-------------------------------------------------------------------------
63    /** informs about the end of a CDATA-Section.
64
65        <p>Note that <code>startCDATA/endCDATA</code> MUST NOT enclose any
66        <code>startElement/endElement</code>-call!</p>
67     */
68    void endCDATA();
69
70    //-------------------------------------------------------------------------
71    /** receives notification about a comment in the XML-source.
72     */
73    void comment( [in] string sComment )
74            raises( com::sun::star::xml::sax::SAXException );
75
76    //-------------------------------------------------------------------------
77    /** informs a writer that it is allowable to insert a line break and
78        indentation before the next <type>XDocumentHandler</type>-call.
79     */
80    void allowLineBreak()
81            raises( com::sun::star::xml::sax::SAXException );
82
83    //-------------------------------------------------------------------------
84    /** notifies that any characters that cannot be handled by other callback
85        methods are announced through this method.
86     */
87    void unknown( [in] string sString )
88            raises( com::sun::star::xml::sax::SAXException );
89};
90
91//=============================================================================
92
93}; }; }; }; };
94
95#endif
96