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