offapi/com/sun/star/xml/sax/XEntityResolver.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: XEntityResolver.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_XEntityResolver_idl__
  31 #define __com_sun_star_xml_sax_XEntityResolver_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_InputSource_idl__
  38 #include <com/sun/star/xml/sax/InputSource.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module xml {  module sax {
  45
  46 //=============================================================================
  47
  48 /** makes it possible to modify the behaviour of resolving external
  49     preferences.
  50
  51     <p>Usually, the parser has a default behaviour of resolving external
  52     references (See documentation of the parser implementation).
  53     Use this interface to modify or reimplement this behaviour.</p>
  54  */
  55 published interface XEntityResolver: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** @returns
  60                     <type>InputSource</type> for the external entity.
  61
  62         <p>If <var>aInputStream</var> is a valid reference to an input stream,
  63         the parser uses this <type>InputSource</type>. Otherwise the
  64         parser seeks for the entity using its default behaviour.
  65      */
  66     InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId );
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; }; };
  73
  74 #endif