/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XEntityResolver_idl__
#define __com_sun_star_xml_sax_XEntityResolver_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/xml/sax/InputSource.idl>


//=============================================================================

module com {  module sun {  module star {  module xml {  module sax {

//=============================================================================

/** makes it possible to modify the behavior of resolving external
    preferences.

    <p>Usually, the parser has a default behavior of resolving external
    references (See documentation of the parser implementation).
    Use this interface to modify or reimplement this behavior.</p>
 */
published interface XEntityResolver: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                    <type>InputSource</type> for the external entity.

        <p>If <var>aInputStream</var> is a valid reference to an input stream,
        the parser uses this <type>InputSource</type>. Otherwise the
        parser seeks for the entity using its default behavior.
     */
    InputSource resolveEntity( [in] string sPublicId, [in] string sSystemId );

};

//=============================================================================

}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
