offapi/com/sun/star/document/XDocumentInfoSupplier.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: XDocumentInfoSupplier.idl,v $
  10  * $Revision: 1.10 $
  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_document_XDocumentInfoSupplier_idl__
  31 #define __com_sun_star_document_XDocumentInfoSupplier_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_document_XDocumentInfo_idl__
  38 #include <com/sun/star/document/XDocumentInfo.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {   module sun {   module star {   module document {
  44
  45 //=============================================================================
  46 /** through this interface documents can provide a <type>DocumentInfo</type>
  47
  48     <p>
  49     A <type>DocumentInfo</type> is available on already opened documents only
  50     and must be provides by this supplier interface.
  51     Instead of that you can use the service <type>StandaloneDocumentInfo</type>
  52     to have access to such informations without opening the whole file.
  53     It read/write parts of the document, which include the required informations,
  54     only.
  55     </p>
  56
  57     @deprecated     Use <type>XDocumentPropertiesSupplier</type> instead.
  58
  59     @see DocumentInfo
  60     @see StandaloneDocumentInfo
  61  */
  62 published interface XDocumentInfoSupplier: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65     /** provides the document information object
  66
  67         @returns
  68             an object of type <type>DocumentInfo</type>
  69      */
  70     XDocumentInfo getDocumentInfo();
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif