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
  20
  21
  22 module com {  module sun {  module star {  module xml {  module sax {
  23
  24
  25 /** is the basic interface for SAX error handlers.
  26
  27     <p>If a SAX application needs to implement customized error handling,
  28     it must implement this interface and then register an instance with the
  29     SAX parser using the parser's XParser::setErrorhandler()
  30     method. The parser will then report all errors and warnings through this
  31     interface.  </p>
  32
  33     <p>This interface is a slight adaptation of the Java interface
  34     <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed
  35     as an argument, so an <code>any</code> serves as the container. The type of the
  36     exception is SAXParseException or an instance of a derived class.</p>
  37  */
  38 published interface XErrorHandler: com::sun::star::uno::XInterface
  39 {
  40     /** receives notification of a recoverable error.
  41      */
  42     void error( [in] any aSAXParseException )
  43             raises( com::sun::star::xml::sax::SAXException );
  44
  45     /** receives notification of a non-recoverable error.
  46      */
  47     void fatalError( [in] any aSAXParseException )
  48             raises( com::sun::star::xml::sax::SAXException );
  49
  50     /** receives notification of a warning.
  51      */
  52     void warning( [in] any aSAXParseException )
  53             raises( com::sun::star::xml::sax::SAXException );
  54
  55 };
  56
  57
  58 }; }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */