diff --git a/offapi/com/sun/star/ucb/Command.idl b/offapi/com/sun/star/ucb/Command.idl index f4e3b7151fb5..6421f7b0b055 100644 --- a/offapi/com/sun/star/ucb/Command.idl +++ b/offapi/com/sun/star/ucb/Command.idl @@ -2,9 +2,9 @@ * * $RCSfile: Command.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,22 +72,25 @@ module com { module sun { module star { module ucb { //============================================================================= /** contains a command. + + @see XCommandProcessor */ struct Command { //------------------------------------------------------------------------- - /** contains the name of a command. + /** contains the name of the command. */ string Name; //------------------------------------------------------------------------- - /** contains an implementation-specific handle for the command. - It may be -1 if the implementation has no handle. + /** contains an implementation specific handle for the command. + +

It may be -1 if the implementation has no handle. */ long Handle; //------------------------------------------------------------------------- - /** contains the argument of a command + /** contains the argument of the command */ any Argument; diff --git a/offapi/com/sun/star/ucb/CommandInfo.idl b/offapi/com/sun/star/ucb/CommandInfo.idl index 780298c45d73..3320cc705f5c 100644 --- a/offapi/com/sun/star/ucb/CommandInfo.idl +++ b/offapi/com/sun/star/ucb/CommandInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: CommandInfo.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2001-01-31 09:57:00 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** describes a command. + + @see XCommandProcessor */ struct CommandInfo { @@ -81,8 +83,9 @@ struct CommandInfo string Name; //------------------------------------------------------------------------- - /** contains an implementation-specific handle for the command. - It may be -1 if the implementation has no handle. + /** contains an implementation specific handle for the command. + +

It may be -1 if the implementation has no handle. */ long Handle; diff --git a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl index 543856d35045..38f44e5f3d88 100644 --- a/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl +++ b/offapi/com/sun/star/ucb/CommandInfoChangeEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: CommandInfoChangeEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,7 +73,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** This event gets delivered whenever a XCommandInfo is changed. -

A CommandInfoChangeEvent object is sent to +

A CommandInfoChangeEvent object is sent to XCommandInfoChangeListeners. */ struct CommandInfoChangeEvent: com::sun::star::lang::EventObject @@ -86,14 +86,14 @@ struct CommandInfoChangeEvent: com::sun::star::lang::EventObject //------------------------------------------------------------------------- /** contains the implementation handle for the command. -

May be -1 if the implementation has no handle. +

May be -1 if the implementation has no handle. */ long Handle; //------------------------------------------------------------------------- /** contains the reason for the event. - @see CommandInfoChange +

The value can be one of the CommandInfoChange constants. */ long Reason; }; diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index c3f4ea6d5cf6..eca0de0aed0b 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ struct ContentEvent: com::sun::star::lang::EventObject //------------------------------------------------------------------------- /** The action. - @see ContentAction +

The value can be one of the ContentAction constants. */ long Action; @@ -88,13 +88,26 @@ struct ContentEvent: com::sun::star::lang::EventObject /** The content the action is related to (e.g., the content that was just physically destroyed, the content just inserted into a folder content). - This member must be filled as follows: +

This member must be filled as follows: - ContentAction::INSERTED - The content inserted into a folder. - ContentAction::REMOVED - The content removed from a folder. - ContentAction::DELETED - The deleted content. - ContentAction::EXCHANGED - The exchanged content (that already has - the new content id). + + + + + + + + + + + + + + + + + +
ContentAction::INSERTEDThe content inserted into a folder
ContentAction::REMOVEDThe content removed from a folder
ContentAction::DELETEDThe deleted content
ContentAction::EXCHANGEDThe exchanged content (that already has the new content id)
*/ XContent Content; @@ -103,15 +116,26 @@ struct ContentEvent: com::sun::star::lang::EventObject notified (e.g., the id of the folder content into which another content was inserted). - This member must be filled as follows: +

This member must be filled as follows: - ContentAction::INSERTED - Id of the folder the content was - inserted into. - ContentAction::REMOVED - Id of the folder the content was - removed from. - ContentAction::DELETED - Id of the deleted content. - ContentAction::EXCHANGED - Previous(!) id of the exchanged - content. + + + + + + + + + + + + + + + + + +
ContentAction::INSERTEDId of the folder the content was inserted into
ContentAction::REMOVEDId of the folder the content was removed from
ContentAction::DELETEDId of the deleted content
ContentAction::EXCHANGEDPrevious(!) id of the exchanged content
*/ XContentIdentifier Id; }; diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index 05ff9375c49d..ef04d1db7a7a 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-01-31 08:22:51 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,11 @@ struct ContentInfo { //------------------------------------------------------------------------- /** A type identifier string for a content. + +

This is an implementation specific string characterizing the + kind of a content (e.g. "application/vnd.sun.star.hierarchy-link"). + The value of this member should match the value returned by + XContent::getContentType of an appropriate content. */ string Type; @@ -86,9 +91,11 @@ struct ContentInfo /** Additional attributes.

These flags contain extra information on the content, like it's 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 Content Providers. + ( 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 + ContentProviders.

The value can be one of the ContentInfoAttribute constants. diff --git a/offapi/com/sun/star/ucb/CrossReference.idl b/offapi/com/sun/star/ucb/CrossReference.idl index f7850e6db324..4e1e937f14f4 100644 --- a/offapi/com/sun/star/ucb/CrossReference.idl +++ b/offapi/com/sun/star/ucb/CrossReference.idl @@ -2,9 +2,9 @@ * * $RCSfile: CrossReference.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,19 +67,21 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct contains information describing a cross-reference. Such - references are kept by news servers for managing articles contained in - multiple groups. An article can have a sequence of cross-references. +/** This struct contains information describing a cross reference. + +

Such references are kept by news servers for managing articles + contained in multiple groups. An article can have a sequence of + cross references. */ struct CrossReference { //------------------------------------------------------------------------- - /** the name of a news group. + /** The name of a news group. */ string Group; //------------------------------------------------------------------------- - /**the unique identifier (relative to the server) of an article in the + /** The unique identifier (relative to the server) of an article in the given group. */ long Id; diff --git a/offapi/com/sun/star/ucb/DocumentHeaderField.idl b/offapi/com/sun/star/ucb/DocumentHeaderField.idl index 7abfa5f3178f..bebec24b4602 100644 --- a/offapi/com/sun/star/ucb/DocumentHeaderField.idl +++ b/offapi/com/sun/star/ucb/DocumentHeaderField.idl @@ -2,9 +2,9 @@ * * $RCSfile: DocumentHeaderField.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,18 +67,18 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct contains a name-value pair of a document header (i.e. +/** This struct contains a name-value pair of a document header (i.e. the "subject" field and the appropriate value of a MIME message). */ struct DocumentHeaderField { //------------------------------------------------------------------------- - /** the name of the header field. + /** The name of the header field. */ string Name; //------------------------------------------------------------------------- - /** the value of the header field. + /** The value of the header field. */ string Value; diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index bd599ad1e8f9..521f2244750b 100644 --- a/offapi/com/sun/star/ucb/FetchResult.idl +++ b/offapi/com/sun/star/ucb/FetchResult.idl @@ -2,9 +2,9 @@ * * $RCSfile: FetchResult.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,8 +66,10 @@ module com { module sun { module star { module ucb { //============================================================================= -/** containes data of several rows. -This struct is returned e.g. from XFetchProvider::fetch. +/** containes data of several rows of a ContentResultSet. + +

This struct is returned from XFetchProvider::fetch, + for example. */ struct FetchResult @@ -75,35 +77,35 @@ struct FetchResult //------------------------------------------------------------------------- /** containes the demanded data. -

One any contains the data of one whole row. - Those methods which use this struct have to specify, - what the any has to contain. +

One any contains the data of one whole row. Those methods which + use this struct have to specify, what the any has to contain. */ sequence< any > Rows; //------------------------------------------------------------------------- /** indicates the index of the first in Rows contained - row in the original result set. So if StartIndex equals 3, - the first element in the sequence Rows containes the data - of the index 3 in the original result set. + row in the original resultset. So if StartIndex + equals 3, the first element in the sequence + Rows containes the data of the index 3 + in the original resultset. -

The following rows are one after the other, but the direction depends on - Direction +

The following rows are one after the other, but the direction + depends on the value of Direction */ long StartIndex; //------------------------------------------------------------------------- /** indicates the orientation in which the rows are fetched and set into - the sequence Rows. + the sequence Rows. -

When Orientation equals TRUE, rows in - Rows are ordered in the same way as in the original result - set. +

When Orientation equals , the rows in + Rows are ordered in the same way as in the original + resultset. */ boolean Orientation; //------------------------------------------------------------------------- - /** indicates whether and which error has occured, while fetching. + /** indicates whether and which error has occured, while fetching.

The value may contain zero or more constants of the FetchError constants group. diff --git a/offapi/com/sun/star/ucb/FolderList.idl b/offapi/com/sun/star/ucb/FolderList.idl index f3e8b5dead16..479686bc2d4c 100644 --- a/offapi/com/sun/star/ucb/FolderList.idl +++ b/offapi/com/sun/star/ucb/FolderList.idl @@ -2,9 +2,9 @@ * * $RCSfile: FolderList.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,8 +85,8 @@ struct FolderList FolderListCommand Command; //------------------------------------------------------------------------- - /** The list of folders (only used in conjunction with the - FolderListCommand SET). + /** The list of folders (only used in conjunction with + FolderListCommand::SET). */ sequence List; }; diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index 6feadb841a2f..7e1c2d6d8f83 100644 --- a/offapi/com/sun/star/ucb/FolderListEntry.idl +++ b/offapi/com/sun/star/ucb/FolderListEntry.idl @@ -2,9 +2,9 @@ * * $RCSfile: FolderListEntry.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * 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 ucb { //============================================================================= -/** Information about a single folder in a folder list. +/** Information about a single folder in a FolderList. */ struct FolderListEntry { @@ -100,7 +100,7 @@ struct FolderListEntry //------------------------------------------------------------------------- /** The folder shall be purged (only used in conjunction with the - FolderListCommand SET). + FolderListCommand::SET). */ boolean Purge; }; diff --git a/offapi/com/sun/star/ucb/InsertCommandArgument.idl b/offapi/com/sun/star/ucb/InsertCommandArgument.idl index a506adf147d9..397e4e3c164f 100644 --- a/offapi/com/sun/star/ucb/InsertCommandArgument.idl +++ b/offapi/com/sun/star/ucb/InsertCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: InsertCommandArgument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,21 +75,26 @@ module com { module sun { module star { module ucb { //============================================================================= /** The argument for the command "insert". + + @see XCommandProcessor */ struct InsertCommandArgument { //------------------------------------------------------------------------- - /** A stream containing document data. This member can be left blank, - if no (new) document data shall be written by the implementation of - the "insert" command. + /** A stream containing document data. + +

This member can be left blank, if no (new) document data shall be + written by the implementation of the "insert" command. */ com::sun::star::io::XInputStream Data; //------------------------------------------------------------------------- - /** A flag indicating whether a possibly existing content ( and its data ) - shall be overwritten. Implementations that are not able to detect - whether there are previous data may ignore this parameter and will - always write the new data. + /** A flag indicating whether a possibly existing content (and its data) + shall be overwritten. + +

Implementations that are not able to detect whether there are + previous data may ignore this parameter and will always write the + new data. */ boolean ReplaceExisting; }; diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 86c0d392c116..16d663b3eeaa 100644 --- a/offapi/com/sun/star/ucb/ListAction.idl +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListAction.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,24 +68,25 @@ module com { module sun { module star { module ucb { //============================================================================= /** This struct contains information needed in the notifications of a -XDynamicResultSet + XDynamicResultSet. -@see ListEvent + @see ListEvent */ struct ListAction { //------------------------------------------------------------------------- - /** The position where something has happened ( index begins with 1 as - usual with JDBC ). - Its value does not necessary indicate the new position in the new - XResultSet, but a position while doing the changes step by - step beginning with the old XResultSet. + /** The position where something has happened (index begins with + 1 as usual with JDBC ). + +

Its value does not necessary indicate the new position in the new + XResultSet, but a position while doing the changes step by + step beginning with the old XResultSet. */ long Position; //------------------------------------------------------------------------- - /** The Count of involved rows. + /** The count of involved rows. */ long Count; @@ -93,16 +94,8 @@ struct ListAction //------------------------------------------------------------------------- /** specifies the kind of modification happened to all assigned rows. -

The ListAction::ListActionType must contain a - constant of the ListActionType constants group. - -

ListActions with different contents of - ListAction::ListActionType need or can contain - different values for ListAction::Position, - ListAction::Count and - ListAction::ActionInfo: - -

So this member is to be filled as follows: +

The value of the other members of this struct depend on the value + of this member: @@ -110,46 +103,46 @@ struct ListAction - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - - - - - - + + + +
ListActionTypeCount ActionInfo




WELCOMEn/an/aWelcomeDynamicResultSetStruct required
WELCOMEuselessuselesstype WelcomeDynamicResultSetStruct required
CLEAREDn/an/an/a
CLEAREDuselessuselessuseless
INSERTEDrequired 1-xrequired 1-xallowed but not required... @todo
INSERTEDrequired 1-xrequired 1-xallowed but not required... @todo
REMOVEDrequired 1-xrequired 1-xn/a
REMOVEDrequired 1-xrequired 1-xuseless
MOVEDrequired 1-xrequired 1-xtype long required
MOVEDrequired 1-xrequired 1-xtype long required
PROPERTIES_CHANGEDrequired 1-xrequired 1-xallowed but not required... @todo
PROPERTIES_CHANGEDrequired 1-xrequired 1-xallowed but not required... @todo
+ +

The value for this member can be one of the + ListActionType constants group. */ long ListActionType; //------------------------------------------------------------------------- /** dependend on the content of ListAction::ListActionType the ListAction::ActionInfo could contain additional - information about the changes happened ( see table above ). + information about the changes happened (see table above). */ any ActionInfo; diff --git a/offapi/com/sun/star/ucb/ListEvent.idl b/offapi/com/sun/star/ucb/ListEvent.idl index 232dbc613c46..2833d4315594 100644 --- a/offapi/com/sun/star/ucb/ListEvent.idl +++ b/offapi/com/sun/star/ucb/ListEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListEvent.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,16 +74,15 @@ module com { module sun { module star { module ucb { //============================================================================= -/** ListEvent specifies the type of event fired by an -XDynamicResultSet +/** specifies the type of event fired by an XDynamicResultSet */ struct ListEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- /** If you apply the given ListActions one after the other - to the old Version in given order, you will get the positions in the new - Version. + to the old version of an resultset in given order, you will get the + positions in the new version. */ sequence Changes; }; diff --git a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl index 8ebf4e626908..f019ed07354d 100644 --- a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl +++ b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: NumberedSortingInfo.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 14:59:05 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,14 +68,14 @@ module com { module sun { module star { module ucb { //============================================================================= /** contains information for sorting a ContentResultSet. -

in contrast to the struct SortingInfo this struct is used to be -on the safe side, that no one asks for sorting by a property which is not -contained in the ContentResultSet. +

In contrast to the struct SortingInfo this struct is + used to be on the safe side, that no one asks for sorting by a property + which is not contained in a ContentResultSet. */ struct NumberedSortingInfo { //------------------------------------------------------------------------- - /** sort the resultset by this column. Index starts with 1. + /** sort the resultset by this column. Index starts with 1. */ long ColumnIndex; diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 2a8e9e2c5e77..2ce7897ae0ef 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenCommandArgument.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,31 +74,34 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The argument for the commands "open", "update", and "synchronize". +/** The argument for commands like "open", "update", and "synchronize". + + @see XCommandProcessor */ struct OpenCommandArgument { //------------------------------------------------------------------------- - /** The mode should be one of the com::sun::star::ucb::OpenMode constants. + /** The mode should be one of the OpenMode constants. */ long Mode; //------------------------------------------------------------------------- - /** The tasks priority, in the range 0 (highest) to 65535 (lowest). + /** The tasks priority, in the range 0 (highest) to + 65535 (lowest). */ long Priority; //------------------------------------------------------------------------- /** The data sink to write the contents into ( supporting either XActiveDataSink or - XOutputStream ). This gives the - caller read-only access to the contents. + XOutputStream ) or + XActiveDataStreamer. - The data streamer, of type - XActiveDataStreamer, providing - both read and write access to the contents. +

XActiveDataSink and XOutputStream give the caller read-only + access to the contents. XActiveDataStreamer offers both read and + write access to the contents. - If an XActiveDataSink is supplied, the implementation of the command +

If an XActiveDataSink is supplied, the implementation of the command needs to provide an implementation of an object implementing the interface XInputStream. It is highly recommended that this object also implements the interface @@ -109,9 +112,8 @@ struct OpenCommandArgument com::sun::star::uno::XInterface Sink; //------------------------------------------------------------------------- - /** The properties, for that the values shall be provided through the - result set of the command ( Usually the result will be of type - XResultSet ). + /** The properties, for that the values shall be provided by the + ContentResultSet returned by the command). */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl index 5467194fdb8b..ff0468f7f5c4 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenCommandArgument2.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,17 +74,22 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The argument for the commands "open", "update", and "synchronize". This - strcut extends the original OpenCommandArgument, which must not be +/** The argument for the commands like "open", "update", and "synchronize". + +

This strcut extends the original OpenCommandArgument, which must not be changed for compatibility reasons. + + @see XCommandProcessor */ struct OpenCommandArgument2 : OpenCommandArgument { //------------------------------------------------------------------------- - /** The sort criteria for the rows of the result set. The result set - implementation may ignore this parameter, if it cannot sort the - data by the given criteria in an efficient way ( i.e. directly - using the underlying data source --> SQL-database -> ORDER BY ). + /** The sort criteria for the rows of the returned + ContentResultSet. + +

The resultset implementation may ignore this parameter, if it + cannot sort the data by the given criteria in an efficient way (i.e. + directly using the underlying data source -> SQL-database -> ORDER BY). */ sequence< com::sun::star::ucb::NumberedSortingInfo > SortingInfo; }; diff --git a/offapi/com/sun/star/ucb/PostCommandArgument.idl b/offapi/com/sun/star/ucb/PostCommandArgument.idl index b3384915a937..85884afffa13 100644 --- a/offapi/com/sun/star/ucb/PostCommandArgument.idl +++ b/offapi/com/sun/star/ucb/PostCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: PostCommandArgument.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,19 +71,21 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The argument for the command task "post". +/** The argument for the command "post". + + @see XCommandProcessor */ struct PostCommandArgument { //------------------------------------------------------------------------- - /** The data source containing the contents to post. + /** The data source containing the data to post. */ com::sun::star::io::XInputStream Source; //------------------------------------------------------------------------- /** The data sink receiving the returned contents (supporting either - com::sun::star::io::XActiveDataSink or - com::sun::star::io::XOutputStream). + XActiveDataSink or + XOutputStream). */ com::sun::star::uno::XInterface Sink; }; diff --git a/offapi/com/sun/star/ucb/PropertyValueInfo.idl b/offapi/com/sun/star/ucb/PropertyValueInfo.idl index 769ce5851008..56d3bf8db7ac 100644 --- a/offapi/com/sun/star/ucb/PropertyValueInfo.idl +++ b/offapi/com/sun/star/ucb/PropertyValueInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: PropertyValueInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,13 +75,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This structure contains value and state of a property to be processed - be a property task. +/** contains value and state of a + Property. */ struct PropertyValueInfo: com::sun::star::beans::PropertyValue { //------------------------------------------------------------------------- - /** The state of the property value. + /** the state of the property value. */ com::sun::star::ucb::PropertyValueState ValueState; diff --git a/offapi/com/sun/star/ucb/RecipientInfo.idl b/offapi/com/sun/star/ucb/RecipientInfo.idl index 9bc4b36cc4da..81eb0d28a643 100644 --- a/offapi/com/sun/star/ucb/RecipientInfo.idl +++ b/offapi/com/sun/star/ucb/RecipientInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: RecipientInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,8 +71,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct contains all information needed to send a message using one(!) - send protocol. +/** contains all information needed to send a message using one send protocol.

To send one message via two different protocols, two RecipientInfos are needed - to send one message to different users with one protocol, @@ -81,36 +80,40 @@ module com { module sun { module star { module ucb { struct RecipientInfo { //------------------------------------------------------------------------- - /** The protocol to use for sending ( i.e. "NNTP", "SMTP", "VIM" ). + /** the protocol to use for sending (i.e. "NNTP", "SMTP", "VIM"). */ string ProtocolType; //------------------------------------------------------------------------- - /**the current state of the message. + /** the current state of the message. */ com::sun::star::ucb::OutgoingMessageState State; //------------------------------------------------------------------------- /** the recipient(s) (e.g. e-mail address/es). - Multiple addresses are separated by commas. + +

Multiple addresses are separated by commas. */ string To; //------------------------------------------------------------------------- - /** the recipient(s) of a "carbon copy" (e.g. e-mail address/es). - Multiple addresses are separated by commas. + /** the recipient(s) of a "carbon copy" (e.g. e-mail address/es). + +

Multiple addresses are separated by commas. */ string CC; //------------------------------------------------------------------------- - /** the recipient(s) of "blind carbon copy" (e.g. e-mail address/es). - Multiple addresses are separated by commas. + /** the recipient(s) of "blind carbon copy" (e.g. e-mail address/es). + +

Multiple addresses are separated by commas. */ string BCC; //------------------------------------------------------------------------- /** the newsgroup(s) to which an article is be posted. - Multiple groups are separated by commas. + +

Multiple addresses are separated by commas. */ string Newsgroups; @@ -135,18 +138,18 @@ struct RecipientInfo string VIMPostOfficePath; //------------------------------------------------------------------------- - /** String representing the last error (generated by send server). + /** string representing the last error (generated by send server). */ string ProtocolErrorString; //------------------------------------------------------------------------- - /**The number representing the last error (generated by send server). + /** the number representing the last error (generated by send server). */ long ProtocolErrorNumber; //------------------------------------------------------------------------- - /**The count of tries to send a message. This count is 1 if the - message was sent with the first try and increases with every + /** the count of tries to send a message. This count is 1 + if the message was sent with the first try and increases with every unsuccessful retry. */ long SendTries; diff --git a/offapi/com/sun/star/ucb/Rule.idl b/offapi/com/sun/star/ucb/Rule.idl index cb810c75b3b4..fbd5d47c72b5 100644 --- a/offapi/com/sun/star/ucb/Rule.idl +++ b/offapi/com/sun/star/ucb/Rule.idl @@ -2,9 +2,9 @@ * * $RCSfile: Rule.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,27 +71,48 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct describes a rule. A rule consists of a sequence of terms - describing the documents to which the rule should apply, the action - which should be used on the selected documents, and a parameter. +/** describes a rule that can be applies to a number of objects. + +

A rule consists of a sequence of RuleTerm>/type>s describing the + objects to which the rule should be applied, the RuleAction + which should be used on the matching objects, and a parameter. */ struct Rule { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR Rule::Terms + /** the rule terms describing the objects to which the rule should be + applied. + */ sequence Terms; //------------------------------------------------------------------------- - /** The parameter is needed for some actions. For copy, move and - create link actions, the parameter contains the URL to the - destination folder. For the forward action, the parameter contains - the address of the recepient. + /** Some RuleActions require a parameter. + + + + + + + + + + + + + + + + + + +
ActionParameter
COPY, MOVE, LINKThe URL to the destination folder.
FORWARDThe email address of the recepient
All other actionsn/a
*/ string Parameter; //------------------------------------------------------------------------- - /**Flags describing the action (e.g. copy document or - hide document, RuleAction* see above) + /** the action to perform on the matching objects. + +

The value can be one of the RuleAction constants. */ short Action; diff --git a/offapi/com/sun/star/ucb/RuleSet.idl b/offapi/com/sun/star/ucb/RuleSet.idl index 546761b63fb2..7bcfa8eb875a 100644 --- a/offapi/com/sun/star/ucb/RuleSet.idl +++ b/offapi/com/sun/star/ucb/RuleSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: RuleSet.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,20 +71,22 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct describes a RuleSet. A RuleSet is applied to a folder - to filter messages or documents. A RuleSet consists of a sequence of - rules. A rule consists of a sequence of terms describing the documents - to which the rule should apply and the action which should be used on the - selected documents. +/** describes a set of Rules. + +

A RuleSet is applied to a folder. It consists of a sequence of rules. + Each rule consists of a sequence of RuleTerms describing the + objects to which the rule should by applied and the RuleAction + which should be performed on the matching objects. */ struct RuleSet { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR RuleSet::Rules + /** conatains a number of rules. + */ sequence Rules; //------------------------------------------------------------------------- - /**the flag indicating whether the rules apply to folders, too. + /** is a flag indicating whether the rules apply to folders, too. */ boolean HandleFolder; diff --git a/offapi/com/sun/star/ucb/RuleTerm.idl b/offapi/com/sun/star/ucb/RuleTerm.idl index 368b297ab4f9..858af33c7a33 100644 --- a/offapi/com/sun/star/ucb/RuleTerm.idl +++ b/offapi/com/sun/star/ucb/RuleTerm.idl @@ -2,9 +2,9 @@ * * $RCSfile: RuleTerm.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,13 +67,14 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct describes a term. A term is used to select documents to - which a rule should apply. +/** describes a term. + +

A term is used to select objects to which a rule should apply. */ struct RuleTerm { //------------------------------------------------------------------------- - /** the name of the property used to match the term. + /** the name of the property used to match the term. */ string Property; @@ -87,19 +88,19 @@ struct RuleTerm /** the operator used to compare the property of the document with the given value (e.g. "contains" or "greater equal"). - @see RuleOperator +

The value can be one of the RuleOperator constants. */ short Operator; //------------------------------------------------------------------------- - /** The flag CaseSensitive determines if a string "operand" shall - be compared case sensitive. + /** this flag indicates whether a string "operand" shall be compared + case sensitive. */ boolean CaseSensitive; //------------------------------------------------------------------------- - /** The flag RegularExpression determines if a string "operand" shall - be treated as a regular expression. + /** this flag indicates whether a string "operand" shall be treated + as a regular expression. */ boolean RegularExpression; diff --git a/offapi/com/sun/star/ucb/SearchCommandArgument.idl b/offapi/com/sun/star/ucb/SearchCommandArgument.idl index 21c952d24205..84f191169f2d 100644 --- a/offapi/com/sun/star/ucb/SearchCommandArgument.idl +++ b/offapi/com/sun/star/ucb/SearchCommandArgument.idl @@ -2,9 +2,9 @@ * * $RCSfile: SearchCommandArgument.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-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,18 +79,19 @@ module com { module sun { module star { module ucb { //============================================================================= /** The argument for the command "search". + + @see XCommandProcessor */ struct SearchCommandArgument { //------------------------------------------------------------------------- - /** Information on how to search. + /** the search criteria. */ SearchInfo Info; //------------------------------------------------------------------------- - /** The properties for which values shall be provided through the - result set of the command. (Usually, the result will be of type - XResultSet.) + /** the properties for which values shall be provided through the + ContentResultSet returned by the search command. */ sequence< com::sun::star::beans::Property > Properties; }; diff --git a/offapi/com/sun/star/ucb/SearchCriterium.idl b/offapi/com/sun/star/ucb/SearchCriterium.idl index fd7f63e8e1dc..e01d710537f8 100644 --- a/offapi/com/sun/star/ucb/SearchCriterium.idl +++ b/offapi/com/sun/star/ucb/SearchCriterium.idl @@ -2,9 +2,9 @@ * * $RCSfile: SearchCriterium.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,7 +77,8 @@ module com { module sun { module star { module ucb { struct SearchCriterium { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR SearchCriterium::Terms + /** a number of rule terms. + */ sequence Terms; }; diff --git a/offapi/com/sun/star/ucb/SearchInfo.idl b/offapi/com/sun/star/ucb/SearchInfo.idl index 9dd1a71eed60..a62598a46888 100644 --- a/offapi/com/sun/star/ucb/SearchInfo.idl +++ b/offapi/com/sun/star/ucb/SearchInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: SearchInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,8 @@ module com { module sun { module star { module ucb { struct SearchInfo { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR SearchInfo::Criteria + /** the search criteria. + */ sequence Criteria; //------------------------------------------------------------------------- diff --git a/offapi/com/sun/star/ucb/SendInfo.idl b/offapi/com/sun/star/ucb/SendInfo.idl index 1fca2d1dcdbb..0ba1bac10895 100644 --- a/offapi/com/sun/star/ucb/SendInfo.idl +++ b/offapi/com/sun/star/ucb/SendInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: SendInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,18 +67,20 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct contains information related to a send protocol. It can - contain any string values (server names, user names, paswords, etc.). +/** contains information related to a send protocol. + +

It can contain any string values (server names, user names, passwords, + ...). */ struct SendInfo { //------------------------------------------------------------------------- - /** the protocol to which the info is related (i.e. "NNTP", "SMTP", "VIM"). + /** the protocol to which the info is related (i.e. "NNTP", "SMTP", "VIM"). */ string ProtocolType; //------------------------------------------------------------------------- - /** The value. + /** the value. */ string Value; diff --git a/offapi/com/sun/star/ucb/SendMediaTypes.idl b/offapi/com/sun/star/ucb/SendMediaTypes.idl index d11c6b037643..fb08c1f44643 100644 --- a/offapi/com/sun/star/ucb/SendMediaTypes.idl +++ b/offapi/com/sun/star/ucb/SendMediaTypes.idl @@ -2,9 +2,9 @@ * * $RCSfile: SendMediaTypes.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,18 +67,20 @@ module com { module sun { module star { module ucb { //============================================================================= -/**This struct contains information related to a send protocol. It contains a - list of internet media types (like "text/plain" and "text/html"). +/** contains a list of internet media types (like "text/plain" and "text/html"), + that are related to a send protocol. */ struct SendMediaTypes { //------------------------------------------------------------------------- - /** The protocol to which the information is related (i.e., "NNTP", "SMTP", "VIM"). + /** the protocol to which the information is related (i.e. "NNTP", "SMTP", + "VIM"). */ string ProtocolType; //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR SendMediaTypes::Value + /** a list of internet media types + */ sequence Value; }; diff --git a/offapi/com/sun/star/ucb/SortingInfo.idl b/offapi/com/sun/star/ucb/SortingInfo.idl index 73720cca31f5..52867089c18c 100644 --- a/offapi/com/sun/star/ucb/SortingInfo.idl +++ b/offapi/com/sun/star/ucb/SortingInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: SortingInfo.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,7 +72,7 @@ module com { module sun { module star { module ucb { struct SortingInfo { //------------------------------------------------------------------------- - /** specifies the name of the property to use for sorting ( e.g. "Title" ). + /** specifies the name of a property to use for sorting ( e.g. "Title" ). */ string PropertyName; diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index ebd8551d68e2..93fc8d1a7238 100644 --- a/offapi/com/sun/star/ucb/TransferInfo.idl +++ b/offapi/com/sun/star/ucb/TransferInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransferInfo.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-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,8 +67,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This struct contains information needed to transfer objects from one - location to another. +/** contains information needed to transfer objects from one location to another.

The transfer command is always called on the target! */ @@ -103,7 +102,7 @@ struct TransferInfo to be transferred to a folder already containing another file named "foo.txt". -

Refer to NameClash for possible values. +

The value can be one of the NameClash constants. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl index 5dd2676b49a4..06141f4445da 100644 --- a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl +++ b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl @@ -2,9 +2,9 @@ * * $RCSfile: WelcomeDynamicResultSetStruct.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,17 +71,24 @@ module com { module sun { module star { module ucb { //============================================================================= /** This struct is to be contained in the first notification of an -XDynamicResultSet + XDynamicResultSet -@see XDynamicResultSet -@see ListEvent -@see ListAction -@see ListActionType + @see XDynamicResultSet + @see ListEvent + @see ListAction + @see ListActionType */ struct WelcomeDynamicResultSetStruct { + //------------------------------------------------------------------------- + /** The static resultset containing the previous version of resultset data. + */ com::sun::star::sdbc::XResultSet Old; + + //------------------------------------------------------------------------- + /** The static resultset containing the new version of resultset data. + */ com::sun::star::sdbc::XResultSet New; };