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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XErrorHandler.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
  31 #define __com_sun_star_xml_sax_XErrorHandler_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_xml_sax_SAXException_idl__
  38 #include <com/sun/star/xml/sax/SAXException.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module xml {  module sax {
  45
  46 //=============================================================================
  47
  48 /** is the basic interface for SAX error handlers.
  49
  50     <p>If a SAX application needs to implement customized error handling,
  51     it must implement this interface and then register an instance with the
  52     SAX parser using the parser's <method>XParser::setErrorhandler</method>
  53     method. The parser will then report all errors and warnings through this
  54     interface.  </p>
  55
  56     <p>This interface is a slight adaption of the Java interface
  57     <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed
  58     as an argument, so an <code>any</code> serves as the container. The type of the
  59     exception is <type>SAXParseException</type> or an instance of a derived class.</p>
  60  */
  61 published interface XErrorHandler: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64     /** receives notification of a recoverable error.
  65      */
  66     void error( [in] any aSAXParseException )
  67             raises( com::sun::star::xml::sax::SAXException );
  68
  69     //-------------------------------------------------------------------------
  70     /** receives notification of a non-recoverable error.
  71      */
  72     void fatalError( [in] any aSAXParseException )
  73             raises( com::sun::star::xml::sax::SAXException );
  74
  75     //-------------------------------------------------------------------------
  76     /** receives notification of a warning.
  77      */
  78     void warning( [in] any aSAXParseException )
  79             raises( com::sun::star::xml::sax::SAXException );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; }; };
  86
  87 #endif