xref: /trunk/main/offapi/com/sun/star/xml/sax/XErrorHandler.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_XErrorHandler_idl__
28#define __com_sun_star_xml_sax_XErrorHandler_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.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/** is the basic interface for SAX error handlers.
46
47    <p>If a SAX application needs to implement customized error handling,
48    it must implement this interface and then register an instance with the
49    SAX parser using the parser's <method>XParser::setErrorhandler</method>
50    method. The parser will then report all errors and warnings through this
51    interface.  </p>
52
53    <p>This interface is a slight adaption of the Java interface
54    <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed
55    as an argument, so an <code>any</code> serves as the container. The type of the
56    exception is <type>SAXParseException</type> or an instance of a derived class.</p>
57 */
58published interface XErrorHandler: com::sun::star::uno::XInterface
59{
60    //-------------------------------------------------------------------------
61    /** receives notification of a recoverable error.
62     */
63    void error( [in] any aSAXParseException )
64            raises( com::sun::star::xml::sax::SAXException );
65
66    //-------------------------------------------------------------------------
67    /** receives notification of a non-recoverable error.
68     */
69    void fatalError( [in] any aSAXParseException )
70            raises( com::sun::star::xml::sax::SAXException );
71
72    //-------------------------------------------------------------------------
73    /** receives notification of a warning.
74     */
75    void warning( [in] any aSAXParseException )
76            raises( com::sun::star::xml::sax::SAXException );
77
78};
79
80//=============================================================================
81
82}; }; }; }; };
83
84#endif
85