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