LibreOffice
LibreOffice 6.2 SDK API Reference
XDocumentProperties.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_document_XDocumentProperties_idl__
20 #define __com_sun_star_document_XDocumentProperties_idl__
21 
31 
32 
33 
34 module com { module sun { module star { module document {
35 
55 published interface XDocumentProperties
56 {
60  [attribute] string Author;
61 
72  [attribute] string Generator;
73 
78 
82  [attribute] string Title;
83 
87  [attribute] string Subject;
88 
95  [attribute] string Description;
96 
100  [attribute] sequence< string > Keywords;
101 
106 
110  [attribute] string ModifiedBy;
111 
119 
123  [attribute] string PrintedBy;
124 
132 
140  [attribute] string TemplateName;
141 
149  [attribute] string TemplateURL;
150 
156 
171  [attribute] string AutoloadURL;
172 
189  [attribute] long AutoloadSecs {
191  };
192 
200  [attribute] string DefaultTarget;
201 
208  [attribute]
209  sequence< com::sun::star::beans::NamedValue > DocumentStatistics;
210 
219  [attribute] short EditingCycles {
221  };
222 
231  [attribute] long EditingDuration {
233  };
234 
257  void resetUserData( [in] string Author );
258 
267  com::sun::star::beans::XPropertyContainer getUserDefinedProperties();
268 
297  void loadFromStorage( [in] com::sun::star::embed::XStorage Storage,
298  [in] sequence < com::sun::star::beans::PropertyValue > Medium )
303 
326  void loadFromMedium( [in] string URL,
327  [in] sequence < com::sun::star::beans::PropertyValue > Medium )
331 
361  void storeToStorage( [in] com::sun::star::embed::XStorage Storage,
362  [in] sequence < com::sun::star::beans::PropertyValue > Medium )
366 
387  void storeToMedium( [in] string URL,
388  [in] sequence < com::sun::star::beans::PropertyValue > Medium )
391 };
392 
393 
394 }; }; }; };
395 
396 #endif
397 
398 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
string ModifiedBy
contains the name of the person who most recently stored the document.
Definition: XDocumentProperties.idl:110
com::sun::star::util::DateTime CreationDate
contains the date and time when the document was created.
Definition: XDocumentProperties.idl:77
is thrown when an input or output error has occurred.
Definition: IOException.idl:30
com::sun::star::lang::Locale Language
contains the default language of the document.
Definition: XDocumentProperties.idl:105
This interface represents main storage functionality.
Definition: XStorage.idl:43
string Title
contains the title of the document.
Definition: XDocumentProperties.idl:82
com::sun::star::util::DateTime PrintDate
contains the date and time when the document was last printed.
Definition: XDocumentProperties.idl:131
represents a combined date+time value.
Definition: DateTime.idl:28
string DefaultTarget
contains the name of the default frame into which links should be loaded if no target is specified...
Definition: XDocumentProperties.idl:200
is thrown when inconsistent data comes up while reading a complex data type (string or object)...
Definition: WrongFormatException.idl:31
Definition: Ambiguous.idl:22
provides document-specific information such as the author, creation date, and user-defined fields...
Definition: XDocumentProperties.idl:55
string Description
contains a multi-line comment describing the document.
Definition: XDocumentProperties.idl:95
string Subject
contains the subject of the document.
Definition: XDocumentProperties.idl:87
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:47
string AutoloadURL
contains the URL to load automatically at a specified time after the document is loaded into a deskto...
Definition: XDocumentProperties.idl:171
makes it possible to add and remove properties to or from an object.
Definition: XPropertyContainer.idl:46
com::sun::star::util::DateTime TemplateDate
contains the date and time of when the document was created or updated from the template.
Definition: XDocumentProperties.idl:155
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument...
Definition: IllegalArgumentException.idl:29
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:37
string TemplateName
contains the name of the template from which the document was created.
Definition: XDocumentProperties.idl:140
string PrintedBy
contains the name of the person who most recently printed the document.
Definition: XDocumentProperties.idl:123
sequence< com::sun::star::beans::NamedValue > DocumentStatistics
contains some statistics about the document.
Definition: XDocumentProperties.idl:209
When the button is clicked, an URL set for the button is opened.
Definition: FormButtonType.idl:52
string TemplateURL
contains the URL of the template from which the document was created.
Definition: XDocumentProperties.idl:149
com::sun::star::util::DateTime ModificationDate
contains the date and time of the last time the document was stored.
Definition: XDocumentProperties.idl:118
sequence< string > Keywords
contains a list of keywords for the document.
Definition: XDocumentProperties.idl:100
string Generator
identifies which application was used to create or last modify the document.
Definition: XDocumentProperties.idl:72
string Author
contains the initial author of the document.
Definition: XDocumentProperties.idl:60