From 65b469fc08caaa6ad486273cb37011522716a9f9 Mon Sep 17 00:00:00 2001 From: Kai Sommerfeld Date: Thu, 22 Feb 2001 08:48:32 +0000 Subject: Documentation. --- offapi/com/sun/star/ucb/CachedContentResultSet.idl | 14 +++++------ offapi/com/sun/star/ucb/Content.idl | 12 ++++----- offapi/com/sun/star/ucb/ContentEvent.idl | 9 ++++--- offapi/com/sun/star/ucb/ContentInfo.idl | 17 +++++++------ offapi/com/sun/star/ucb/ListActionType.idl | 29 ++++++++++++---------- offapi/com/sun/star/ucb/OpenCommandArgument.idl | 20 ++++++++------- offapi/com/sun/star/ucb/OpenCommandArgument2.idl | 6 ++--- offapi/com/sun/star/ucb/OpenMode.idl | 11 ++++---- offapi/com/sun/star/ucb/Store.idl | 8 +++--- .../com/sun/star/ucb/TransferCommandOperation.idl | 8 +++--- offapi/com/sun/star/ucb/UniversalContentBroker.idl | 21 ++++++++-------- .../sun/star/ucb/WelcomeDynamicResultSetStruct.idl | 6 ++--- offapi/com/sun/star/ucb/XCommandEnvironment.idl | 10 +++----- offapi/com/sun/star/ucb/XContentCreator.idl | 8 +++--- .../com/sun/star/ucb/XContentProviderManager.idl | 22 ++++++++-------- 15 files changed, 102 insertions(+), 99 deletions(-) (limited to 'offapi/com/sun') diff --git a/offapi/com/sun/star/ucb/CachedContentResultSet.idl b/offapi/com/sun/star/ucb/CachedContentResultSet.idl index 69cbccc55d3b..a5c62c52b6df 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedContentResultSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,14 +99,14 @@ service CachedContentResultSet //------------------------------------------------------------------------- /** contains the direction for fetching rows from an underlying database. -

could contain a value of constants group - FetchDirection. +

The value can be one of the + FetchDirection constants group.

The default value is implementation specific. -

If you set FetchDirection to UNKNOWN, an implementation - specific FetchDirection will be - used. +

If you set the value to + FetchDirection::UNKNOWN an + implementation specific direction will be used. */ [property] long FetchDirection; }; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index 78d6b12268ea..352d70c39514 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -2,9 +2,9 @@ * * $RCSfile: Content.idl,v $ * - * $Revision: 1.11 $ + * $Revision: 1.12 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -190,7 +190,7 @@ service Content // contained, that are unknown to the content! void setPropertyValues - sequence< PropertyValue < aValues + sequence< PropertyValue > aValues ----------------------------------------------------------------------- Optional commands: @@ -318,8 +318,8 @@ service Content // Important note: A client that wants to transfer data should // not execute this command, but it should execute the command - // "globalTransfer" at the/ UniversalContentBroker - // instance. This command is able to transfer all kind of content + // "globalTransfer" at the UniversalContentBroker. + // This command is able to transfer all kind of content // supported by that UCB. // // This command transfers (copies/moves) an object from one location @@ -631,7 +631,7 @@ service Content //------------------------------------------------------------------------- /** creates new contents (i.e. creates a new folder in another folder somewhere in the local file system). - * +

A content is "new", if it does not physically exist before creating it using this interface. diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index eca0de0aed0b..4da015690be9 100644 --- a/offapi/com/sun/star/ucb/ContentEvent.idl +++ b/offapi/com/sun/star/ucb/ContentEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,8 +85,9 @@ struct ContentEvent: com::sun::star::lang::EventObject long Action; //------------------------------------------------------------------------- - /** The content the action is related to (e.g., the content that was just - physically destroyed, the content just inserted into a folder content). + /** The content to that the action is related (e.g., the content that was + just physically destroyed, the content that was just inserted into a + folder content).

This member must be filled as follows: diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index ef04d1db7a7a..e3c3857fc9f6 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentInfo.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,8 +90,8 @@ struct ContentInfo //------------------------------------------------------------------------- /** Additional attributes. -

These flags contain extra information on the content, like it's kind - ( KIND_FOLDER, KIND_DOCUMENT, KIND_LINK ). +

These flags contain extra information on the content, like its kind + (KIND_FOLDER, KIND_DOCUMENT, KIND_LINK).

It is highly recommended to fill these flags very accurately, as they are very important when transferring contents between different @@ -106,17 +106,18 @@ struct ContentInfo /** This field contains a list with the properties which must be set at a content that was just created using XContentCreator::createNewContent before it can be - committed ( via executing the command "insert" at the new content ). - If one of the properties is missing, the insert command will fail. + committed (by executing the command "insert" at the new content). + +

If one of the properties is missing, the insert command will fail.

In example, a new file system folder content will need a title. The Properties member of the ContentInfo provided for this kind of content must include the property "Title".

Important: The required properties must have one of the - following basic data types ( in order to make it possible to implement + following basic data types (in order to make it possible to implement client applications with a small set of generic input methods for the - values ): + values):

-

A <scheme>: matches any URL of exactly the given +

A <scheme>: matches any URL of exactly the given scheme (ignoring case), keeping the extension from URL schemes to URL - templates backwards compatible. The <simple>: + templates backwards compatible. The <simple>: regexps match any URL starting with a given string literal, followed - by arbitrary characters (<simple-prefix>:), or + by arbitrary characters (<simple-prefix>:), or by arbitrary characters that start with one of '/', '?', or '#', if any - (<simple-authority>:), or by arbitrary characters not + (<simple-authority>:), or by arbitrary characters not including any of '/', '?', or '#', followed by a given string literal, followed by arbitrary characters that start with one of '/', '?', or '#', if any. The comparision of string literals is done ignoring the - case of ASCII letters. The <translation>: regexps - match the same URLs as their <simple>: counterparts, + case of ASCII letters. The <translation>: regexps + match the same URLs as their <simple>: counterparts, but they also describe how a (local) URL is mapped to another (remote) URL. This mapping is only relevant for methods of the RemoteAccessContentProvider's XParameterizedContentProvider interface; in all other - cases, <translation>: regexps have the same semantics - as their <simple>: counterparts. + cases, <translation>: regexps have the same semantics + as their <simple>: counterparts. @param ReplaceExisting : replace the provider possibly registered for the given URL -- cgit