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