/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDocumentInfoSupplier.idl,v $
 * $Revision: 1.10 $
 *
 * 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_document_XDocumentInfoSupplier_idl__
#define __com_sun_star_document_XDocumentInfoSupplier_idl__

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

#ifndef __com_sun_star_document_XDocumentInfo_idl__
#include <com/sun/star/document/XDocumentInfo.idl>
#endif

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

module com {   module sun {   module star {   module document {

//=============================================================================
/** through this interface documents can provide a <type>DocumentInfo</type>

    <p>
    A <type>DocumentInfo</type> is available on already opened documents only
    and must be provides by this supplier interface.
    Instead of that you can use the service <type>StandaloneDocumentInfo</type>
    to have access to such informations without opening the whole file.
    It read/write parts of the document, which include the required informations,
    only.
    </p>

    @deprecated     Use <type>XDocumentPropertiesSupplier</type> instead.

    @see DocumentInfo
    @see StandaloneDocumentInfo
 */
published interface XDocumentInfoSupplier: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** provides the document information object

        @returns
            an object of type <type>DocumentInfo</type>
     */
    XDocumentInfo getDocumentInfo();
};

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

}; }; }; };

#endif