/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDocumentInfoSupplier.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 23:09:54 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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>

    @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
