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