diff options
author | Kai Sommerfeld <kso@openoffice.org> | 2001-02-12 12:41:08 +0000 |
---|---|---|
committer | Kai Sommerfeld <kso@openoffice.org> | 2001-02-12 12:41:08 +0000 |
commit | ccebfad9eaf8423b095c6110c8cab189f4f9f1cc (patch) | |
tree | f4d5bd01a0c5f9a191a2b6c7ab25d667f04ef75a | |
parent | 42c949853815fce39436c3da941842ecd95bcf7a (diff) |
Updated/reformatted documentation.
30 files changed, 397 insertions, 310 deletions
diff --git a/offapi/com/sun/star/ucb/Command.idl b/offapi/com/sun/star/ucb/Command.idl index f4e3b7151..6421f7b0b 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. + + <p>It may be <code>-1</code> 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 780298c45..3320cc705 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. + + <p>It may be <code>-1</code> 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 543856d35..38f44e5f3 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 <type>XCommandInfo</type> is changed. - <p>A <type self>CommandInfoChangeEvent</type> object is sent to + <p>A <type>CommandInfoChangeEvent</type> object is sent to <type>XCommandInfoChangeListener</type>s. */ 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. - <p>May be -1 if the implementation has no handle. + <p>May be <code>-1</code> if the implementation has no handle. */ long Handle; //------------------------------------------------------------------------- /** contains the reason for the event. - @see CommandInfoChange + <p>The value can be one of the <type>CommandInfoChange</type> constants. */ long Reason; }; diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index c3f4ea6d5..eca0de0ae 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 + <p>The value can be one of the <type>ContentAction</type> 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: + <p>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). + <table border=1> + <tr align=left> + <td><member>ContentAction::INSERTED</member></td> + <td>The content inserted into a folder</td> + </tr> + <tr align=left> + <td><member>ContentAction::REMOVED</member></td> + <td>The content removed from a folder</td> + </tr> + <tr align=left> + <td><member>ContentAction::DELETED</member></td> + <td>The deleted content</td> + </tr> + <tr align=left> + <td><member>ContentAction::EXCHANGED</member></td> + <td>The exchanged content (that already has the new content id)</td> + </tr> + </table> */ 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: + <p>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. + <table border=1> + <tr align=left> + <td><member>ContentAction::INSERTED</member></td> + <td>Id of the folder the content was inserted into</td> + </tr> + <tr align=left> + <td><member>ContentAction::REMOVED</member></td> + <td>Id of the folder the content was removed from</td> + </tr> + <tr align=left> + <td><member>ContentAction::DELETED</member></td> + <td>Id of the deleted content</td> + </tr> + <tr align=left> + <td><member>ContentAction::EXCHANGED</member></td> + <td>Previous(!) id of the exchanged content</td> + </tr> + </table> */ XContentIdentifier Id; }; diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index 97349a84c..ef04d1db7 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. + + <p>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 + <member>XContent::getContentType</member> of an appropriate content. */ string Type; @@ -86,9 +91,11 @@ struct ContentInfo /** Additional attributes. <p>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 ). + + <p>It is highly recommended to fill these flags very accurately, as + they are very important when transferring contents between different + <type>ContentProvider</type>s. <p>The value can be one of the <type>ContentInfoAttribute</type> constants. diff --git a/offapi/com/sun/star/ucb/CrossReference.idl b/offapi/com/sun/star/ucb/CrossReference.idl index bdcfc15d1..95afd34b8 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 @@ -64,22 +64,24 @@ //============================================================================= -module com { module sun { module star { module ucb { +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. + + <p>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; @@ -88,6 +90,6 @@ struct CrossReference //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/DocumentHeaderField.idl b/offapi/com/sun/star/ucb/DocumentHeaderField.idl index 5466b5c39..bebec24b4 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 @@ -64,21 +64,21 @@ //============================================================================= -module com { module sun { module star { module ucb { +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; @@ -86,6 +86,6 @@ struct DocumentHeaderField //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index 5a5be2785..30fcf9df2 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 <member>XFetchProvider::fetch</member>. +/** containes data of several rows of a <type>ContentResultSet</type>. + + <p>This struct is returned from <member>XFetchProvider::fetch</member>, + for example. */ struct FetchResult @@ -75,40 +77,40 @@ struct FetchResult //------------------------------------------------------------------------- /** containes the demanded data. - <p>One <atom>any</atom> contains the data of one whole row. - Those methods which use this struct have to specify, - what the any has to contain. + <p>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 <member>Rows</member> contained - row in the original result set. So if <member>StartIndex</member> equals 3, - the first element in the sequence <member>Rows</member> containes the data - of the index 3 in the original result set. + row in the original resultset. So if <member>StartIndex</member> + equals <code>3</code>, the first element in the sequence + <member>Rows</member> containes the data of the index <code>3</code> + in the original resultset. - <p>The following rows are one after the other, but the direction depends on - <member>Direction</member> + <p>The following rows are one after the other, but the direction + depends on the value of <member>Direction</member> */ long StartIndex; //------------------------------------------------------------------------- /** indicates the orientation in which the rows are fetched and set into - the sequence <member>Rows</member>. + the sequence <member>Rows</member>. - <p>When <member>Orientation</member> equals TRUE, rows in - <member>Rows</member> are ordered in the same way as in the original result - set. + <p>When <member>Orientation</member> equals <TRUE/>, the rows in + <member>Rows</member> 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. <p>The value may contain zero or more constants of the <type>FetchError</type> constants group. */ - short FetchError; + short FetchError; }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/FolderList.idl b/offapi/com/sun/star/ucb/FolderList.idl index 721e6afa6..479686bc2 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 @@ -72,7 +72,7 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** A list of folders. @@ -85,14 +85,14 @@ 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 + <member>FolderListCommand::SET</member>). */ sequence<FolderListEntry> List; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index f53dcdd39..7e1c2d6d8 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 @@ -64,10 +64,10 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= -/** Information about a single folder in a folder list. +/** Information about a single folder in a <type>FolderList</type>. */ struct FolderListEntry { @@ -100,13 +100,13 @@ struct FolderListEntry //------------------------------------------------------------------------- /** The folder shall be purged (only used in conjunction with the - FolderListCommand SET). + <type>FolderListCommand::SET</type>). */ boolean Purge; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/InsertCommandArgument.idl b/offapi/com/sun/star/ucb/InsertCommandArgument.idl index a506adf14..397e4e3c1 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. + + <p>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. + + <p>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 851860568..2d2fb060c 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 @@ -64,28 +64,29 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** This struct contains information needed in the notifications of a -<type>XDynamicResultSet</type> + <type>XDynamicResultSet</type>. -@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 - <type>XResultSet</type>, but a position while doing the changes step by - step beginning with the old <type>XResultSet</type>. + /** The position where something has happened (index begins with + <code>1</code> as usual with JDBC ). + + <p>Its value does not necessary indicate the new position in the new + <type>XResultSet</type>, but a position while doing the changes step by + step beginning with the old <type>XResultSet</type>. */ 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. - <p>The <member>ListAction::ListActionType</member> must contain a - constant of the <type>ListActionType</type> constants group. - - <p><type>ListAction</type>s with different contents of - <member>ListAction::ListActionType</member> need or can contain - different values for <member>ListAction::Position</member>, - <member>ListAction::Count</member> and - <member>ListAction::ActionInfo</member>: - - <p>So this member is to be filled as follows: + <p>The value of the other members of this struct depend on the value + of this member: <table border=1> <tr align=left> <th>ListActionType</th> @@ -110,53 +103,53 @@ struct ListAction <th>Count</th> <th>ActionInfo</th></tr> - <tr align=left> <th><br></th><th><br></th> - <th><br></th><th><br></th></tr> - - <tr align=left> <th>WELCOME</th> - <th>useless</th> - <th>useless</th> - <th>type WelcomeDynamicResultSetStruct required</th></tr> - - <tr align=left> <th>CLEARED</th> - <th>useless</th> - <th>useless</th> - <th>useless</th></tr> - - <tr align=left> <th>INSERTED</th> - <th>required 1-x</th> - <th>required 1-x</th> - <th>allowed but not required... @todo </th></tr> - - <tr align=left> <th>REMOVED</th> - <th>required 1-x</th> - <th>required 1-x</th> - <th>useless</th></tr> - - <tr align=left> <th>MOVED</th> - <th>required 1-x</th> - <th>required 1-x</th> - <th>type long required</th></tr> - - <tr align=left> <th>PROPERTIES_CHANGED</th> - <th>required 1-x</th> - <th>required 1-x</th> - <th>allowed but not required... @todo</th></tr> + <tr align=left> <td>WELCOME</td> + <td>n/a</td> + <td>n/a</td> + <td><type>WelcomeDynamicResultSetStruct</type> required</td></tr> + + <tr align=left> <td>CLEARED</td> + <td>n/a</td> + <td>n/a</td> + <td>n/a</td></tr> + + <tr align=left> <td>INSERTED</td> + <td>required 1-x</td> + <td>required 1-x</td> + <td>allowed but not required... @todo </td></tr> + + <tr align=left> <td>REMOVED</td> + <td>required 1-x</td> + <td>required 1-x</td> + <td>n/a</td></tr> + + <tr align=left> <td>MOVED</td> + <td>required 1-x</td> + <td>required 1-x</td> + <td>type long required</td></tr> + + <tr align=left> <td>PROPERTIES_CHANGED</td> + <td>required 1-x</td> + <td>required 1-x</td> + <td>allowed but not required... @todo</td></tr> </table> + + <p>The value for this member can be one of the + <type>ListActionType</type> constants group. */ long ListActionType; - + //------------------------------------------------------------------------- /** dependend on the content of <member>ListAction::ListActionType</member> the <member>ListAction::ActionInfo</member> could contain additional - information about the changes happened ( see table above ). + information about the changes happened (see table above). */ - + any ActionInfo; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/ListEvent.idl b/offapi/com/sun/star/ucb/ListEvent.idl index 09c811d70..7dd509e9d 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 @@ -71,25 +71,24 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= -/** <type>ListEvent</type> specifies the type of event fired by an -<type>XDynamicResultSet</type> +/** specifies the type of event fired by an <type>XDynamicResultSet</type> */ struct ListEvent: com::sun::star::lang::EventObject { //------------------------------------------------------------------------- /** If you apply the given <type>ListAction</type>s 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<ListAction> Changes; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/NumberedSortingInfo.idl b/offapi/com/sun/star/ucb/NumberedSortingInfo.idl index 1a644e6b7..f019ed073 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 @@ -63,19 +63,19 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** contains information for sorting a <type>ContentResultSet</type>. -<p> in contrast to the struct <type>SortingInfo</type> 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 <type>ContentResultSet</type>. + <p> In contrast to the struct <type>SortingInfo</type> 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 <type>ContentResultSet</type>. */ struct NumberedSortingInfo { //------------------------------------------------------------------------- - /** sort the resultset by this column. Index starts with 1. + /** sort the resultset by this column. Index starts with <code>1</code>. */ long ColumnIndex; @@ -87,6 +87,6 @@ struct NumberedSortingInfo //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 5bfdd0d71..d7ebca2f3 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 <type>OpenMode</type> constants. */ long Mode; //------------------------------------------------------------------------- - /** The tasks priority, in the range 0 (highest) to 65535 (lowest). + /** The tasks priority, in the range <code>0</code> (highest) to + <code>65535</code> (lowest). */ long Priority; //------------------------------------------------------------------------- /** The data sink to write the contents into ( supporting either <type scope="com::sun::star::io">XActiveDataSink</type> or - <type scope="com::sun::star::io">XOutputStream</type> ). This gives the - caller read-only access to the contents. + <type scope="com::sun::star::io">XOutputStream</type> ) or + <type scope="com::sun::star::io">XActiveDataStreamer</type>. - The data streamer, of type - <type scope="com::sun::star::io">XActiveDataStreamer</type>, providing - both read and write access to the contents. + <p>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 + <p>If an XActiveDataSink is supplied, the implementation of the command needs to provide an implementation of an object implementing the interface <type scope="com::sun::star::io">XInputStream</type>. 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 - <type scope="com::sun::star::sdbc">XResultSet</type> ). + /** The properties, for that the values shall be provided by the + <type>ContentResultSet</type> 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 5467194fd..ae5b76fcc 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". + + <p>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 + <type>ContentResultSet</type>. + + <p>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 9681544de..85884afff 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 @@ -68,28 +68,30 @@ //============================================================================= -module com { module sun { module star { module ucb { +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). + <type scope="com::sun::star::io">XActiveDataSink</type> or + <type scope="com::sun::star::io">XOutputStream</type>). */ com::sun::star::uno::XInterface Sink; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/PropertyValueInfo.idl b/offapi/com/sun/star/ucb/PropertyValueInfo.idl index 228d170b1..56d3bf8db 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 @@ -72,16 +72,16 @@ //============================================================================= -module com { module sun { module star { module ucb { +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 + <type scope="com::sun::star::beans">Property</type>. */ 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; @@ -89,6 +89,6 @@ struct PropertyValueInfo: com::sun::star::beans::PropertyValue //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/RecipientInfo.idl b/offapi/com/sun/star/ucb/RecipientInfo.idl index 6eef21dfb..73428c1b4 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 @@ -68,12 +68,11 @@ //============================================================================= -module com { module sun { module star { module ucb { +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. + <p>To send one message via two different protocols, two RecipientInfos are needed - to send one message to different users with one protocol, one RecipientInfo can be used. @@ -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. + + <p>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). + + <p>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). + + <p>Multiple addresses are separated by commas. */ string BCC; //------------------------------------------------------------------------- /** the newsgroup(s) to which an article is be posted. - Multiple groups are separated by commas. + + <p>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 <code>1</code> + if the message was sent with the first try and increases with every unsuccessful retry. */ long SendTries; @@ -155,6 +158,6 @@ struct RecipientInfo //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/Rule.idl b/offapi/com/sun/star/ucb/Rule.idl index 698f49f2f..7b24cb786 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 @@ -68,30 +68,51 @@ //============================================================================= -module com { module sun { module star { module ucb { +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. + + <p>A rule consists of a sequence of <type>RuleTerm>/type>s describing the + objects to which the rule should be applied, the <type>RuleAction</type> + 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<com::sun::star::ucb::RuleTerm> 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 <type>RuleAction</type>s require a parameter. + + <table border =1> + <tr> + <th>Action</th> + <th>Parameter</th> + </tr> + <tr> + <td>COPY, MOVE, LINK</td> + <td>The URL to the destination folder.</td> + </tr> + <tr> + <td>FORWARD</td> + <td>The email address of the recepient</td> + </tr> + <tr> + <td>All other actions</td> + <td>n/a</td> + </tr> + </table> */ string Parameter; //------------------------------------------------------------------------- - /**Flags describing the action (e.g. copy document or - hide document, RuleAction* see above) + /** the action to perform on the matching objects. + + <p>The value can be one of the <type>RuleAction</type> constants. */ short Action; @@ -99,6 +120,6 @@ struct Rule //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/RuleSet.idl b/offapi/com/sun/star/ucb/RuleSet.idl index ad9a9468c..7bcfa8eb8 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 @@ -68,23 +68,25 @@ //============================================================================= -module com { module sun { module star { module ucb { +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 <type>Rule</type>s. + + <p>A RuleSet is applied to a folder. It consists of a sequence of rules. + Each rule consists of a sequence of <type>RuleTerm</type>s describing the + objects to which the rule should by applied and the <type>RuleAction</type> + which should be performed on the matching objects. */ struct RuleSet { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR RuleSet::Rules + /** conatains a number of rules. + */ sequence<com::sun::star::ucb::Rule> Rules; //------------------------------------------------------------------------- - /**the flag indicating whether the rules apply to folders, too. + /** is a flag indicating whether the rules apply to folders, too. */ boolean HandleFolder; @@ -92,6 +94,6 @@ struct RuleSet //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/RuleTerm.idl b/offapi/com/sun/star/ucb/RuleTerm.idl index 6adccccf8..858af33c7 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 @@ -64,16 +64,17 @@ //============================================================================= -module com { module sun { module star { module ucb { +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. + + <p>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; @@ -86,20 +87,20 @@ struct RuleTerm //------------------------------------------------------------------------- /** the operator used to compare the property of the document with the given value (e.g. "contains" or "greater equal"). - - @see RuleOperator + + <p>The value can be one of the <type>RuleOperator</type> 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; @@ -107,6 +108,6 @@ struct RuleTerm //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/SearchCommandArgument.idl b/offapi/com/sun/star/ucb/SearchCommandArgument.idl index 21c952d24..84f191169 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 - <type scope="com::sun::star::sdbc">XResultSet</type>.) + /** the properties for which values shall be provided through the + <type>ContentResultSet</type> 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 6973e3de6..e01d71053 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 @@ -68,7 +68,7 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** a criterium describing how an object must match some rules that specify @@ -77,13 +77,14 @@ module com { module sun { module star { module ucb { struct SearchCriterium { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR SearchCriterium::Terms + /** a number of rule terms. + */ sequence<com::sun::star::ucb::RuleTerm> Terms; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/SearchInfo.idl b/offapi/com/sun/star/ucb/SearchInfo.idl index 217e09d29..a62598a46 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 @@ -72,7 +72,7 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** information needed to (recursively) search an object. @@ -80,7 +80,8 @@ module com { module sun { module star { module ucb { struct SearchInfo { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR SearchInfo::Criteria + /** the search criteria. + */ sequence<com::sun::star::ucb::SearchCriterium> Criteria; //------------------------------------------------------------------------- @@ -118,6 +119,6 @@ struct SearchInfo //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/SendInfo.idl b/offapi/com/sun/star/ucb/SendInfo.idl index a5febd08d..0ba1bac10 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 @@ -64,21 +64,23 @@ //============================================================================= -module com { module sun { module star { module ucb { +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. + + <p>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; @@ -86,6 +88,6 @@ struct SendInfo //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/SendMediaTypes.idl b/offapi/com/sun/star/ucb/SendMediaTypes.idl index 8540aa38b..fb08c1f44 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 @@ -64,27 +64,29 @@ //============================================================================= -module com { module sun { module star { module ucb { +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<string> Value; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/SortingInfo.idl b/offapi/com/sun/star/ucb/SortingInfo.idl index 14a866edf..52867089c 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 @@ -64,7 +64,7 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** contains a sorting info. @@ -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; @@ -85,6 +85,6 @@ struct SortingInfo //============================================================================= -}; }; }; }; +}; }; }; }; #endif diff --git a/offapi/com/sun/star/ucb/TransferInfo.idl b/offapi/com/sun/star/ucb/TransferInfo.idl index ebd8551d6..93fc8d1a7 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. <p>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". - <p>Refer to <type>NameClash</type> for possible values. + <p>The value can be one of the <type>NameClash</type> constants. */ long NameClash; diff --git a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl index 30a72abc8..36d2579e6 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 @@ -67,27 +67,34 @@ //============================================================================= -module com { module sun { module star { module ucb { +module com { module sun { module star { module ucb { //============================================================================= /** This struct is to be contained in the first notification of an -<type>XDynamicResultSet</type> + <type>XDynamicResultSet</type> -@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; }; //============================================================================= -}; }; }; }; +}; }; }; }; #endif |