offapi/com/sun/star/xml/sax/XEntityResolver.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_XEntityResolver_idl__
  20 #define __com_sun_star_xml_sax_XEntityResolver_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/xml/sax/InputSource.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module xml {  module sax {
  29
  30
  31 /** makes it possible to modify the behavior of resolving external
  32     preferences.
  33
  34     <p>Usually, the parser has a default behavior of resolving external
  35     references (See documentation of the parser implementation).
  36     Use this interface to modify or reimplement this behavior.</p>
  37  */
  38 published interface XEntityResolver: com::sun::star::uno::XInterface
  39 {
  40
  41     /** @returns
  42                     InputSource for the external entity.
  43
  44         <p>If <var>aInputStream</var> is a valid reference to an input stream,
  45         the parser uses this InputSource. Otherwise the
  46         parser seeks for the entity using its default behavior.
  47      */
  48     InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId );
  49
  50 };
  51
  52
  53 }; }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */