offapi/com/sun/star/document/XDocumentPropertiesSupplier.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: XDocumentPropertiesSupplier.idl,v $
  10  * $Revision: 1.3 $
  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_XDocumentPropertiesSupplier_idl__
  31 #define __com_sun_star_document_XDocumentPropertiesSupplier_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_XDocumentProperties_idl__
  38 #include <com/sun/star/document/XDocumentProperties.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {   module sun {   module star {   module document {
  44
  45 //=============================================================================
  46 /** provides access to the <type>XDocumentProperties</type> instance of a
  47     document.
  48     <p>
  49     A <type>DocumentProperties</type> instance is available on loaded documents
  50     via this supplier interface.
  51     </p>
  52
  53     @since OOo 3.0
  54
  55     @see XDocumentProperties
  56     @see DocumentProperties
  57  */
  58 interface XDocumentPropertiesSupplier
  59 {
  60     //-------------------------------------------------------------------------
  61     /** provides the document properties object.
  62
  63         @returns
  64             an object of type <type>XDocumentProperties</type>
  65      */
  66     XDocumentProperties getDocumentProperties();
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif