offapi/com/sun/star/document/StandaloneDocumentInfo.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: StandaloneDocumentInfo.idl,v $
  10  * $Revision: 1.11 $
  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_StandaloneDocumentInfo_idl__
  31 #define __com_sun_star_document_StandaloneDocumentInfo_idl__
  32
  33 #ifndef __com_sun_star_document_DocumentInfo_idl__
  34 #include <com/sun/star/document/DocumentInfo.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_document_XStandaloneDocumentInfo_idl__
  38 #include <com/sun/star/document/XStandaloneDocumentInfo.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43   module com {   module sun {   module star {   module document {
  44
  45 //=============================================================================
  46 /** extends the service <type>DocumentInfo</type> to have access on such
  47     document properties without loading the whole document
  48
  49     <p>
  50     First action on this service must be to specify which document should be handled.
  51     Otherwise all supported properties of <type>DocumentInfo</type> will be set to
  52     void values. Loading of a document doesn't mean - loading all. It means reading
  53     of special part only, which includes searched information. Same procedure for saving
  54     of may changed values back to the document.
  55     </p>
  56
  57     @deprecated     Use <type>DocumentProperties</type> instead.
  58
  59     @see DocumentInfo
  60  */
  61 published service StandaloneDocumentInfo
  62 {
  63     //-------------------------------------------------------------------------
  64     /** use it to specify ressource or target of document info data
  65
  66         <p>
  67         Must be the first action on this service. Otherwise all properties will be void.
  68         </p>
  69      */
  70     interface XStandaloneDocumentInfo;
  71
  72     //-------------------------------------------------------------------------
  73     /** access to document info data
  74      */
  75     service DocumentInfo;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 #endif