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