summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document
diff options
context:
space:
mode:
authorMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
committerMichael Hönnig <mi@openoffice.org>2002-10-03 12:11:20 +0000
commitcb23f6a62077022736a40d6315ee92a218f489e0 (patch)
tree713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/document
parent625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff)
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/document')
-rw-r--r--offapi/com/sun/star/document/AmbigousFilterRequest.idl21
-rw-r--r--offapi/com/sun/star/document/DocumentInfo.idl323
-rw-r--r--offapi/com/sun/star/document/EventDescriptor.idl46
-rw-r--r--offapi/com/sun/star/document/EventObject.idl23
-rw-r--r--offapi/com/sun/star/document/Events.idl107
-rw-r--r--offapi/com/sun/star/document/ExportFilter.idl134
-rw-r--r--offapi/com/sun/star/document/FilterFactory.idl163
-rw-r--r--offapi/com/sun/star/document/ImportFilter.idl137
-rw-r--r--offapi/com/sun/star/document/LinkTarget.idl60
-rw-r--r--offapi/com/sun/star/document/LinkTargets.idl37
-rw-r--r--offapi/com/sun/star/document/MediaDescriptor.idl11
-rw-r--r--offapi/com/sun/star/document/NoSuchFilterRequest.idl21
-rw-r--r--offapi/com/sun/star/document/OfficeDocument.idl169
-rw-r--r--offapi/com/sun/star/document/RedlineDisplayType.idl13
-rw-r--r--offapi/com/sun/star/document/StandaloneDocumentInfo.idl4
-rw-r--r--offapi/com/sun/star/document/TypeDetection.idl80
-rw-r--r--offapi/com/sun/star/document/XActionLockable.idl60
-rw-r--r--offapi/com/sun/star/document/XBinaryStreamResolver.idl30
-rw-r--r--offapi/com/sun/star/document/XDocumentInfo.idl144
-rw-r--r--offapi/com/sun/star/document/XDocumentInfoSupplier.idl64
-rw-r--r--offapi/com/sun/star/document/XDocumentInsertable.idl33
-rw-r--r--offapi/com/sun/star/document/XEmbeddedObjectResolver.idl6
-rw-r--r--offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl36
-rw-r--r--offapi/com/sun/star/document/XEventBroadcaster.idl39
-rw-r--r--offapi/com/sun/star/document/XEventListener.idl43
-rw-r--r--offapi/com/sun/star/document/XEventsSupplier.idl50
-rw-r--r--offapi/com/sun/star/document/XExporter.idl33
-rw-r--r--offapi/com/sun/star/document/XExtendedFilterDetection.idl50
-rw-r--r--offapi/com/sun/star/document/XFilter.idl31
-rw-r--r--offapi/com/sun/star/document/XGraphicObjectResolver.idl6
-rw-r--r--offapi/com/sun/star/document/XImporter.idl30
-rw-r--r--offapi/com/sun/star/document/XInteractionFilterSelect.idl41
-rw-r--r--offapi/com/sun/star/document/XLinkTargetSupplier.idl46
-rw-r--r--offapi/com/sun/star/document/XMimeTypeInfo.idl10
-rw-r--r--offapi/com/sun/star/document/XRedlinesSupplier.idl9
-rw-r--r--offapi/com/sun/star/document/XStandaloneDocumentInfo.idl113
-rw-r--r--offapi/com/sun/star/document/XTypeDetection.idl76
-rw-r--r--offapi/com/sun/star/document/XViewDataSupplier.idl37
38 files changed, 1188 insertions, 1148 deletions
diff --git a/offapi/com/sun/star/document/AmbigousFilterRequest.idl b/offapi/com/sun/star/document/AmbigousFilterRequest.idl
index 234f8a96646d..3304494cb293 100644
--- a/offapi/com/sun/star/document/AmbigousFilterRequest.idl
+++ b/offapi/com/sun/star/document/AmbigousFilterRequest.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: AmbigousFilterRequest.idl,v $
*
- * $Revision: 1.1 $
+ * $Revision: 1.2 $
*
- * last change: $Author: as $ $Date: 2001-12-19 13:06:49 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:47 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,15 +71,28 @@ module com { module sun { module star { module document {
//=============================================================================
/** should be used for interaction to handle states of ambigous filter detection
- to ask user of operation for his decision
+
+ <p>
+ This exception indicates, that generic filter detection can't decide which of
+ two filters is the right one. In this case an interaction will be made.
+ Given URL can be used to decide between given two filters.
+ Decision can be made e.g. by a dialog, on which the user must select one
+ of these filters.
+ A possible continuation of type <type>XInteractionFilterSelect</type>
+ transport this decision back to source of started interaction.
+ </p>
+
+ @see XInteractionFilterSelect
*/
exception AmbigousFilterRequest : ::com::sun::star::uno::Exception
{
+ //-------------------------------------------------------------------------
/** transport URL which couldn't be detected right
*/
string URL;
- /** two filters as possible result of user decision
+ //-------------------------------------------------------------------------
+ /** two filters as possible result
*/
string SelectedFilter;
string DetectedFilter;
diff --git a/offapi/com/sun/star/document/DocumentInfo.idl b/offapi/com/sun/star/document/DocumentInfo.idl
index 24a0ce434233..3c8dead5c449 100644
--- a/offapi/com/sun/star/document/DocumentInfo.idl
+++ b/offapi/com/sun/star/document/DocumentInfo.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: DocumentInfo.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -81,320 +81,235 @@
#include <com/sun/star/util/DateTime.idl>
#endif
+#ifndef __com_sun_star_lang_Locale_idl__
+#include <com/sun/star/lang/Locale.idl>
+#endif
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
-
-// DocMerge from xml: service com::sun::star::document::DocumentInfo
-/** This service provides document-specific information like the
- author, creation date and user fields.@see StandaloneDocumentInfo
+/** this service provides document-specific information like the
+ author, creation date and user fields
+
+ <p>
+ Contrary to the service <type>StandaloneDocumentInfo</type> the document - which
+ contains such informations - must be loaded completly. As a result of that this
+ DocumengInfo service is available on an open document via the interface
+ <type>XDocumentInfoSupplier</type> only.
+ </p>
+
+ @see StandaloneDocumentInfo
+ @see XDocumentInfoSupplier
*/
service DocumentInfo
{
- // DocMerge: empty anyway
- interface com::sun::star::document::XDocumentInfo;
+ //-------------------------------------------------------------------------
+ /** provides access to the user fields for the information regarding the
+ document
- // DocMerge: empty anyway
- interface com::sun::star::lang::XComponent;
+ <p>
+ These fields are additional to normal properties.
+ (see below)
+ </p>
+ */
+ interface XDocumentInfo;
- // DocMerge: empty anyway
+ //-------------------------------------------------------------------------
+ /** neccessary to support normal properties
+ */
interface com::sun::star::beans::XPropertySet;
- // DocMerge: empty anyway
- interface com::sun::star::beans::XFastPropertySet;
-
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Author
- /** contains the intial author of the document.
+ /** supports faster access on well known properties by using index
*/
- [property] string Author;
+ interface com::sun::star::beans::XFastPropertySet;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::BlindCopiesTo
- /** contains the recipients who have received or will
- receive a blind copy by email.
-
-
-
- <p>Recipients who receive a blind copy are not visible to other
- recipients.
-
- </p>
- <p>If there is more than one recipient, a comma is used as a delimiter.</p>
+ /** contains the intial author of the document
*/
- [property] string BlindCopiesTo;
+ [property] string Author;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::CopyTo
- /** contains the recipients who have received or will
- receive a copy by email.
-
-
-
- <p>These recipients are visible to other recipients.
-
- </p>
- <p>If there is more than one recipient, a comma is used as a delimiter.</p>
+ /** identifies application was used to create or last modify the document
*/
- [property] string CopyTo;
+ [property] string Generator;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::CreationDate
/** contains the date and time of the first time the
- document was stored.
+ document was stored
*/
[property] com::sun::star::util::DateTime CreationDate;
//-------------------------------------------------------------------------
+ /** contains the title of the document
+ */
+ [property] string Title;
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Description
- /** contains a multi-line comment of the document.
-
- <p>Line delimiters can be UNIX, Macintosh or DOS style.</p>
+ //-------------------------------------------------------------------------
+ /** subject of document
*/
- [property] string Description;
+ [property] string Subject;
//-------------------------------------------------------------------------
+ /** contains a multi-line comment of the document
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::InReplyTo
- /** contains the message ID to which this is an answer.
+ <p>
+ Line delimiters can be UNIX, Macintosh or DOS style.
+ </p>
*/
- [property] string InReplyTo;
+ [property] string Description;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Keywords
/** contains a comma separated list of keywords for
- the document.
+ the document
*/
[property] string Keywords;
//-------------------------------------------------------------------------
+ /** contains the MIME-type of the document's resource
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::MIMEType
- /** contains the MIME-type of the document's resource.
-
- <p>The MIME-type is neither stored in the document information nor in
+ <p>
+ The MIME-type is neither stored in the document information nor in
the document; it is sent within a protocol header or is
- detected, thus it cannot be changed.</p>
+ detected, thus it cannot be changed.
+ </p>
*/
[readonly, property] string MIMEType;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::ModifyDate
- /** contains the date and time of the last time the
- document was stored.
+ /** default language of the document
*/
- [property] com::sun::star::util::DateTime ModifyDate;
+ [property] com::sun::star::lang::Locale Language;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::ModifiedBy
/** contains the name of the editor who was the last
- person to store this document.
+ person to store this document
*/
[property] string ModifiedBy;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Newsgroups
- /** contains the list of newsgroups where this document
- was or will be posted.
-
- <p>If there is more than one entry, the list is separated by a comma(s).</p>
+ /** contains the date and time of the last time the
+ document was stored
*/
- [property] string Newsgroups;
+ [property] com::sun::star::util::DateTime ModifyDate;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Original
- /** contains the source of the document,
- <p>i.e., the message ID for a locally stored message.</p> */
- [property] string Original;
+ /** contains the name of the editor who was the last
+ person to print the document
+ */
+ [property] string PrintedBy;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Priority
- /** contains the priority of the document.
-
- <p>The value can be between 0 (very high) and 4 (very low).</p>
+ /** contains the date and time of when the document was
+ last printed
*/
- [property] short Priority;
+ [property] com::sun::star::util::DateTime PrintDate;
//-------------------------------------------------------------------------
+ /** contains the path and name of the template from
+ which the document was created
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Recipient
- /** contains the recipient of the document.
+ <p>
+ The value is an empty string if the document was not created
+ from a template or if it was detached from the template.
+ </p>
*/
- [property] string Recipient;
+ [property] string Template;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::References
- /** contains a list of referred message IDs.
+ /** contains the date and time of when the document
+ was created or updated from the template
*/
- [property] string References;
+ [property] com::sun::star::util::DateTime TemplateDate;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::ReplyTo
- /** contains the mailto:-URL for where to send an answer.
+ /** contains the URL to load automatically after a
+ specified time after the document is loaded into a desktop frame
*/
- [property] string ReplyTo;
+ [property] string AutoloadURL;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Theme
- /** contains a theme describing the topic of the document.
+ /** contains the number of seconds after which a specified
+ URL is to be loaded after the document is loaded into a desktop
+ frame
*/
- [property] string Theme;
+ [property] long AutoloadSecs;
//-------------------------------------------------------------------------
+ /** contains the name of the default frame into which
+ links should be loaded if no target is specified
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Title
- /** contains the title of the document.
+ <p>
+ This applies to the autoload feature too, but to others as well.
+ </p>
*/
- [property] string Title;
+ [property] string DefaultTarget;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::Template
- /** contains the path and name of the template from
- which the document was created.
-
-
-
- <p>The value is an empty string if the document was not created
- from a template or if it was detached from the template.</p>
+ /** @deprecated
*/
- [property] string Template;
+ [property] string BlindCopiesTo;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::TemplateDate
- /** contains the date and time of when the document
- was created or updated from the template.
+ /** @deprecated
*/
- [property] com::sun::star::util::DateTime TemplateDate;
+ [property] string CopyTo;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::IsEncrypted
- /** determines if the document is encrypted with a
- password.
-
-
-
- <p>It is not possible to set this value because the document
- which belongs to this <type>DocumentInfo</type> would no
- longer be loadable.
-
- </p>
- <p>The password itself is not stored in the document.</p>
+ /** @deprecated
*/
- [readonly, property] boolean IsEncrypted;
+ [property] string InReplyTo;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::PrintDate
- /** contains the date and time of when the document was
- last printed.
+ /** @deprecated
*/
- [property] com::sun::star::util::DateTime PrintDate;
+ [property] string Newsgroups;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::PrintedBy
- /** contains the name of the editor who was the last
- person to print the document.
+ /** @deprecated
*/
- [property] string PrintedBy;
+ [property] string Original;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadEnabled
- /** determines if another (or the same) URL is to be
- reloaded automatically after a specified time after the document
- is loaded into a desktop frame.
+ /** @deprecated
*/
- [property] boolean AutoloadEnabled;
+ [property] short Priority;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadURL
- /** contains the URL to load automatically after a
- specified time after the document is loaded into a desktop frame.
+ /** @deprecated
*/
- [property] string AutoloadURL;
+ [property] string Recipient;
//-------------------------------------------------------------------------
-
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::AutoloadSecs
- /** contains the number of seconds after which a specified
- URL is to be loaded after the document is loaded into a desktop
- frame.
+ /** @deprecated
*/
- [property] long AutoloadSecs;
+ [property] string References;
//-------------------------------------------------------------------------
+ /** @deprecated
+ */
+ [property] string ReplyTo;
- // DocMerge from xml: property com::sun::star::document::DocumentInfo::DefaultTarget
- /** contains the name of the default frame into which
- links should be loaded if no target is specified.
-
-
+ //-------------------------------------------------------------------------
+ /** @deprecated
+ */
+ [property] string Theme;
- <p>This applies to the autoload feature too, but to others as well.</p>
+ //-------------------------------------------------------------------------
+ /** @deprecated
*/
- [property] string DefaultTarget;
+ [readonly, property] boolean IsEncrypted;
+ //-------------------------------------------------------------------------
+ /** @deprecated
+ */
+ [property] boolean AutoloadEnabled;
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.5 2001/01/23 10:08:08 mi
- optional interfaces now marked as [optional] instead of just a prosa description of this fact
-
- Revision 1.4 2000/12/21 08:35:05 mi
- @see interface/service/... ident -> @see ident - for new docu generator
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.9 2000/09/11 11:52:18 mi
- documentation merged from XML
-
- Revision 1.5 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.4 2000/02/21 16:17:58 mi
- string documentation from stardiv...*.idl-files
-
- Revision 1.3 2000/02/07 11:24:26 mi
- zu #70728# missing documentation marked
-
- Revision 1.2 1999/11/18 11:49:55 mi
- XComponent now in module lang
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/EventDescriptor.idl b/offapi/com/sun/star/document/EventDescriptor.idl
index b4b25350b636..f48331d2d844 100644
--- a/offapi/com/sun/star/document/EventDescriptor.idl
+++ b/offapi/com/sun/star/document/EventDescriptor.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: EventDescriptor.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-01-24 16:26:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -58,51 +58,45 @@
*
*
************************************************************************/
-#ifndef __com_sun_star_document_DocumentEvent_idl__
-#define __com_sun_star_document_DocumentEvent_idl__
-
-#ifndef __com_sun_star_comtainer_XIndexReplace_idl__
-#include <com/sun/star/container/XIndexReplace.idl>
-#endif
+#ifndef __com_sun_star_document_EventDescriptor_idl__
+#define __com_sun_star_document_EventDescriptor_idl__
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
-
-/** specifies an event binding for a document or a document content.
+/** specifies an event binding for a document or a document content
@see Events
@see XEventsSupplier
*/
service EventDescriptor
{
- /** specifies the type of the event handler.
-
- <p>Usually this is one of the following:
- "None", "StarBasic", "JavaScript", "Presentation".
- This list is extensible. </p>
+ //-------------------------------------------------------------------------
+ /** specifies the type of the event handler
+
+ <p>
+ Usually this is one of the following:
+ <ul>
+ <lie>"None"</li>
+ <lie>"StarBasic"</li>
+ <lie>"JavaScript"</li>
+ <lie>"Presentation"</li>
+ </ul>
+ This list is extensible.
+ </p>
*/
[property] string EventType;
- /** specifies the script source code.
+ //-------------------------------------------------------------------------
+ /** specifies the script source code
*/
[property] string Script;
-
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.1 2001/01/24 16:16:45 mi
- stored document events and runtime document events structurally unified
-
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/EventObject.idl b/offapi/com/sun/star/document/EventObject.idl
index b8068dca2fae..f21c4347d52f 100644
--- a/offapi/com/sun/star/document/EventObject.idl
+++ b/offapi/com/sun/star/document/EventObject.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: EventObject.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-01-24 16:26:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,17 +70,19 @@
module com { module sun { module star { module document {
//=============================================================================
-
-/** is thrown on document and document content events.
+/** is thrown on document and document content events
@see XEventListener
@see XEventBroadcaster
*/
struct EventObject: com::sun::star::lang::EventObject
{
- /** specifies the type of the event handler.
+ //-------------------------------------------------------------------------
+ /** specifies the type of the event handler
- <p>For a list of possible event names see <type>Events</type>.
+ <p>
+ For a list of possible event names see <type>Events</type>.
+ </p>
*/
string EventName;
};
@@ -89,13 +91,4 @@ struct EventObject: com::sun::star::lang::EventObject
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.1 2001/01/24 13:21:26 mi
- stored document events and runtime document events structurally unified
-
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/Events.idl b/offapi/com/sun/star/document/Events.idl
index b4ca1e7af0bc..c8bc6272f849 100644
--- a/offapi/com/sun/star/document/Events.idl
+++ b/offapi/com/sun/star/document/Events.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: Events.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:48 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -58,8 +58,8 @@
*
*
************************************************************************/
-#ifndef __com_sun_star_document_DocumentEvent_idl__
-#define __com_sun_star_document_DocumentEvent_idl__
+#ifndef __com_sun_star_document_Events_idl__
+#define __com_sun_star_document_Events_idl__
#ifndef __com_sun_star_container_XNameReplace_idl__
#include <com/sun/star/container/XNameReplace.idl>
@@ -70,50 +70,58 @@
module com { module sun { module star { module document {
//=============================================================================
-
/** is a collection of all events supported by a document or content of a
- document.
+ document
+
+ <p>
+ Such Events will be broadcasted by a <type>XEventBroadcaster</type>
+ to any <type>XEventListener</type> packed as <type>EventObject</type>s.
+ </p>
*/
service Events
{
- /** offers access to the list of <type>EventDescriptor</type>s.
- <p>The following events are usually available: </p>
+ //-------------------------------------------------------------------------
+ /** offers access to the list of <type>EventDescriptor</type>s
+
+ <p>
+ The following events are usually available:
<dl>
- <dt>OnSelect
- <dt>OnInsertStart
- <dt>OnInsertDone
- <dt>OnMailMerge
- <dt>OnAlphaCharInput
- <dt>OnNonAlphaCharInput
- <dt>OnResize
- <dt>OnMove
- <dt>OnPageCountChange
- <dt>OnMouseOver
- <dt>OnClick
- <dt>OnMouseOut
- <dt>OnLoadError
- <dt>OnLoadCancel
- <dt>OnLoadDone
- <dt>OnLoad OnUnload
- <dt>OnStartApp
- <dt>OnCloseApp
- <dt>OnNew
- <dt>OnSave
- <dt>OnSaveAs
- <dt>OnFocus
- <dt>OnUnfocus
- <dt>OnPrint
- <dt>OnError
- <dt>OnLoadFinished
- <dt>OnSaveFinished
- <dt>OnModifyChanged
- <dt>OnPrepareUnload
- <dt>OnNewMail
- <dt>OnToggleFullscreen
- <dt>OnSaveDone
- <dt>OnSaveAsDone
+ <dt>OnAlphaCharInput</dt>
+ <dt>OnClick</dt>
+ <dt>OnCloseApp</dt>
+ <dt>OnError</dt>
+ <dt>OnFocus</dt>
+ <dt>OnInsertDone</dt>
+ <dt>OnInsertStart</dt>
+ <dt>OnLoad</dt>
+ <dt>OnLoadCancel</dt>
+ <dt>OnLoadDone</dt>
+ <dt>OnLoadError</dt>
+ <dt>OnLoadFinished</dt>
+ <dt>OnMailMerge</dt>
+ <dt>OnModifyChanged</dt>
+ <dt>OnMouseOut</dt>
+ <dt>OnMouseOver</dt>
+ <dt>OnMove</dt>
+ <dt>OnNew</dt>
+ <dt>OnNewMail</dt>
+ <dt>OnNonAlphaCharInput</dt>
+ <dt>OnPageCountChange</dt>
+ <dt>OnPrepareUnload</dt>
+ <dt>OnPrint</dt>
+ <dt>OnResize</dt>
+ <dt>OnSave</dt>
+ <dt>OnSaveAs</dt>
+ <dt>OnSaveAsDone</dt>
+ <dt>OnSaveDone</dt>
+ <dt>OnSaveFinished</dt>
+ <dt>OnSelect</dt>
+ <dt>OnStartApp</dt>
+ <dt>OnToggleFullscreen</dt>
+ <dt>OnUnfocus</dt>
+ <dt>OnUnload</dt>
</dl>
-
+ </p>
*/
interface com::sun::star::container::XNameReplace;
};
@@ -122,19 +130,4 @@ service Events
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.2 2001/01/24 16:26:20 mi
- compiles now
-
- Revision 1.1 2001/01/24 16:17:49 mi
- stored document events and runtime document events structurally unified
-
- Revision 1.1 2001/01/23 10:08:08 mi
- optional interfaces now marked as [optional] instead of just a prosa description of this fact
-
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/ExportFilter.idl b/offapi/com/sun/star/document/ExportFilter.idl
index ccc84088a156..e6ad7902dcd8 100644
--- a/offapi/com/sun/star/document/ExportFilter.idl
+++ b/offapi/com/sun/star/document/ExportFilter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ExportFilter.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -61,95 +61,129 @@
#ifndef __com_sun_star_document_ExportFilter_idl__
#define __com_sun_star_document_ExportFilter_idl__
-#ifndef __com_sun_star_document_XFilter_idl__
-#include <com/sun/star/document/XFilter.idl>
-#endif
-
#ifndef __com_sun_star_document_XExporter_idl__
#include <com/sun/star/document/XExporter.idl>
#endif
-#ifndef __com_sun_star_beans_XPropertySet_idl__
-#include <com/sun/star/beans/XPropertySet.idl>
+#ifndef __com_sun_star_document_XFilter_idl__
+#include <com/sun/star/document/XFilter.idl>
#endif
#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
+#ifndef __com_sun_star_container_XNamed_idl__
+#include <com/sun/star/container/XNamed.idl>
+#endif
+
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
+/** filter for exports
+
+ <p>
+ Such filters can be used for exporting a content.
+ Of course it's possible to combine it with the service <type>ImportFilter</type>
+ if import functionality should be available at same implementation too.
+ </p>
-/** filter for exports.
+ @see ImportFilter
*/
service ExportFilter
{
//-------------------------------------------------------------------------
- /** filter interface.
+ /** set source(!) document for this filter
<p>
- This interface is used to filter a document at saving time.
- </p>
+ The document must be used as the source for following filter operation.
+ Any content from there will be exported to another format.
+ </p>
*/
- interface com::sun::star::document::XFilter;
+ interface XExporter;
//-------------------------------------------------------------------------
- /** set document for this filter.
+ /** filter interface
<p>
- The document can used as the target of a filter output.
+ It's used to filter a document at saving time.
+ The source document should be already setted by using another interface
+ <member>ExportFilter::XExporter</member> which is supported by this service too.
</p>
+
+ <p>
+ Tip:<br>
+ If same implementation provides the service <type>ImportFilter</type> too,
+ code must distinguish between filtering from a source document (for export) or
+ filtering to a target document (for import). This can be recognized by saving
+ state of used interfaces <type>XExporter</type> or <type>XImporter</type>!
+ Otherwise it's not clear which action is required here.
+ </p>
*/
- interface ::com::sun::star::document::XExporter;
+ interface XFilter;
//-------------------------------------------------------------------------
- /** support initialization of filter with its own configuration.
+ /** support initialization of filter with its own configuration
+
+ <p>
+ A filter object must be created by global service <type>FilterFactory</type>.
+ If filter supports this optional interface, he will be initialized by the factory directly
+ after creation. The factory will pass follow informations to this new instance:
+ <ul>
+ <li>first item will be a set of configuration data of the filter</li>
+ <li>after that will follow may given optional parameters of call
+ <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member>
+ of service <type>FilterFactory</type>.
+ </li>
+ </ul>
+ See description of service <member>FilterFactory::XNameAccess</member> for a description of
+ possible configuration data too.
+ </p>
+
<p>
- A filter must support readonly access to its own configuration, but
- readonly properties couldn't be set.
- That is the reason for this interface.
- All Anys of given sequence are from Type <type>PropertyValue</type>.
+ Java Example:
+ <listing>
+ void XInitialization::initialize( java.lang.Object[] lData )
+ {
+ // Config part exist every time - it's guaranted by FilterFactory!
+ int i=0;
+ com.sun.star.beans.NamedValue[] lConfig = lData[i];
+ for( y=0; y&lt;lConfig.length(); ++y )
+ {
+ // ... work with this config data
+ }
+ // Arguments of call createInstanceWithArguments() are optional ones.
+ // They mustn't exist.
+ // Note: i starts with
+ for( ; i&lt;lData.length(); ++i )
+ {
+ // ... work with this optional data
+ }
+ }
+ </listing>
</p>
*/
[optional] interface com::sun::star::lang::XInitialization;
//-------------------------------------------------------------------------
- /** readonly access to filter configuration.
+ /** provides access to the internal name of this filter
<p>
- This interface supports readonly access to our internal configuration of this filter.
- The filter gets the configuration about <type>XInitialization</type> at creation by using
- the <type>FilterFactory</type>.
+ This internal filter name can be used on service <type>FilterFactory</type>
+ to get further informations about it (e.g. his registration for mime types or extensions etc.)
+ It's important that returned string is the "internal name" of the filter which must be
+ unambigous against all other registered filter in current instalation.
+ </p>
+ <p>
+ <strong>Attention!</strong><br>
+ Supported method setName() sould be ignored or forwarded to the FilterFactory.
+ It's not allowed to set it directly to the configuration. Because it depends
+ from real implementation of the FilterFactory if it will be allowed or not!
</p>
*/
- interface com::sun::star::beans::XPropertySet;
-
- /// filter is registered for this type.
- [property, readonly] string Type;
-
- /// localized name of filter to show at UI elements.
- [property, readonly] string UIName;
-
- /// service name which presents the document.
- [property, readonly] string DocumentService;
-
- /// service name of this filter implementation.
- [property, readonly] string FilterService;
-
- /// flags to describe the filter.
- [property, readonly] string Flags;
-
- /// additional information with private structure.
- [property, readonly] string UserData;
-
- /// version number of file format.
- [property, readonly] string FileFormatVersion;
-
- /// name of suitable template.
- [property, readonly] string TemplateName;
+ [optional] interface com::sun::star::container::XNamed;
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/FilterFactory.idl b/offapi/com/sun/star/document/FilterFactory.idl
index a8194ce9d0c2..9f057ab9c336 100644
--- a/offapi/com/sun/star/document/FilterFactory.idl
+++ b/offapi/com/sun/star/document/FilterFactory.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: FilterFactory.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,54 +69,155 @@
#include <com/sun/star/container/XNameAccess.idl>
#endif
+#ifndef __com_sun_star_container_XContainerQuery_idl__
+#include <com/sun/star/container/XContainerQuery.idl>
+#endif
+
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
+/** factory to create filter objects or search on filter configuration
-/** factory to create filter objects
+ <p>
+ After a generic <type>TypeDetection</type> an internal type name
+ will be well known (or may not if it failed to detect requested document).
+ For such internal type names filters will be registered. If there are more then
+ ones any of them can use the default flag to be preferred.
+ This factory can be used to the follow then:
+ <ul>
+ <li>search on filter configuration (includes searching for suitable filter for
+ a given internal type name too)
+ </li>
+ <li>create the filter object
+ </li>
+ <li>get/set properties of any registered filter.
+ (means in configuration, not on the filter)
+ </li>
+ </ul>
+ </p>
*/
service FilterFactory
{
//-------------------------------------------------------------------------
- /** search suitable filter for given internal type name and additional arguments
- and create it
+ /** provides search on flat filter configuration
+
+ <p>
+ After a <type>TypDetection</type> an internal name of a type which presents
+ the requested document will be well known. With this interface it's possible
+ to find out which filter(s) are registered for that. It's possible to use
+ implementation dependend query commands (strings) or sets of properties which
+ must supported by searched filter(s). Returned enumerations contains a reference
+ to sub sets of filter(s) (means to her flat data structures represented as
+ <type scope="com::sun::star::beans" dim="[]">NamedValue</type>) which can be used
+ for further steps then; e.g, to create the filter(s).
+ (see list of properties below on <member>FilterFactory::XNameAccess</member>)
+ </p>
<p>
- After a <type>TypDetection</type> you have an internal name of a type which presents
- your document. Call createInstance() or createInstanceWithArguments() with these
- informations and we create a suitable filter for you.
- There exist two types of filters: <type>ImportFilter</type> and <type>ExportFilter</type>.
- A combination of both services in one implementation is also possible.
- You can regulate search for filter by giving correct arguments - like flags for import/export ...
-
- @attention Don't use getAvailableServiceNames()!
- Please use XNameAccess to get informations about our configuration of accessible filters.
- </p>
+ Same functionality (for searching) will be provided by the follow interface
+ <member>FilterFactory::XNameAccess</member> - but that willn't be very comfortable
+ to do so.
+ </p>
*/
- interface com::sun::star::lang::XMultiServiceFactory;
+ interface com::sun::star::container::XContainerQuery;
//-------------------------------------------------------------------------
- /** readonly access to filter configuration
+ /** provides simple access on flat filter configuration
+ <p
+ Every filter (<type>ExportFilter</type>/<type>ImportFilter</type>) is specified by
+ some properties wich are represented as <type scope="com::sun::star::beans" dim="[]">NamedValue</type>.
+ This interface provides pure access (read/write) on these data.
+ A name for the calling methods must the internal filter name be used only.
+ Returned any capsulate the flat property lists then. May this interface will be neccessary
+ to extend missing funtionality of <member>FilterFactory::XContainerQuery</member> or for
+ changing the configuration (if implementation of this service allow that! may they will be readonly).
+ Query interface before provides readonly access only.
+ </p>
<p>
- These interfaces support a readonly access to our internal configuration of all accessible filters.
- The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any!
-
- Supported properties are:
- name of property value type of property description
- "Type" [string ] filter is registered for this type
- "UIName" [string ] localized name of filter to show at the UI
- "DocumentService" [string ] service name which presents the document
- "FilterService" [string ] service name of filter implementation
- "Flags" [integer] flags to describe the filter
- "UserData" [string ] additional information with private structure!
- "FileFormatVersion" [integer] version number of file format
- "TemplateName" [string ] name of suitable template
- </p>
+ Follow properties are supported by a filter:
+ <table border=1>
+ <tr>
+ <td><strong>property name</strong></td>
+ <td><strong>value type</strong></td>
+ <td><strong>description</strong></td>
+ </tr>
+ <tr>
+ <td><em>Type<em></td>
+ <td>[string]</td>
+ <td>filter is registered for this internal type name<br>
+ (see <type>TypeDetection</type> for further informations)</td>
+ </tr>
+ <tr>
+ <td><em>UIName<em></td>
+ <td>[string]</td>
+ <td>localized name of filter to show at the UI</td>
+ </tr>
+ <tr>
+ <td><em>DocumentService<em></td>
+ <td>[string]</td>
+ <td>service name which presents the document type<br>
+ (e.g. <type scope="com::sun::star::text">TextDocument</type>)</td>
+ </tr>
+ <tr>
+ <td><em>FilterService<em></td>
+ <td>[string]</td>
+ <td>service name of filter implementation<br>
+ Note: It means the implementation name of the service realy.
+ Because it's not possible to distinguish between
+ more then one filters otherwise.</td>
+ </tr>
+ <tr>
+ <td><em>Flags<em></td>
+ <td>[integer]</td>
+ <td>describe the filter more specific<br>
+ (e.g. for import/export or as default)</td>
+ </tr>
+ <tr>
+ <td><em>UserData<em></td>
+ <td>[string]</td>
+ <td>contains filter specific configuration formated as string
+ for historical reasons</td>
+ </tr>
+ <tr>
+ <td><em>FileFormatVersion<em></td>
+ <td>[integer]</td>
+ <td>specifies supported format version if there exist more then ones</td>
+ </tr>
+ <tr>
+ <td><em>TemplateName<em></td>
+ <td>[string]</td>
+ <td>name of suitable template</td>
+ </tr>
+ </table>
+ </p>
*/
interface com::sun::star::container::XNameAccess;
+
+ //-------------------------------------------------------------------------
+ /** factory to create filter objects
+
+ <p>
+ After using the interfaces before (or if it was already clear) an internal
+ filter name should be well known. This can be used at this interface to create
+ the real filter object for using. It's possible to use optional arguments
+ for initializing too.
+ If created filter supports the interface <type scope="com::sun::star::lang">XInitialization</type>
+ this factory will pass his own configuration data and the may given optional
+ arguments to it. (see <member>ExportFilter::XInitialization</member> or
+ <member>ImportFilter::XInitialization</member> for further informations about that)
+ If it doesn't support it nothing will be done then. The filter will be returned
+ uninitialized then and must get his configuration by another way himself.
+ But he should supports the interface <type scope="com::sun::star::container">XNamed</type>
+ to privide his own internal name. Any user of it can use this information
+ to get more information about it on this FilterFactory service.
+ Note: Return value can be <NULL/> if unknown filter was requested or
+ coudln't be created successfully.
+ </p>
+ */
+ interface com::sun::star::lang::XMultiServiceFactory;
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/ImportFilter.idl b/offapi/com/sun/star/document/ImportFilter.idl
index 4cde134b79e6..b97336e851d1 100644
--- a/offapi/com/sun/star/document/ImportFilter.idl
+++ b/offapi/com/sun/star/document/ImportFilter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ImportFilter.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: arellano $ $Date: 2001-04-16 21:39:07 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -61,96 +61,129 @@
#ifndef __com_sun_star_document_ImportFilter_idl__
#define __com_sun_star_document_ImportFilter_idl__
-#ifndef __com_sun_star_document_XFilter_idl__
-#include <com/sun/star/document/XFilter.idl>
-#endif
-
#ifndef __com_sun_star_document_XImporter_idl__
#include <com/sun/star/document/XImporter.idl>
#endif
-#ifndef __com_sun_star_beans_XPropertySet_idl__
-#include <com/sun/star/beans/XPropertySet.idl>
+#ifndef __com_sun_star_document_XFilter_idl__
+#include <com/sun/star/document/XFilter.idl>
#endif
#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
+#ifndef __com_sun_star_container_XNamed_idl__
+#include <com/sun/star/container/XNamed.idl>
+#endif
+
//=============================================================================
module com { module sun { module star { module document {
//=============================================================================
+/** filter for imports
-/** filter for imports.
+ <p>
+ Such filters can be used for importing a content.
+ Of course it's possible to combine it with the service <type>ExportFilter</type>
+ if export functionality should be available at same implementation too.
+ </p>
+
+ @see ExportFilter
*/
service ImportFilter
{
//-------------------------------------------------------------------------
- /** filter interface.
+ /** set target(!) document for this filter
<p>
- This interface is used to filter a document at loading time.
- </p>
+ The document must be used as the target of the filter.
+ Any external content will be written there.
+ </p>
*/
- interface com::sun::star::document::XFilter;
+ interface XImporter;
//-------------------------------------------------------------------------
- /** set document for this filter.
+ /** filter interface
<p>
- The document can be used as source of filter input.
+ It's used to filter a document at loading time.
+ The target document should be already setted by using another interface
+ <member>ImportFilter::XImporter</member> which is supported by this service too.
</p>
+
+ <p>
+ Tip:<br>
+ If same implementation provides the service <type>ExportFilter</type> too,
+ code must distinguish between filtering into a target document (for import) or
+ filtering from a source document (for export). This can be recognized by saving
+ state of used interfaces <type>XExporter</type> or <type>XImporter</type>!
+ Otherwise it's not clear which action is required here.
+ </p>
*/
- interface com::sun::star::document::XImporter;
+ interface XFilter;
//-------------------------------------------------------------------------
- /** support initialization of filter with its own configuration.
+ /** support initialization of filter with its own configuration
+
<p>
- A filter must support a readonly access to its own configuration.
- but readonly properties could not be set.
- That is the reason for this interface.
- All Anys of given sequence are from Type <type>PropertyValue</type>.
+ A filter object must be created by global service <type>FilterFactory</type>.
+ If filter supports this optional interface, he will be initialized by the factory directly
+ after creation. The factory will pass follow informations to this new instance:
+ <ul>
+ <li>first item will be a set of configuration data of the filter</li>
+ <li>after that will follow may given optional parameters of call
+ <member scope="com::sun::star::lang">XMultiServiceFactory::createInstanceWithArguments()</member>
+ of service <type>FilterFactory</type>.
+ </li>
+ </ul>
+ See description of service <member>FilterFactory::XNameAccess</member> for a description of
+ possible configuration data too.
+ </p>
+
+ <p>
+ Java Example:
+ <listing>
+ void XInitialization::initialize( java.lang.Object[] lData )
+ {
+ // Config part exist every time - it's guaranted by FilterFactory!
+ int i=0;
+ com.sun.star.beans.NamedValue[] lConfig = lData[i];
+ for( y=0; y&lt;lConfig.length(); ++y )
+ {
+ // ... work with this config data
+ }
+ // Arguments of call createInstanceWithArguments() are optional ones.
+ // They mustn't exist.
+ // Note: i starts with
+ for( ; i&lt;lData.length(); ++i )
+ {
+ // ... work with this optional data
+ }
+ }
+ </listing>
</p>
*/
- interface com::sun::star::lang::XInitialization;
+ [optional] interface com::sun::star::lang::XInitialization;
//-------------------------------------------------------------------------
- /** readonly access to filter configuration.
+ /** provides access to the internal name of this filter
<p>
- This interface supports readonly access to our internal configuration of this filter.
- The filter gets its configuration about <type>XInitialization</type> at creation by using
- the <type>FilterFactory</type>.
+ This internal filter name can be used on service <type>FilterFactory</type>
+ to get further informations about it (e.g. his registration for mime types or extensions etc.)
+ It's important that returned string is the "internal name" of the filter which must be
+ unambigous against all other registered filter in current instalation.
+ </p>
+ <p>
+ <strong>Attention!</strong><br>
+ Supported method setName() sould be ignored or forwarded to the FilterFactory.
+ It's not allowed to set it directly to the configuration. Because it depends
+ from real implementation of the FilterFactory if it will be allowed or not!
</p>
*/
- interface com::sun::star::beans::XPropertySet;
-
- /// filter is registered for this type.
- [property, readonly] string Type;
-
- /// localized name of filter to show at UI elements.
- [property, readonly] string UIName;
-
- /// service name which presents the document.
- [property, readonly] string DocumentService;
-
- /// service name of this filter implementation.
- [property, readonly] string FilterService;
-
- /// flags to describe the filter.
- [property, readonly] string Flags;
-
- /// additional information with private structure.
- [property, readonly] string UserData;
-
- /// version number of file format.
- [property, readonly] string FileFormatVersion;
-
- /// name of suitable template.
- [property, readonly] string TemplateName;
-
+ [optional] interface com::sun::star::container::XNamed;
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/LinkTarget.idl b/offapi/com/sun/star/document/LinkTarget.idl
index 1660d7d6583d..984859d3477a 100644
--- a/offapi/com/sun/star/document/LinkTarget.idl
+++ b/offapi/com/sun/star/document/LinkTarget.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: LinkTarget.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:49 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,40 +72,25 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: service com::sun::star::document::LinkTarget
/** This service is implemented by objects inside a document object model that
can be the target of a link inside a document
*/
service LinkTarget
{
- // DocMerge: empty anyway
-
- // DocMerge: empty anyway
interface com::sun::star::beans::XPropertySet;
-
- // DocMerge: from idl
-
- // DocMerge from xml: service com::sun::star::document::LinkTarget: interface com::sun::star::document::XLinkTargetSupplier
- /** Optional, this object could also have children that can be the
- target of a link.
+ /** a link target may have child objects which can be link targets too.
+ These are accessible by this optinonal interface.
*/
- interface com::sun::star::document::XLinkTargetSupplier;
+ [optional] interface com::sun::star::document::XLinkTargetSupplier;
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: property com::sun::star::document::LinkTarget::LinkDisplayName
- /** Contrary to the name of this link, this property should be a human
- readable name for this object that could be displayed in a user
- interface
+ /** contains a human readable name for this object that could be displayed in a user
+ interface.
*/
[readonly, property] string LinkDisplayName;
@@ -115,33 +100,4 @@ service LinkTarget
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.10 2000/09/11 11:52:18 mi
- documentation merged from XML
-
- Revision 1.5 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.4 2000/04/26 11:21:39 bm
- orthographical error in comment
-
- Revision 1.3 2000/02/21 16:17:59 mi
- string documentation from stardiv...*.idl-files
-
- Revision 1.2 2000/02/07 11:24:27 mi
- zu #70728# missing documentation marked
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/LinkTargets.idl b/offapi/com/sun/star/document/LinkTargets.idl
index 4078a8e74126..1bdfb375ee0f 100644
--- a/offapi/com/sun/star/document/LinkTargets.idl
+++ b/offapi/com/sun/star/document/LinkTargets.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: LinkTargets.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:42:40 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:50 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,28 +68,19 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: service com::sun::star::document::LinkTargets
/** This service gives access to a collection of names that are child links
of the parent object that supplied this service.
-
-
<p>The <type scope="com::sun::star::container">XNameAccess</type> returns elements
of <type scope="com::sun::star::beans">XPropertySet</type> that implement
- the service <type>LinkTarget</type>
- </p>
+ the service <type>LinkTarget</type>. </p>
*/
service LinkTargets
{
- // DocMerge: empty anyway
-
- // DocMerge: empty anyway
interface com::sun::star::container::XNameAccess;
};
@@ -98,24 +89,4 @@ service LinkTargets
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.7 2000/09/11 11:52:18 mi
- documentation merged from XML
-
- Revision 1.3 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.2 2000/02/07 11:24:27 mi
- zu #70728# missing documentation marked
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/MediaDescriptor.idl b/offapi/com/sun/star/document/MediaDescriptor.idl
index a1f222dd47f7..896ba2cabd2a 100644
--- a/offapi/com/sun/star/document/MediaDescriptor.idl
+++ b/offapi/com/sun/star/document/MediaDescriptor.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: MediaDescriptor.idl,v $
*
- * $Revision: 1.9 $
+ * $Revision: 1.10 $
*
- * last change: $Author: as $ $Date: 2002-07-23 13:36:15 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:50 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -446,10 +446,12 @@ service MediaDescriptor
[property] string TemplateName;
//-------------------------------------------------------------------------
- /** name of the region of the template
+ /** name of the template instead of the URL
<p>
- Use always in conjunction with <member>MediaDescriptor::TemplateName</member>.
+ The logical name of a template to load. Together with the <member>MediaDescriptor::TemplateRegion</type>
+ property it can be used instead of the URL of the template. Use always in conjunction with
+ <member>MediaDescriptor::TemplateRegionName</member>.
</p>
*/
[property] string TemplateRegionName;
@@ -488,7 +490,6 @@ service MediaDescriptor
//-------------------------------------------------------------------------
/** set special view state
-
<p>
Data to set a special view state after loading. The type depends on
the component and is usually retrieved from a <type scope="com::sun::star::frame">Controller</type>
diff --git a/offapi/com/sun/star/document/NoSuchFilterRequest.idl b/offapi/com/sun/star/document/NoSuchFilterRequest.idl
index 675990220185..a2a2bff0b40c 100644
--- a/offapi/com/sun/star/document/NoSuchFilterRequest.idl
+++ b/offapi/com/sun/star/document/NoSuchFilterRequest.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: NoSuchFilterRequest.idl,v $
*
- * $Revision: 1.1 $
+ * $Revision: 1.2 $
*
- * last change: $Author: as $ $Date: 2001-11-08 11:55:07 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:51 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,9 +71,26 @@ module com { module sun { module star { module document {
//=============================================================================
/** should be used for interaction to handle states of unknown filter during detection
+
+ <p>
+ If during loading time the filter can't be detected and wasn't given at calling time,
+ a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used.
+ (it's a a part of used <type>MediaDescriptor</type>)
+ Such "NoSuchFilterRequest" will be used then to start right interaction on that to
+ get a decision wich filter should be used for given URL. A possible continiuation
+ of type <type>XInteractionFilterSelect</type> will transport this decision back to
+ generic filter detection and force using of it. Of course it's possible to abort
+ the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>.
+ </p>
+
+ @see MediaDescriptor
+ @see com::sun::star::task::InteractionHandler
+ @see XInteractionFilterSelect
+ @see com::sun::star::task::XInteractionAbort
*/
exception NoSuchFilterRequest : ::com::sun::star::uno::Exception
{
+ //-------------------------------------------------------------------------
/** transport URL which couldn't be detected
*/
string URL;
diff --git a/offapi/com/sun/star/document/OfficeDocument.idl b/offapi/com/sun/star/document/OfficeDocument.idl
index 0bd3a67e479f..1a331a2be1d9 100644
--- a/offapi/com/sun/star/document/OfficeDocument.idl
+++ b/offapi/com/sun/star/document/OfficeDocument.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: OfficeDocument.idl,v $
*
- * $Revision: 1.7 $
+ * $Revision: 1.8 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:51 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -61,6 +61,14 @@
#ifndef __com_sun_star_document_OfficeDocument_idl__
#define __com_sun_star_document_OfficeDocument_idl__
+#ifndef __com_sun_star_frame_XModel_idl__
+#include <com/sun/star/frame/XModel.idl>
+#endif
+
+#ifndef __com_sun_star_util_XModifiable_idl__
+#include <com/sun/star/util/XModifiable.idl>
+#endif
+
#ifndef __com_sun_star_frame_XStorable_idl__
#include <com/sun/star/frame/XStorable.idl>
#endif
@@ -69,90 +77,149 @@
#include <com/sun/star/view/XPrintable.idl>
#endif
+#ifndef __com_sun_star_document_XEventBroadcaster_idl__
+#include <com/sun/star/document/XEventBroadcaster.idl>
+#endif
+
#ifndef __com_sun_star_document_XEventSupplier_idl__
#include <com/sun/star/document/XEventsSupplier.idl>
#endif
+#ifndef __com_sun_star_document_XDocumentInfoSupplier_idl__
+#include <com/sun/star/document/XDocumentInfoSupplier.idl>
+#endif
-//=============================================================================
-
- module com { module sun { module star { module document {
+#ifndef __com_sun_star_document_XViewDataSupplier_idl__
+#include <com/sun/star/document/XViewDataSupplier.idl>
+#endif
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: service com::sun::star::document::OfficeDocument
-/** This abstract service specifies a storable and printable document.
+module com { module sun { module star { module document {
+//=============================================================================
+/** abstract service which specifies a storable and printable document
+ <p>
+ All major document-like components should support this service
+ instead of simple components which supports a <type scope="com::sun::star::frame">Controller</type>
+ or pure <type scope="com::sun::star::awt">XWindow</type> only.
+ </p>
- <p>All major document-like components should support this service.</p>
+ @see com::sun::star::frame::Controller
*/
service OfficeDocument
{
- // DocMerge: empty anyway
+ //-------------------------------------------------------------------------
+ /** represents a component which is created from an URL and arguments
+
+ <p>
+ It is a representation of a resource in the sense that it was
+ created/loaded from the resource. The arguments are passed to the loader
+ to modify its behavior.
+ </p>
+ */
+ interface com::sun::star::frame::XModel;
+
+ //-------------------------------------------------------------------------
+ /** a storable document should provide information about his modify state
+
+ <p>
+ With this interface it's possible too, to reset the modify state.
+ That can be neccessary to prevent code against problem during closing
+ of the document without saving any changes.
+ </p>
+ */
+ interface com::sun::star::util::XModifiable;
+
+ //-------------------------------------------------------------------------
+ /** offers a simple way to store a component to an URL
+
+ <p>
+ This interface supports functionality
+ <ul>
+ <li>to make a copy of current component by saving it to another location</li>
+ <li>to commit made changes</li>
+ <li>to convert it by saving it by using suitable filter name.</li>
+ </ul>
+ </p>
+ */
interface com::sun::star::frame::XStorable;
- // DocMerge: empty anyway
+ //-------------------------------------------------------------------------
+ /** offers a way to print a component
+
+ <p>
+ It's possible to specify wich printer should be used and of course
+ print the document on it.
+ </p>
+ */
interface com::sun::star::view::XPrintable;
- /** access to bound event handlers.
+ //-------------------------------------------------------------------------
+ /** makes it possible to register listeners which are called whenever
+ a document event occurs
@optional
*/
- [optional] interface XEventsSupplier;
+ [optional] interface XEventBroadcaster;
- /** controls the focus behaviour of the form controls in the document
- <p>If this flag is set to <TRUE/>, any view belonging to the document should focus the
- first control in the document.</p>
- <p>With this, you may control if your document works primarily as a form document.</p>
- */
- [property, optional] boolean AutomaticControlFocus;
+ //-------------------------------------------------------------------------
+ /** access to bound event handlers
- /** controls the initial (on-load) behavior of the form controls in the document
- <p>If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br>
- If set to <FALSE/>, they will be alive (i.e., connected to the data source specified for the form
- they belong to).</p>
- <p>With this, you may control if your document works primarily as a form document.</p>
- */
- [property, optional] boolean ApplyFormDesignMode;
-};
+ @optional
+ */
+ [optional] interface XEventsSupplier;
-//=============================================================================
+ //-------------------------------------------------------------------------
+ /** document can provide a <type>DocumentInfo</type>
-}; }; }; };
+ <p>
+ Instead of the <type>StandaloneDocumentInfo</type> service the <type>DocumentInfo</type>
+ will be available on an already opened document only.
+ </p>
-/*=============================================================================
+ @optional
+ */
+ [optional] interface XDocumentInfoSupplier;
- $Log: not supported by cvs2svn $
- Revision 1.6 2001/03/19 12:50:25 fs
- #83970# +AutomaticControlFocus / +ApplyFormDesignMode
+ //-------------------------------------------------------------------------
+ /** access to some properties describing all open views to a document
- Revision 1.5 2001/02/05 15:03:45 kz
- XEventSupplier -> XEventsSupplier
+ @optional
+ */
+ [optional] interface XViewDataSupplier;
- Revision 1.4 2001/01/23 10:08:08 mi
- optional interfaces now marked as [optional] instead of just a prosa description of this fact
+ //-------------------------------------------------------------------------
+ /** controls the focus behaviour of the form controls in the document
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
+ <p>
+ If this flag is set to <TRUE/>, any view belonging to the document
+ should focus the first control in the document. With this, you may
+ control if your document works primarily as a form document.
+ </p>
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
+ @optional
+ */
+ [property, optional] boolean AutomaticControlFocus;
- Revision 1.7 2000/09/15 15:11:10 mi
- new interface XEventSupplier
+ //-------------------------------------------------------------------------
+ /** controls the initial (on-load) behavior of the form controls in the document
- Revision 1.6 2000/09/11 11:52:18 mi
- documentation merged from XML
+ <p>
+ If set to <TRUE/>, upon loading the document, the form controls will be in design mode.<br>
+ If set to <FALSE/>, they will be alive (i.e., connected to the data source specified for the form
+ they belong to).<br>
+ With this, you may control if your document works primarily as a form document.
+ </p>
- Revision 1.2 2000/08/04 15:18:44 mi
- #76800# document events
+ @optional
+ */
+ [property, optional] boolean ApplyFormDesignMode;
+};
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
+//=============================================================================
+}; }; }; };
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/RedlineDisplayType.idl b/offapi/com/sun/star/document/RedlineDisplayType.idl
index c16f7e971109..7332026bb0bc 100644
--- a/offapi/com/sun/star/document/RedlineDisplayType.idl
+++ b/offapi/com/sun/star/document/RedlineDisplayType.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: RedlineDisplayType.idl,v $
*
- * $Revision: 1.1 $
+ * $Revision: 1.2 $
*
- * last change: $Author: os $ $Date: 2001-01-16 13:13:45 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:52 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -63,11 +63,10 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-
/** specifies which changes in a document are displayed.
*/
constants RedlineDisplayType
@@ -75,17 +74,21 @@ constants RedlineDisplayType
/** no changes are displayed.
*/
const short NONE = 0;
+
/** only inserted parts are displayed and attributed.
*/
const short INSERTED = 1;
+
/** only inserted parts are displayed and attributed.
*/
const short INSERTED_AND_REMOVED = 2;
+
/** only removed parts are displayed and attributed.
*/
const short REMOVED = 3;
};
- };};};};
+
+};};};};
#endif
diff --git a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl b/offapi/com/sun/star/document/StandaloneDocumentInfo.idl
index 3260e4778e9c..0bfd298f01f9 100644
--- a/offapi/com/sun/star/document/StandaloneDocumentInfo.idl
+++ b/offapi/com/sun/star/document/StandaloneDocumentInfo.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: StandaloneDocumentInfo.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: as $ $Date: 2002-09-09 12:11:31 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:53 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
diff --git a/offapi/com/sun/star/document/TypeDetection.idl b/offapi/com/sun/star/document/TypeDetection.idl
index ab4f54dc3e37..c05decb83fc0 100644
--- a/offapi/com/sun/star/document/TypeDetection.idl
+++ b/offapi/com/sun/star/document/TypeDetection.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: TypeDetection.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:53 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,35 +74,81 @@
module com { module sun { module star { module document {
//=============================================================================
+/** capsulate a type detection service and supports access on taht configuration
-/** type detection of a specified resource (document)
+ <p>
+ It's possible to make a "flat" detection wich may use internal configuration
+ data only - or a "deep" detection which use special <type>DetectService</type>s
+ to look into the document to specify it unambigous. Last mode can be supressed
+ to perform.
+ </p>
*/
service TypeDetection
{
//-------------------------------------------------------------------------
/** detect resource
+
<p>
- Use XTypeDetection interface to get information about type of given document.
+ Use this interface to get information about type of given document.
+ Return value will be always an internal name of a registered document type.
+ It can be used may on other services (e.g. <type>FilterFactory</type>) for
+ further things (especialy to get the default filter for it).
</p>
*/
- interface com::sun::star::document::XTypeDetection;
+ interface XTypeDetection;
//-------------------------------------------------------------------------
- /** readonly access to complete type configuration list
+ /** provides access to complete type configuration
<p>
- These interface support a readonly access to our internal configuration of all accessible types.
- The return value of XNameAccess::getByName() is a sequence<PropertyValue> packed in an Any!
-
- Supported properties are:
- name of property value type of property description
- "UIName" [string] localized name of type to show at UI elements
- "MediaType" [string] mime type
- "ClipboardFormat" [string] name of clipboard format
- "URLPattern" [sequence<string>] a list of URL patterns which identify this type
- "Extensions" [sequence<string>] a list of file extensions which identify this type
- "DocumentIconID" [integer] an ID which present the number of corresponding icon
+ This configuration is organized as a collection of flat data structures.
+ The representation of such data structures will pe represented by
+ the type sequence<com::sun::star::beans::PropertyValue>.
+ Follow properties will be supported:
+ <table border=1>
+ <tr>
+ <td><strong>property name</strong></td>
+ <td><strong>Value type</strong></td>
+ <td><strong>description</strong></td>
+ </tr>
+ <tr>
+ <td>UIName</td>
+ <td>[string]</td>
+ <td>localized name of type to show at UI elements</td>
+ </tr>
+ <tr>
+ <td>MediaType</td>
+ <td>[string]</td>
+ <td>MIME or content type</td>
+ </tr>
+ <tr>
+ <td>ClipboardFormat</td>
+ <td>[string]</td>
+ <td>name of supported clipboard format</td>
+ </tr>
+ <tr>
+ <td>URLPattern</td>
+ <td>[sequence< string >]</td>
+ <td>a list of URL patterns which identify this type</td>
+ </tr>
+ <tr>
+ <td>Extensions</td>
+ <td>[sequence< string >]</td>
+ <td>a list of file extensions which identify this type</td>
+ </tr>
+ <tr>
+ <td>DocumentIconID</td>
+ <td>[integer]</td>
+ <td>an ID which present the number of corresponding icon</td>
+ </tr>
+ </table>
</p>
+
+ <p>
+ Note:<br>
+ All elements of this container will be adressed by his internal type name.
+ This must be an unambigous name.
+ </p>
*/
interface com::sun::star::container::XNameAccess;
};
diff --git a/offapi/com/sun/star/document/XActionLockable.idl b/offapi/com/sun/star/document/XActionLockable.idl
index 148b9af7bbc5..d3e10c6481b4 100644
--- a/offapi/com/sun/star/document/XActionLockable.idl
+++ b/offapi/com/sun/star/document/XActionLockable.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XActionLockable.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -68,53 +68,35 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XActionLockable
-/** enables the object to lock actions.
+/** makes it possible to prevent object internal updates for a certain period
+ to be able to quickly change multiple parts of the objects, where the
+ updates would invalidate each other, anyway.
*/
interface XActionLockable: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XActionLockable::isActionLocked
- /** determines if at least one lock exists.
+ /** @returns
+ <TRUE/> if at least one lock exists.
*/
boolean isActionLocked();
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XActionLockable::addActionLock
/** increments the lock count of the object by one.
*/
void addActionLock();
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XActionLockable::removeActionLock
/** decrements the lock count of the object by one.
*/
void removeActionLock();
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XActionLockable::setActionLocks
/** sets the locking level.
-
-
<p>This method is used for debugging purposes. The programming
environment can restore the locking after a break of a debug
session.</p>
@@ -122,14 +104,8 @@ interface XActionLockable: com::sun::star::uno::XInterface
void setActionLocks( [in] short nLock );
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XActionLockable::resetActionLocks
/** resets the locking level.
-
-
<p>This method is used for debugging purposes. The debugging
environment of a programming language can reset the locks
to allow refreshing of the view if a breakpoint is reached or
@@ -143,24 +119,4 @@ interface XActionLockable: com::sun::star::uno::XInterface
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.6 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.2 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XBinaryStreamResolver.idl b/offapi/com/sun/star/document/XBinaryStreamResolver.idl
index 3ae9d589f8e2..cd4cffd7c162 100644
--- a/offapi/com/sun/star/document/XBinaryStreamResolver.idl
+++ b/offapi/com/sun/star/document/XBinaryStreamResolver.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XBinaryStreamResolver.idl,v $
*
- * $Revision: 1.1 $
+ * $Revision: 1.2 $
*
- * last change: $Author: ka $ $Date: 2001-06-12 14:14:34 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,26 +73,40 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-/** this interface encapsulates functionality to get/resolve binary data streams.
+/**
+ <p>This interface encapsulates functionality to get/resolve binary data streams.
+ It is used to transform binary data to an url or to transform an url to binary
+ data. The binary data is represented through input and output streams.</p>
+
+ <p>In the case of transforming an url to binary data, the <code>getInputStream</code>
+ method is used. This returns a <type scope="com::sun::star::io">XInputStream</type>
+ from which the binary data, transformed from the given url, can be read.</p>
+
+ <p>In the case of transforming binary data to an url, a
+ <type scope="com::sun::star::io">XOutputStream</type> is created first to write
+ the binary data to. After this, the <code>resolveOutputStream</code> method can
+ be used to transform the binary data, represented through the
+ <type scope="com::sun::star::io">XOutputStream</type> interface, to an url.</p>
*/
interface XBinaryStreamResolver: com::sun::star::uno::XInterface
{
- /** converts the given url from the source url namespace to an input stream,
+ /** converts the given URL from the source URL namespace to an input stream,
from which binary data can be read
*/
com::sun::star::io::XInputStream getInputStream( [in] string aURL );
/** creates an output stream, to which binary data can be written.
- After writing, an url can be retrieved by a call to resolveOutputStream
+ After writing, an URL can be retrieved by a call to
+ <method>XBinaryStreamResolver::resolveOutputStream</method>.
*/
com::sun::star::io::XOutputStream createOutputStream();
- /** converts the output stream, data has been written to, to an url in
- source url namespace
+ /** converts the output stream, data has been written to, to an URL in
+ source URL namespace.
*/
string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream );
};
diff --git a/offapi/com/sun/star/document/XDocumentInfo.idl b/offapi/com/sun/star/document/XDocumentInfo.idl
index 0927af46c2a5..7b04f5462802 100644
--- a/offapi/com/sun/star/document/XDocumentInfo.idl
+++ b/offapi/com/sun/star/document/XDocumentInfo.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDocumentInfo.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,119 +69,111 @@
#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
#endif
-
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XDocumentInfo
/** provides access to the user fields for the information regarding the
- document.
-
-
-
- <p>Other fields are accessed as properties (interface XPropertySet and
- interface XFastPropertySet). </p>@see DocumentInfo
- @see XStandaloneDocumentInfo
- @see com::sun::star::beans::XPropertySet
- @see com::sun::star::beans::XFastPropertySet
+ document
+
+ <p>
+ These fields are special one of the set of available document properties.
+ Other ones are accessed as properties (by using the interface
+ <type scope="com::sun::star::beans">XPropertySet</type>) of service
+ <type>DocumentInfo</type>.
+ </p>
+
+ @see DocumentInfo
+ @see StandaloneDocumentInfo
+ @see com::sun::star::beans::XPropertySet
*/
interface XDocumentInfo: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
+ /** provides information about count of available fields
- // DocMerge: from idl
+ <p>
+ This count marks the top range of possible requests for get/set
+ any of these fields. Range = [0..count-1]
+ </p>
- // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldCount
- /** @returns
- the number of user fields available in the document information.
+ @returns
+ current count
*/
short getUserFieldCount();
//-------------------------------------------------------------------------
+ /** returns the name of an user field
- // DocMerge: from idl
+ @param Index
+ specifies the position of requested field
+ Range = [0..count-1]
- // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldName
- /** @returns
- the name of the user field at the specified position.
+ @returns
+ the name of the requested field
+
+ @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
+ if <var>Index</var> don't fit range of [0..count-1]
*/
- string getUserFieldName( [in] short nIndex )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
+ string getUserFieldName( [in] short Index )
+ raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
//-------------------------------------------------------------------------
+ /** returns the value of an user field
+
+ @param Index
+ specifies the position of requested field
+ Range = [0..count-1]
- // DocMerge: from idl
+ @returns
+ the value of the requested field
- // DocMerge from idl: method com::sun::star::document::XDocumentInfo::getUserFieldValue
- /** @returns
- the value of the user field at the specified position.
+ @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
+ if <var>Index</var> don't fit range of [0..count-1]
*/
- string getUserFieldValue( [in] short nIndex )
- raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
+ string getUserFieldValue( [in] short Index )
+ raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
//-------------------------------------------------------------------------
+ /** changes the name of one of the user fields
+
+ @param Index
+ specifies the position of requested field
+ Range = [0..count-1]
- // DocMerge: from xml
+ @param Name
+ the new name for this field to be set
- // DocMerge from xml: method com::sun::star::document::XDocumentInfo::setUserFieldName
- /** changes the name of one of the user fields.
+ @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
+ if <var>Index</var> don't fit range of [0..count-1]
*/
- void setUserFieldName( [in] short nIndex,
- [in] string aName )
+ void setUserFieldName(
+ [in] short Index ,
+ [in] string Name )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
//-------------------------------------------------------------------------
+ /** changes the value of one of the user fields
+
+ @param Index
+ specifies the position of requested field
+ Range = [0..count-1]
- // DocMerge: from xml
+ @param Value
+ the new value for this field to be set
- // DocMerge from xml: method com::sun::star::document::XDocumentInfo::setUserFieldValue
- /** changes the value of the <var>nIndex</var>th user field.
+ @throws com::sun::star::lang::ArrayIndexOutOfBoundsException
+ if <var>Index</var> don't fit range of [0..count-1]
*/
- void setUserFieldValue( [in] short nIndex,
- [in] string aValue )
+ void setUserFieldValue(
+ [in] short Index ,
+ [in] string Value )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
-
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2000/12/21 08:35:05 mi
- @see interface/service/... ident -> @see ident - for new docu generator
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.2 2000/10/09 14:24:55 mi
- #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.8 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.4 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.3 2000/02/23 14:49:55 mi
- missing documentations
-
- Revision 1.2 2000/02/07 11:24:27 mi
- zu #70728# missing documentation marked
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl b/offapi/com/sun/star/document/XDocumentInfoSupplier.idl
index ac2a308810ea..c1e2066e52c5 100644
--- a/offapi/com/sun/star/document/XDocumentInfoSupplier.idl
+++ b/offapi/com/sun/star/document/XDocumentInfoSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDocumentInfoSupplier.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:54 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,62 +69,38 @@
#include <com/sun/star/document/XDocumentInfo.idl>
#endif
-
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XDocumentInfoSupplier
-/** Through this interface documents can provide a <type>DocumentInfo</type>.
+/** through this interface documents can provide a <type>DocumentInfo</type>
+
+ <p>
+ A <type>DocumentInfo</type> is available on already opened documents only
+ and must be provides by this supplier interface.
+ Instead of that you can use the service <type>StandaloneDocumentInfo</type>
+ to have access to such informations without opening the whole file.
+ It read/write parts of the document, which include the required informations,
+ only.
+ </p>
+
+ @see DocumentInfo
+ @see StandaloneDocumentInfo
*/
interface XDocumentInfoSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
+ /** provides the document information object
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XDocumentInfoSupplier::getDocumentInfo
- /** This method contains the document information object.
-
-
-
- <p>The object supports the DocumentInfo service.
-
- </p>@see DocumentInfo
+ @returns
+ an object of type <type>DocumentInfo</type>
*/
- com::sun::star::document::XDocumentInfo getDocumentInfo();
-
+ XDocumentInfo getDocumentInfo();
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2000/12/21 08:35:05 mi
- @see interface/service/... ident -> @see ident - for new docu generator
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.6 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.2 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XDocumentInsertable.idl b/offapi/com/sun/star/document/XDocumentInsertable.idl
index ead580769a04..cd6855b96e3e 100644
--- a/offapi/com/sun/star/document/XDocumentInsertable.idl
+++ b/offapi/com/sun/star/document/XDocumentInsertable.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XDocumentInsertable.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:55 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -80,23 +80,16 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XDocumentInsertable
/** makes it possible to import a document from a given URL
into this document.
*/
interface XDocumentInsertable: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XDocumentInsertable::insertDocumentFromURL
/** inserts the document that is specified by the URL.
*/
void insertDocumentFromURL( [in] string aURL,
@@ -110,24 +103,4 @@ interface XDocumentInsertable: com::sun::star::uno::XInterface
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:10 hjs
- initial import
-
- Revision 1.6 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.2 2000/08/04 15:18:44 mi
- #76800# document events
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl
index a8bed374563a..aaf7bfb14af5 100644
--- a/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl
+++ b/offapi/com/sun/star/document/XEmbeddedObjectResolver.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XEmbeddedObjectResolver.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:55 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -67,7 +67,7 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
diff --git a/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl
index 01606f452226..3e02c13a0be1 100644
--- a/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl
+++ b/offapi/com/sun/star/document/XEmbeddedObjectSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XEmbeddedObjectSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:56 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,22 +72,15 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XEmbeddedObjectSupplier
/** represents something that provides an embedded object.
*/
interface XEmbeddedObjectSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
-
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XEmbeddedObjectSupplier::getEmbeddedObject
/** returns the object which is embedded into this object.
*/
com::sun::star::lang::XComponent getEmbeddedObject();
@@ -98,27 +91,4 @@ interface XEmbeddedObjectSupplier: com::sun::star::uno::XInterface
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:11 hjs
- initial import
-
- Revision 1.7 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.3 2000/08/04 15:18:45 mi
- #76800# document events
-
- Revision 1.2 1999/11/18 11:49:55 mi
- XComponent now in module lang
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XEventBroadcaster.idl b/offapi/com/sun/star/document/XEventBroadcaster.idl
index 7fd31b4ca74c..a009067a3c41 100644
--- a/offapi/com/sun/star/document/XEventBroadcaster.idl
+++ b/offapi/com/sun/star/document/XEventBroadcaster.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XEventBroadcaster.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-06-25 15:51:19 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:03:59 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -65,50 +65,39 @@
#include <com/sun/star/uno/XInterface.idl>
#endif
-#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__
-#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
+#ifndef __com_sun_star_document_XEventListener_idl__
+#include <com/sun/star/document/XEventListener.idl>
#endif
-
//=============================================================================
- module com { module sun { module star { module document {
-
-interface XEventListener;
+module com { module sun { module star { module document {
//=============================================================================
-
/** makes it possible to register listeners which are called whenever
- a document event (see <type>EventObject</type>) occurs.
+ a document event (see <type>EventObject</type>) occurs
*/
interface XEventBroadcaster: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
+ /** registers the given listener
- /** registers the given <type>XEventListener</type>.
+ @param Listener
+ listener which is interested on such events
*/
- [oneway] void addEventListener( [in] XEventListener xListener );
+ [oneway] void addEventListener( [in] XEventListener Listener );
//-------------------------------------------------------------------------
+ /** unregisters the given listener
- /** unregisters the given <type>XEventListener</type>.
+ @param Listener
+ listener which isn't interested on such events any longer
*/
- [oneway] void removeEventListener( [in] XEventListener xListener );
+ [oneway] void removeEventListener( [in] XEventListener Listener );
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.2 2001/03/16 16:41:20 jsc
- remove interfaceheader with uik and remove [const] in method definitions
-
- Revision 1.1 2001/01/24 13:30:25 mi
- stored document events and runtime document events structurally unified
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XEventListener.idl b/offapi/com/sun/star/document/XEventListener.idl
index 4c61c6a9f7fd..f82fe08140cf 100644
--- a/offapi/com/sun/star/document/XEventListener.idl
+++ b/offapi/com/sun/star/document/XEventListener.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XEventListener.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:00 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -58,12 +58,8 @@
*
*
************************************************************************/
-#ifndef __com_sun_star_document_XDocumentEventListener_idl__
-#define __com_sun_star_document_XDocumentEventListener_idl_
-
-#ifndef __com_sun_star_uno_XInterface_idl__
-#include <com/sun/star/uno/XInterface.idl>
-#endif
+#ifndef __com_sun_star_document_XEventListener_idl__
+#define __com_sun_star_document_XEventListener_idl__
#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
@@ -78,39 +74,26 @@
module com { module sun { module star { module document {
//=============================================================================
-
/** makes it possible to register listeners, which are called whenever
- a document or document content event occurs.
+ a document or document content event occurs
+
+ <p>
+ Such events will be broadcasted by a <type>XEventBroadcaster</type>.
+ </p>
*/
interface XEventListener: com::sun::star::lang::XEventListener
{
//-------------------------------------------------------------------------
+ /** is called whenever a document event (see <type>EventObject</type>) occurs
- /** is called whenever a document event (see <type>EventObject</type>) occurs.
+ @param Event
+ specifies the event type
*/
- [oneway] void notifyEvent( [in] EventObject aEvent );
+ [oneway] void notifyEvent( [in] EventObject Event );
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2001/06/25 15:51:19 mi
- #1008# wrong references to Event
-
- Revision 1.3 2001/03/16 16:41:20 jsc
- remove interfaceheader with uik and remove [const] in method definitions
-
- Revision 1.2 2001/01/26 15:50:42 mi
- new XDocumentListener now correctly derived from lang::XEventListener
-
- Revision 1.1 2001/01/24 13:30:25 mi
- stored document events and runtime document events structurally unified
-
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XEventsSupplier.idl b/offapi/com/sun/star/document/XEventsSupplier.idl
index da5a3d73eae5..272c08b95aed 100644
--- a/offapi/com/sun/star/document/XEventsSupplier.idl
+++ b/offapi/com/sun/star/document/XEventsSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XEventsSupplier.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:01 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,48 +70,22 @@
module com { module sun { module star { module document {
//=============================================================================
-/** gives access to a list of URLs bound to events of this object.
-*/
+/** gives access to a list of URLs bound to events of this object
+ */
interface XEventsSupplier: com::sun::star::uno::XInterface
{
-//-------------------------------------------------------------------------
-/** offers a list of event handlers which are be bound to events of
- this object.
-
- @returns
- an <type>Events</type> object.
- */
-com::sun::star::container::XNameReplace getEvents();
+ //-------------------------------------------------------------------------
+ /** offers a list of event handlers which are be bound to events of
+ this object
+
+ @returns
+ an <type>Events</type> description object
+ */
+ com::sun::star::container::XNameReplace getEvents();
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.3 2001/02/15 14:14:12 mi
- workaround for wrong typedef
-
- Revision 1.2 2001/01/24 16:26:20 mi
- compiles now
-
- Revision 1.1 2001/01/24 13:21:26 mi
- stored document events and runtime document events structurally unified
-
- Revision 1.4 2001/01/23 10:08:08 mi
- optional interfaces now marked as [optional] instead of just a prosa description of this fact
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:11 hjs
- initial import
-
- Revision 1.1 2000/09/15 15:00:12 mi
- new interface XEventSupplier
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XExporter.idl b/offapi/com/sun/star/document/XExporter.idl
index f00478000ccc..46d7d76f88eb 100644
--- a/offapi/com/sun/star/document/XExporter.idl
+++ b/offapi/com/sun/star/document/XExporter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XExporter.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: arellano $ $Date: 2001-04-16 21:52:07 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:01 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,22 +74,33 @@
module com { module sun { module star { module document {
//=============================================================================
-/** makes it possible to connect a document with an <type>Exporter</type>.
+/** makes it possible to connect a document with an <type>ExportFilter</type>
+
+ <p>
+ An <type>ExportFilter</type> must know the source of his filter operation.
+ To set this on a filter is part of this interface.
+ Same mechanism exist for import too.
+ </p>
+
+ @see ExportFilter
+ @see ImportFilter
+ @see XImporter
*/
interface XExporter: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** sets the source document for the exporter.
+ /** sets the source document for the exporter
- @throws com::sun::star::lang::IllegalArgumentException
- if <var>xDoc</var> does not support any service which is
- supported by this exporter.
-
- <!-- Dennis: Is there some missing markup around com::sun::star::lang::IllegalArgumentException -->
+ @param Document
+ the source document
+ @throws com::sun::star::lang::IllegalArgumentException
+ if <var>Document</var> does not support any service which is
+ supported by this exporter
*/
- void setSourceDocument( [in] com::sun::star::lang::XComponent xDoc )
- raises( com::sun::star::lang::IllegalArgumentException );
+ void setSourceDocument(
+ [in] com::sun::star::lang::XComponent Document )
+ raises( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/XExtendedFilterDetection.idl b/offapi/com/sun/star/document/XExtendedFilterDetection.idl
index 1b2de10c5f93..9efae0ed20bb 100644
--- a/offapi/com/sun/star/document/XExtendedFilterDetection.idl
+++ b/offapi/com/sun/star/document/XExtendedFilterDetection.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XExtendedFilterDetection.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:02 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,34 +71,46 @@
//============================================================================
- module com {
- module sun {
- module star {
- module document {
+module com { module sun { module star { module document {
//============================================================================
+/** provides a "deep" filter detection
-/** extended filter detection.
- */
+ <p>
+ A "deep" filter detection means looking into the document stream to detect
+ the format of it. Services of type <type>DetectService</type> must support this
+ interface to be called from generic load mechanism of the office for that.
+ </p>
+ @see DetectService
+ @see TypeDetection
+ @see FilterFactory
+ */
interface XExtendedFilterDetection: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** controls agreement of a type detection with given URL or arguments.
+ /** controls agreement of a "flat" <type>TypeDetection</type>
+ with given URL or arguments
<p>
- Register services which support this interface for diferent mime types in configuration.
- A service which implements this interfare will be created to make a deep content detection.
- Add the collected information about detected documents in given <type>MediaDescriptor</type>.
- You need an internal type name as a return value.
+ Registerd services in configuration, which support this interface for different mime types,
+ will be called automaticly to look into the document stream and cdecide wich format it represent.
+ Add the collected information about detected documents in given <type>MediaDescriptor</type>
+ <var>Descriptor</var>. The decision must be returned as any valid type name (which specifies
+ the detected format) or an empty value for unknown formats.
</p>
+
+ @param Descriptor
+ represent a <type>MediaDescriptor</type> which can be used to get/set informations
+ about the detected document
+
+ @returns
+ an internal type name if format was detected successfully
+ <br>
+ or an empty value for an unknown document format.
*/
- string detect( [inout] sequence< com::sun::star::beans::PropertyValue > seqDescriptor );
+ string detect( [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor );
- }; // XExtendedFilterDetection
- }; // document
- }; // star
- }; // sun
-}; // com
+}; }; }; }; };
#endif
diff --git a/offapi/com/sun/star/document/XFilter.idl b/offapi/com/sun/star/document/XFilter.idl
index e459ef04f981..345561e6af89 100644
--- a/offapi/com/sun/star/document/XFilter.idl
+++ b/offapi/com/sun/star/document/XFilter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XFilter.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -71,11 +71,24 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-
-/** interface to filter documents.
+/** interface to filter documents
+
+ <p>
+ This interface will be used by service <type>ImportFilter</type> or
+ <type>ExportFilter</type> to supports loading/saving of documents with
+ different formats. The target/source of such filter operations must
+ well known BEFORE filtering will be started.
+ (see <type>XImporter</type> and <type>XExporter</type> too)
+ Otherwise this interface can't work right.
+ <p>
+
+ @see ImportFilter
+ @see ExportFilter
+ @see XImporter
+ @see XExporter
*/
interface XFilter: com::sun::star::uno::XInterface
{
@@ -86,13 +99,9 @@ interface XFilter: com::sun::star::uno::XInterface
The given <type>MediaDescriptor</type> holds all neccessary information
about the document.
- @attention Don't hold hard references to these descriptors. You must copy needed informations!
- Otherwise we couldn't destroy (for example) an existing input stream!
+ Don't hold hard references to these descriptors. You must copy needed informations!
+ Otherwise we couldn't destroy (for example) an existing input stream!
</p>
-
- <!-- Dennis: The HTML output of @attention does not appear correct -->
-
-
*/
boolean filter( [in] sequence< com::sun::star::beans::PropertyValue > aDescriptor );
diff --git a/offapi/com/sun/star/document/XGraphicObjectResolver.idl b/offapi/com/sun/star/document/XGraphicObjectResolver.idl
index 00acd1aa030f..4f001edcd1cd 100644
--- a/offapi/com/sun/star/document/XGraphicObjectResolver.idl
+++ b/offapi/com/sun/star/document/XGraphicObjectResolver.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XGraphicObjectResolver.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -67,7 +67,7 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
diff --git a/offapi/com/sun/star/document/XImporter.idl b/offapi/com/sun/star/document/XImporter.idl
index 2405ee295e76..c85966007a50 100644
--- a/offapi/com/sun/star/document/XImporter.idl
+++ b/offapi/com/sun/star/document/XImporter.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XImporter.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:05 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,19 +74,33 @@
module com { module sun { module star { module document {
//=============================================================================
-/** makes it possible to connect a document with an <type>Importer</type>.
+/** makes it possible to connect a document with an <type>ImportFilter</type>
+
+ <p>
+ An <type>ImportFilter</type> must know the target of his filter operation.
+ To set this on a filter is part of this interface.
+ Same mechanism exist for export too.
+ </p>
+
+ @see ExportFilter
+ @see ImportFilter
+ @see XExporter
*/
interface XImporter: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** sets the target document for the importer.
+ /** sets the target document for the importer
+
+ @param Document
+ the target document
@throws com::sun::star::lang::IllegalArgumentException
- if <var>xDoc</var> does not support any service which is
- supported by this importer.
+ if <var>Document</var> does not support any service which is
+ supported by this importer
*/
- void setTargetDocument( [in] com::sun::star::lang::XComponent xDoc )
- raises( com::sun::star::lang::IllegalArgumentException );
+ void setTargetDocument(
+ [in] com::sun::star::lang::XComponent Document )
+ raises( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/XInteractionFilterSelect.idl b/offapi/com/sun/star/document/XInteractionFilterSelect.idl
index 168e92ad17fe..2c7769a1ad7b 100644
--- a/offapi/com/sun/star/document/XInteractionFilterSelect.idl
+++ b/offapi/com/sun/star/document/XInteractionFilterSelect.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XInteractionFilterSelect.idl,v $
*
- * $Revision: 1.1 $
+ * $Revision: 1.2 $
*
- * last change: $Author: as $ $Date: 2001-11-08 11:55:11 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:06 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,10 +70,41 @@
module com { module sun { module star { module document {
//=============================================================================
-interface XInteractionFilterSelect : ::com::sun::star::task::XInteractionContinuation
+/** continuation used by interaction mechanism at filter detection during
+ loading documents
+
+ <p>
+ If during loading time the filter can't be detected and wasn't given at calling time,
+ a possible <type scope="com::sun::star::task">InteractionHandler</type> will be used.
+ (it's a a part of used <type>MediaDescriptor</type>)
+ A <type>NoSuchFilterRequest</type> will be used then to start right interaction on that to
+ get a decision wich filter should be used for given URL. A possible continiuation
+ of that can be this XInteractionFilterSelect. It will transport the decision back to
+ generic filter detection and force using of it. Of course it's possible to abort
+ the loading process by use another continuation <type scope="com::sun::star::task">XInteractionAbort</type>.
+ </p>
+
+ @see MediaDescriptor
+ @see com::sun::star::task::InteractionHandler
+ @see NoSuchFilterRequest
+ @see com::sun::star::task::XInteractionAbort
+ */
+interface XInteractionFilterSelect : com::sun::star::task::XInteractionContinuation
{
- void setFilter( [in] string sName );
- string getFilter( );
+ //-------------------------------------------------------------------------
+ /** used by interaction to set selected filter
+
+ <p>
+ This value must be save till another one will be set
+ and must be provided on getFilter() for interest users.
+ </p>
+ */
+ void setFilter( [in] string Name );
+
+ //-------------------------------------------------------------------------
+ /** used by detection to get selected filter
+ */
+ string getFilter();
};
//=============================================================================
diff --git a/offapi/com/sun/star/document/XLinkTargetSupplier.idl b/offapi/com/sun/star/document/XLinkTargetSupplier.idl
index 2dce2bd25c8a..5b56407d4cda 100644
--- a/offapi/com/sun/star/document/XLinkTargetSupplier.idl
+++ b/offapi/com/sun/star/document/XLinkTargetSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XLinkTargetSupplier.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:08 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,30 +72,21 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XLinkTargetSupplier
/** interface is supplied by objects inside a document object model that have
children that can be the target of a link inside a document.
-
- <p>These targets implement the service <type>LinkTarget</type>
- </p>
+ <p>These targets implement the service <type>LinkTarget</type>. </p>
*/
interface XLinkTargetSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
-
- // DocMerge: from idl
-
- // DocMerge from idl: method com::sun::star::document::XLinkTargetSupplier::getLinks
- /** @returns the names of possible links to children of this object inside
- a document object model. It implements the service
- <type>LinkTargets</type>.
+ /** @returns
+ the names of possible links to children of this object inside a
+ document object model. It implements the service <type>LinkTargets</type>.
*/
com::sun::star::container::XNameAccess getLinks();
@@ -105,27 +96,4 @@ interface XLinkTargetSupplier: com::sun::star::uno::XInterface
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2001/03/16 16:41:20 jsc
- remove interfaceheader with uik and remove [const] in method definitions
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.1.1.1 2000/09/18 23:35:11 hjs
- initial import
-
- Revision 1.6 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.2 2000/08/04 15:18:45 mi
- #76800# document events
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XMimeTypeInfo.idl b/offapi/com/sun/star/document/XMimeTypeInfo.idl
index 47a9951b11de..70ce0537080c 100644
--- a/offapi/com/sun/star/document/XMimeTypeInfo.idl
+++ b/offapi/com/sun/star/document/XMimeTypeInfo.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XMimeTypeInfo.idl,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:09 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -72,20 +72,20 @@ module com { module sun { module star { module document {
//=============================================================================
-/** provides information regarding which Mime types are supported by a filter
+/** provides information regarding which MIME types are supported by a filter.
*/
interface XMimeTypeInfo: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** asks whether a Mime type is supported or not.
+ /** asks whether a MIME type is supported or not.
*/
boolean supportsMimeType( [in] string MimeTypeName );
//-------------------------------------------------------------------------
/** @returns
- a sequence of the names of all supported Mime types.
+ a sequence of the names of all supported MIME types.
*/
sequence<string> getSupportedMimeTypeNames();
};
diff --git a/offapi/com/sun/star/document/XRedlinesSupplier.idl b/offapi/com/sun/star/document/XRedlinesSupplier.idl
index 7d3fe4c9b0ad..ba187615b40c 100644
--- a/offapi/com/sun/star/document/XRedlinesSupplier.idl
+++ b/offapi/com/sun/star/document/XRedlinesSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XRedlinesSupplier.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:10 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -67,7 +67,7 @@
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
@@ -76,7 +76,8 @@
interface XRedlinesSupplier: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** returns an enumeration access that provides access to the redline objects of the document.
+ /** @returns
+ an enumeration access that provides access to the redline objects of the document.
*/
com::sun::star::container::XEnumerationAccess getRedlines();
};
diff --git a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl b/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
index f79f0ed1a131..cb72303a9858 100644
--- a/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
+++ b/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XStandaloneDocumentInfo.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:20 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:11 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,98 +69,69 @@
#include <com/sun/star/io/IOException.idl>
#endif
-
//=============================================================================
- module com { module sun { module star { module document {
+module com { module sun { module star { module document {
//=============================================================================
-
-// DocMerge: from xml
-
-// DocMerge from xml: interface com::sun::star::document::XStandaloneDocumentInfo
/** makes it possible to load document information from
a resource specified by a URL and to store it into a resource also
- specified by a URL.
-
-
-
- <p>Only the document information part of the resource is transferred. </p>@see DocumentInfo
- @see XDocumentInfo
- @see com::sun::star::beans::XPropertySet
- @see com::sun::star::beans::XFastPropertySet
+ specified by a URL
+
+ <p>
+ Only the document information part of the resource is transferred.
+ Instead of <type>DocumentInfo</type> not the whole document will be opened.
+ Note: Without specifying the source or target of this info (the document)
+ nothing can work and will be handled as void (for reading) or ignored (for writing).
+ After specigiying the source/target by using this interface,
+ the interface <type>XDocumentInfo</type> (which must be implemented on same
+ object then this one!) provides access to the info properties.
+ </p>
+
+ @see DocumentInfo
+ @see StandaloneDocumentInfo
+ @see XDocumentInfo
*/
-interface XStandaloneDocumentInfo: com::sun::star::document::XDocumentInfo
+interface XStandaloneDocumentInfo: XDocumentInfo
{
//-------------------------------------------------------------------------
+ /** loads the document information from a file referred by an URL
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XStandaloneDocumentInfo::loadFromURL
- /** This method loads the document information from a file referred by a URL.
-
-
-
- <p>After an unsuccessful call the contents of the document
- information are undefined.
-
+ <p>
+ After an unsuccessful call the contents of the document
+ information are undefined (void).
+ This method only works for storage file formats.
</p>
- <p>This method only works for storage file formats.
- </p>
+ @param URL
+ specifies the source of information
+
+ @throws com::sun::star::io::IOException
+ if storage couldn't be found or opened
*/
- void loadFromURL( [in] string aURL )
- raises( com::sun::star::io::IOException );
+ void loadFromURL( [in] string URL )
+ raises( com::sun::star::io::IOException );
//-------------------------------------------------------------------------
+ /** stores the document information into a file referred by a URL
- // DocMerge: from xml
-
- // DocMerge from xml: method com::sun::star::document::XStandaloneDocumentInfo::storeIntoURL
- /** This method stores the document information into a file referred by a URL.
-
-
-
- <p>Only the document information part of the document is overwritten.
-
+ <p>
+ Only the document information part of the document is overwritten.
+ This method only works for storage file formats.
</p>
- <p>This method only works for storage file formats.
- </p>
- */
- void storeIntoURL( [in] string aURL )
- raises( com::sun::star::io::IOException );
+ @param URL
+ specifies the target for saving
+ @throws com::sun::star::io::IOException
+ if storage couldn't be found or opened
+ */
+ void storeIntoURL( [in] string URL )
+ raises( com::sun::star::io::IOException );
};
//=============================================================================
}; }; }; };
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2000/12/21 08:35:05 mi
- @see interface/service/... ident -> @see ident - for new docu generator
-
- Revision 1.3 2000/11/08 12:42:40 mi
- moved from api
-
- Revision 1.2 2000/10/09 14:24:55 mi
- #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
-
- Revision 1.1.1.1 2000/09/18 23:35:11 hjs
- initial import
-
- Revision 1.6 2000/09/11 11:52:19 mi
- documentation merged from XML
-
- Revision 1.2 2000/08/04 15:18:45 mi
- #76800# document events
-
- Revision 1.1.1.1 1999/11/11 09:48:42 jsc
- new
-
-
-=============================================================================*/
#endif
diff --git a/offapi/com/sun/star/document/XTypeDetection.idl b/offapi/com/sun/star/document/XTypeDetection.idl
index 473fc169067e..610194cc76e7 100644
--- a/offapi/com/sun/star/document/XTypeDetection.idl
+++ b/offapi/com/sun/star/document/XTypeDetection.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XTypeDetection.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mi $ $Date: 2001-10-25 07:52:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:12 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -74,33 +74,81 @@
module com { module sun { module star { module document {
//============================================================================
+/** support "flat" and "deep" type detection of a given document
-/** support "flat" and "deep" type detection of a given document.
+ <p>
+ A "flat" detection means specifying the document format by using
+ the URL and some configuration data only. That will perform but produce
+ may invalid results if e.g., the extension of the document is wrong.
+ A "deep" detection means looking into the document stream to be right
+ which format it supports. Of course that includes a "flat" detection before.
+ The combination of both ones should produce stable results everytime.
+ </p>
+
+ @see TypeDetection
*/
interface XTypeDetection: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
- /** return internal type name which is suitable to given URL
+ /** make a "flat" detection by using the URL of the document
<p>
- We make a "flat" type detection only.
+ It use given URL in combination with the internal configuration of well known
+ types only to specify the format of given document.
</p>
+
+ @param URL
+ specify the document by name
+
+ @returns
+ an internal type name which represent the detected format
+ <br>
+ or an empty value for unknown ones
*/
- string queryTypeByURL( [in] string sURL );
+ string queryTypeByURL( [in] string URL );
//-------------------------------------------------------------------------
- /** return internal type name which is suitable to given document properties
- by a <type>MediaDescriptor</type>
+ /** make a "deep" detection or optional a "flat" detection by using a
+ <type>MediaDescriptor</type>
<p>
- These do the same as "queryTypeByURL()" before.
- As an additional feature, you can specify more document properties
- and select the detection mode. Available modes are "flat" (bDeep=FALSE)
- and "deep" (bDeep=TRUE) detection.
+ Instead of <member>XTypeDetection::queryTypeByURL()</member> this function
+ use a <type>MediaDescriptor</type> to specify the document for detection.
+ Such descriptor hold different informations about the document.
+ He will be passed to any part of made detection process and every part
+ can change it to actualize it.
+ The property <member>MediaDescriptor::URL</member> should be set on
+ this descriptor as minimum. It specifies the location of the document.
+ If this parameter is missing another one is required: <member>MediaDescriptor::InputStream</member>.
+ This can be usefull to prevent operaton against multiple opening of the stream
+ and perform the operation. If this stream isn't already included the detection
+ will open it (if allowed!) and add it to the descriptor so it will be available for
+ all following parts.
+ A combination of both parameters can be usefull to perform the operation
+ and make results more stable; but only one of them is required.
+ Of course its possible to specify more document properties (e.g.
+ <member>MediaDescriptor::ReadOnly</member>).
+ <br>
+ As an additional feature it's possible to suppress "deep" detection by using argument
+ <var>AllowDeep</var>.
</p>
+
+ @param Descriptor
+ means the <type>MediaDescriptor</type> which specify the ressource for detection
+
+ @param AllowDeep
+ if it is set to <TRUE/> a "deep" detection will be follow a "flat" detection
+ <br>
+ if it is set to <FALSE/> a "flat" detection will be made only
+
+ @returns
+ an internal type name which represent the detected format
+ <br>
+ or an empty value for unknown ones
*/
- string queryTypeByDescriptor( [inout] sequence< com::sun::star::beans::PropertyValue > aDescriptor ,
- [in] boolean bDeep );
+ string queryTypeByDescriptor(
+ [inout] sequence< com::sun::star::beans::PropertyValue > Descriptor,
+ [in] boolean AllowDeep );
};
//============================================================================
diff --git a/offapi/com/sun/star/document/XViewDataSupplier.idl b/offapi/com/sun/star/document/XViewDataSupplier.idl
index 1a0fb3dc9ab6..6c7329e1fa8d 100644
--- a/offapi/com/sun/star/document/XViewDataSupplier.idl
+++ b/offapi/com/sun/star/document/XViewDataSupplier.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XViewDataSupplier.idl,v $
*
- * $Revision: 1.3 $
+ * $Revision: 1.4 $
*
- * last change: $Author: mba $ $Date: 2001-03-22 16:13:58 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:04:13 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,26 +70,37 @@
module com { module sun { module star { module document {
//=============================================================================
-/** Gives access to some properties describing all open views to a document.
- Each view is described by a sequence < ::com::sun::star::beans::PropertyValue >.
+/** gives access to some properties describing all open views to a document
+
+ <p>
+ Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >.
Through this interface the state of all open views can be retrieved and restored
later. These states can also be made persistent so that a document loader can create
all views of the correct types and restore their state to the state when the document was
saved.
-*/
-
+ </p>
+ */
interface XViewDataSupplier: com::sun::star::uno::XInterface
{
- /** @returns
- a < ::com::sun::star::container::XIndexAccess >, that gives
- access to a sequence < ::com::sun::star::beans::PropertyValue >
- for every open view
+ //-------------------------------------------------------------------------
+ /** retrieve informations about currently opened view to restore it later
+
+ @returns
+ a <type scope="com::sun::star::container">XIndexAccess</type>,
+ that gives access to a list of <type scope="com::sun::star::beans">PropertyValue</type>
+ for every open view. May <NULL/> if no view is currently available.
*/
- ::com::sun::star::container::XIndexAccess getViewData();
+ ::com::sun::star::container::XIndexAccess getViewData();
+
+ //-------------------------------------------------------------------------
+ /** restore all views which will be represented by given data argument
- /**
+ @param Data
+ a list of <type scope="com::sun::star::beans">PropertyValue</type>s
+ with information about last opened views to restore it
+ <NULL/> isn't allowed here.
*/
- void setViewData( [in] ::com::sun::star::container::XIndexAccess aData );
+ void setViewData( [in] com::sun::star::container::XIndexAccess Data );
};
//=============================================================================