offapi/com/sun/star/document/DocumentInfo.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: DocumentInfo.idl,v $
  10  * $Revision: 1.14 $
  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_DocumentInfo_idl__
  31 #define __com_sun_star_document_DocumentInfo_idl__
  32
  33 #ifndef __com_sun_star_document_XDocumentInfo_idl__
  34 #include <com/sun/star/document/XDocumentInfo.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_XComponent_idl__
  38 #include <com/sun/star/lang/XComponent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  46 #include <com/sun/star/beans/XFastPropertySet.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  50 #include <com/sun/star/beans/XPropertyContainer.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_NamedValue_idl__
  54 #include <com/sun/star/beans/NamedValue.idl>
  55 #endif
  56 #ifndef __com_sun_star_util_DateTime_idl__
  57 #include <com/sun/star/util/DateTime.idl>
  58 #endif
  59
  60 #ifndef __com_sun_star_lang_Locale_idl__
  61 #include <com/sun/star/lang/Locale.idl>
  62 #endif
  63
  64 //=============================================================================
  65
  66   module com {   module sun {   module star {   module document {
  67
  68 //=============================================================================
  69 /** this service provides document-specific information like the
  70     author, creation date and user fields
  71
  72     <p>
  73     Contrary to the service <type>StandaloneDocumentInfo</type> the document - which
  74     contains such informations - must be loaded completly. As a result of that this
  75     DocumengInfo service is available on an open document via the interface
  76     <type>XDocumentInfoSupplier</type> only.
  77     </p>
  78
  79     @deprecated     Use <type>DocumentProperties</type> instead.
  80
  81     @see StandaloneDocumentInfo
  82     @see XDocumentInfoSupplier
  83  */
  84 published service DocumentInfo
  85 {
  86     //-------------------------------------------------------------------------
  87     /** provides access to the user fields for the information regarding the
  88         document
  89
  90         <p>
  91         These fields are additional to normal properties.
  92         (see below)
  93         </p>
  94      */
  95     interface XDocumentInfo;
  96
  97     //-------------------------------------------------------------------------
  98     /** neccessary to support normal properties
  99      */
 100     interface com::sun::star::beans::XPropertySet;
 101
 102     //-------------------------------------------------------------------------
 103     /** supports faster access on well known properties by using index
 104      */
 105     interface com::sun::star::beans::XFastPropertySet;
 106
 107     //-------------------------------------------------------------------------
 108     /** provides access to the user fields, which (instead to the user fields set
 109         by the interface XDocumentInfo) will be typesafe.
 110
 111         <p>
 112         These fields are additional to normal properties (see below) and
 113         additional to the user fields set by the interface XDocumentInfo (see before).
 114         </p>
 115      */
 116     [optional] interface com::sun::star::beans::XPropertyContainer;
 117
 118     //-------------------------------------------------------------------------
 119     /** contains the intial author of the document
 120      */
 121     [property] string Author;
 122
 123     //-------------------------------------------------------------------------
 124     /** @deprecated
 125      */
 126     [property] boolean AutoloadEnabled;
 127
 128     //-------------------------------------------------------------------------
 129     /** contains the number of seconds after which a specified
 130         URL is to be loaded after the document is loaded into a desktop
 131         frame
 132      */
 133     [property] long AutoloadSecs;
 134
 135     //-------------------------------------------------------------------------
 136     /** contains the URL to load automatically after a
 137         specified time after the document is loaded into a desktop frame
 138      */
 139     [property] string AutoloadURL;
 140
 141     //-------------------------------------------------------------------------
 142     /** contains the date and time of the first time the
 143         document was stored
 144      */
 145     [property] com::sun::star::util::DateTime CreationDate;
 146
 147     //-------------------------------------------------------------------------
 148     /** contains the name of the default frame into which
 149         links should be loaded if no target is specified
 150
 151         <p>
 152         This applies to the autoload feature too, but to others as well.
 153         </p>
 154      */
 155     [property] string DefaultTarget;
 156
 157     //-------------------------------------------------------------------------
 158     /** contains a multi-line comment of the document
 159
 160         <p>
 161         Line delimiters can be UNIX, Macintosh or DOS style.
 162         </p>
 163      */
 164     [property] string Description;
 165
 166     //-------------------------------------------------------------------------
 167     /** contains some statistics about the document
 168
 169         <p>
 170         The exact name and type of the values depends on the document type
 171         </p>
 172      */
 173     [property] sequence< com::sun::star::beans::NamedValue > DocumentStatistic;
 174
 175     //-------------------------------------------------------------------------
 176     /** describes how often the document was edited and saved
 177      */
 178     [property] short EditingCycles;
 179
 180     //-------------------------------------------------------------------------
 181     /** contains the net time of editing the document (in seconds)
 182      */
 183     [property] long EditingDuration;
 184
 185     //-------------------------------------------------------------------------
 186     /** identifies application was used to create or last modify the document
 187      */
 188     [property] string Generator;
 189
 190     //-------------------------------------------------------------------------
 191     /** contains a comma separated list of keywords for
 192         the document
 193      */
 194     [property] string Keywords;
 195
 196     //-------------------------------------------------------------------------
 197     /** contains the MIME-type of the document's resource
 198
 199         <p>
 200         The MIME-type is neither stored in the document information nor in
 201         the document; it is sent within a protocol header or is
 202         detected, thus it cannot be changed.
 203         </p>
 204      */
 205     [readonly, property] string MIMEType;
 206
 207     //-------------------------------------------------------------------------
 208     /** default language of the document
 209      */
 210     [property] com::sun::star::lang::Locale Language;
 211
 212     //-------------------------------------------------------------------------
 213     /** contains the name of the editor who was the last
 214         person to store this document
 215      */
 216     [property] string ModifiedBy;
 217
 218     //-------------------------------------------------------------------------
 219     /** contains the date and time of the last time the
 220         document was stored
 221      */
 222     [property] com::sun::star::util::DateTime ModifyDate;
 223
 224     //-------------------------------------------------------------------------
 225     /** contains the date and time of when the document was
 226         last printed
 227      */
 228     [property] com::sun::star::util::DateTime PrintDate;
 229
 230     //-------------------------------------------------------------------------
 231     /** contains the name of the editor who was the last
 232         person to print the document
 233      */
 234     [property] string PrintedBy;
 235
 236     //-------------------------------------------------------------------------
 237     /** subject of document
 238      */
 239     [property] string Subject;
 240
 241     //-------------------------------------------------------------------------
 242     /** contains logical name of the template from
 243         which the document was created
 244
 245         <p>
 246         The value is an empty string if the document was not created
 247         from a template or if it was detached from the template.
 248         </p>
 249      */
 250     [property] string Template;
 251
 252     //-------------------------------------------------------------------------
 253     /** contains the file path name of the template from
 254         which the document was created
 255      */
 256     [property] string TemplateFileName;
 257
 258     //-------------------------------------------------------------------------
 259     /** contains the date and time of when the document
 260         was created or updated from the template
 261      */
 262     [property] com::sun::star::util::DateTime TemplateDate;
 263
 264     //-------------------------------------------------------------------------
 265     /** contains the title of the document
 266      */
 267     [property] string Title;
 268
 269 };
 270
 271 //=============================================================================
 272
 273 }; }; }; };
 274
 275 #endif