offapi/com/sun/star/xml/sax/XErrorHandler.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
  20 #define __com_sun_star_xml_sax_XErrorHandler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/xml/sax/SAXException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module xml {  module sax {
  29
  30
  31 /** is the basic interface for SAX error handlers.
  32
  33     <p>If a SAX application needs to implement customized error handling,
  34     it must implement this interface and then register an instance with the
  35     SAX parser using the parser's XParser::setErrorhandler()
  36     method. The parser will then report all errors and warnings through this
  37     interface.  </p>
  38
  39     <p>This interface is a slight adaption of the Java interface
  40     <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed
  41     as an argument, so an <code>any</code> serves as the container. The type of the
  42     exception is SAXParseException or an instance of a derived class.</p>
  43  */
  44 published interface XErrorHandler: com::sun::star::uno::XInterface
  45 {
  46     /** receives notification of a recoverable error.
  47      */
  48     void error( [in] any aSAXParseException )
  49             raises( com::sun::star::xml::sax::SAXException );
  50
  51     /** receives notification of a non-recoverable error.
  52      */
  53     void fatalError( [in] any aSAXParseException )
  54             raises( com::sun::star::xml::sax::SAXException );
  55
  56     /** receives notification of a warning.
  57      */
  58     void warning( [in] any aSAXParseException )
  59             raises( com::sun::star::xml::sax::SAXException );
  60
  61 };
  62
  63
  64 }; }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */