diff options
| author | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
|---|---|---|
| committer | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
| commit | cb23f6a62077022736a40d6315ee92a218f489e0 (patch) | |
| tree | 713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/ucb | |
| parent | 625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff) | |
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/ucb')
51 files changed, 305 insertions, 246 deletions
diff --git a/offapi/com/sun/star/ucb/CHAOSProgressStart.idl b/offapi/com/sun/star/ucb/CHAOSProgressStart.idl index e860b49206cb..76bc28a3a324 100644 --- a/offapi/com/sun/star/ucb/CHAOSProgressStart.idl +++ b/offapi/com/sun/star/ucb/CHAOSProgressStart.idl @@ -2,9 +2,9 @@ * * $RCSfile: CHAOSProgressStart.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:51 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,6 +74,8 @@ module com { module sun { module star { module ucb { /** An object representing the start of a task's activity that will progress from some minimal to some maximal value. + @deprecated + @see XProgressHandler */ struct CHAOSProgressStart diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl index 47cdeb149c56..2d7130af197d 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSet.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,9 +88,10 @@ service CachedDynamicResultSet /** Provides remote optimized read access to a static or a dynamically changing <type>ContentResultSet</type>. - <p>The <type>XResultSet</type>s given to the listener in the first - notification in the <type>WelcomeDynamicResultSetStruct</type> are - implementations of the <type>CachedContentResultSet</type> service. + <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to + the listener in the first notification in the + <type>WelcomeDynamicResultSetStruct</type> are implementations of the + <type>CachedContentResultSet</type> service. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl index 0317d09227da..a4914e2b5966 100644 --- a/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl +++ b/offapi/com/sun/star/ucb/CachedDynamicResultSetStub.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedDynamicResultSetStub.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:19 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,9 +89,10 @@ service CachedDynamicResultSetStub remote optimized read access to a static or dynamically changing <type>ContentResultSet</type>. - <p>The <type>XResultSet</type>s given to the listener in the first - notification in the <type>WelcomeDynamicResultSetStruct</type> are - implementations of <type>CachedContentResultSetStub</type>. + <p>The <type scope="com::sun::star::sdbc">XResultSet</type>s given to + the listener in the first notification in the + <type>WelcomeDynamicResultSetStruct</type> are implementations of + <type>CachedContentResultSetStub</type>. <p>This interface is required. */ diff --git a/offapi/com/sun/star/ucb/Command.idl b/offapi/com/sun/star/ucb/Command.idl index 6421f7b0b055..c07b385e4388 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,7 +85,8 @@ struct Command //------------------------------------------------------------------------- /** contains an implementation specific handle for the command. - <p>It may be <code>-1</code> if the implementation has no handle. + <p>It must be <code>-1</code> if the implementation has no handle. + <code>0</code> is a valid command handle. */ long Handle; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index 6d12b239769e..c993688787ef 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -2,9 +2,9 @@ * * $RCSfile: Content.idl,v $ * - * $Revision: 1.18 $ + * $Revision: 1.19 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -148,8 +148,7 @@ service Content /** enables the caller to let the content execute commands. <p>It is strongly recommended that any implementation supports the - improved <type>com::sun::star::ucb::XCommandProcessor2</type> - interface.</p> + improved <type>XCommandProcessor2</type> interface.</p> <p>Typical commands are "open", "delete", "getPropertyValues" and "setPropertyValues". Each content must support a set of standard @@ -286,7 +285,7 @@ service Content // when "updating" a POP3-Inbox, the content for that box will get // and store all new objects on the appropriate server. The inserted // contents will be notified by calling - // <member>XContent::contentEvent</member>. + // <member>XContentEventListener::contentEvent</member>. void <B>update</B> <type>OpenCommandArgument2</type> aOpenCommandArg @@ -683,7 +682,7 @@ service Content the interface <type scope="com::sun::star::beans">XPropertyContainer</type>. ) */ - interface com::sun::star::beans::XPropertySetInfoChangeNotifier; + [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier; //------------------------------------------------------------------------- /** can be used to notify commands removed from or added to the @@ -721,7 +720,7 @@ service Content <p>This interface must be implemented by a content which is a (logical) child of a content. */ - interface com::sun::star::container::XChild; + [optional] interface com::sun::star::container::XChild; }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/ContentTransmitter.idl b/offapi/com/sun/star/ucb/ContentTransmitter.idl index bde9d3c49956..48e329f54ed4 100644 --- a/offapi/com/sun/star/ucb/ContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/ContentTransmitter.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentTransmitter.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,6 +71,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** A <type>ContentTransmitter</type> is a service that provides + + @deprecated */ service ContentTransmitter { diff --git a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl index 6fc149c38de9..365339a1c128 100644 --- a/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl +++ b/offapi/com/sun/star/ucb/DuplicateCommandIdentifierException.idl @@ -2,9 +2,9 @@ * * $RCSfile: DuplicateCommandIdentifierException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-09-07 09:16:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,7 +75,7 @@ module com { module sun { module star { module ucb { the same command identifier was used for two threads. <p>Each thread must use it's own command identifier, which must be obtained - using <method>XcommandProcessor::createCommandIdentifier</method>. Command + using <member>XcommandProcessor::createCommandIdentifier</member>. Command identifier <code>0</code>, which indicates that the command shall never be aborted by a client, can be used by any thread. diff --git a/offapi/com/sun/star/ucb/Error.idl b/offapi/com/sun/star/ucb/Error.idl index 5017f3a1e4a9..9ed127bee30b 100644 --- a/offapi/com/sun/star/ucb/Error.idl +++ b/offapi/com/sun/star/ucb/Error.idl @@ -2,9 +2,9 @@ * * $RCSfile: Error.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,6 +68,8 @@ module com { module sun { module star { module ucb { //============================================================================= /** These codes are used to indicate errors. + + @deprecated */ constants Error { diff --git a/offapi/com/sun/star/ucb/FetchResult.idl b/offapi/com/sun/star/ucb/FetchResult.idl index 521f2244750b..53eb207f57b1 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,7 +66,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** containes data of several rows of a <type>ContentResultSet</type>. +/** contains data of several rows of a <type>ContentResultSet</type>. <p>This struct is returned from <member>XFetchProvider::fetch</member>, for example. @@ -75,7 +75,7 @@ module com { module sun { module star { module ucb { struct FetchResult { //------------------------------------------------------------------------- - /** containes the demanded data. + /** contains the demanded data. <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. @@ -83,24 +83,24 @@ struct FetchResult sequence< any > Rows; //------------------------------------------------------------------------- - /** indicates the index of the first in <member>Rows</member> contained - 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. + /** indicates the index of the first row contained in + <member>FetchResult::Rows</member> in the original resultset. So if + <member>FetchResult::StartIndex</member> equals <code>3</code>, the + first element in the sequence <member>FetchResult::Rows</member> + contains 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 the value of <member>Direction</member> + depends on the value of <member>FetchResult::Direction</member> */ long StartIndex; //------------------------------------------------------------------------- /** indicates the orientation in which the rows are fetched and set into - the sequence <member>Rows</member>. + the sequence <member>FetchResult::Rows</member>. - <p>When <member>Orientation</member> equals <TRUE/>, the rows in - <member>Rows</member> are ordered in the same way as in the original - resultset. + <p>When <member>FetchResult::Orientation</member> equals <TRUE/>, the + rows in <member>FetchResult::Rows</member> are ordered in the same way + as in the original resultset. */ boolean Orientation; diff --git a/offapi/com/sun/star/ucb/FileContent.idl b/offapi/com/sun/star/ucb/FileContent.idl index 0e1054d3fdcc..24d2fa3d2072 100644 --- a/offapi/com/sun/star/ucb/FileContent.idl +++ b/offapi/com/sun/star/ucb/FileContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: FileContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/FolderListEntry.idl b/offapi/com/sun/star/ucb/FolderListEntry.idl index 7e1c2d6d8f83..f00b0f9e6e82 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,7 +100,7 @@ struct FolderListEntry //------------------------------------------------------------------------- /** The folder shall be purged (only used in conjunction with the - <type>FolderListCommand::SET</type>). + <member>FolderListCommand::SET</member>). */ boolean Purge; }; diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl index d51779cba75b..f225e032dfb2 100644 --- a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyContentProvider.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -124,10 +124,10 @@ service HierarchyContentProvider <ul> <li> - vnd.sun.star.hier:/ ( The URL of the HCP Root Folder ) + vnd.sun.star.hier:/ (The URL of the HCP Root Folder) </li> <li> - vnd.sun.star.hier:/Bookmarks/Sun%20Microssystems%20Home%20Page + vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page </li> <li> vnd.sun.star.hier:/Workplace/Printers diff --git a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl index c5bf2e269961..126720585768 100644 --- a/offapi/com/sun/star/ucb/HierarchyFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyFolderContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:01 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl index 0bf10d1b3a33..4b9ed42985d6 100644 --- a/offapi/com/sun/star/ucb/HierarchyLinkContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyLinkContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyLinkContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl index 0b6a3dd5aa0b..9b763c328c91 100644 --- a/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl +++ b/offapi/com/sun/star/ucb/HierarchyRootFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: HierarchyRootFolderContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/IOErrorCode.idl b/offapi/com/sun/star/ucb/IOErrorCode.idl index fb3e7c15b1e5..1badc35a1cb1 100644 --- a/offapi/com/sun/star/ucb/IOErrorCode.idl +++ b/offapi/com/sun/star/ucb/IOErrorCode.idl @@ -2,9 +2,9 @@ * * $RCSfile: IOErrorCode.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:50:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:22 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,10 +69,10 @@ module com { module sun { module star { module ucb { //============================================================================= /** Types of input/output errors. - <P>See <type>com::sun::star::task::InteractionHandler</type> for a + <P>See <type scope="com::sun::star::task">InteractionHandler</type> for a description of what kinds of arguments - <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> should - use with each of these error codes.</P> + <type>InteractiveAugmentedIOException</type> should use with each of these + error codes.</P> */ enum IOErrorCode { diff --git a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl index 698c6d3d6416..7adf1a58e0f4 100644 --- a/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveAugmentedIOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveAugmentedIOException.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:50:39 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,8 +78,8 @@ exception InteractiveAugmentedIOException : com::sun::star::ucb::InteractiveIOEx //------------------------------------------------------------------------- /** Additional arguments. - <P>See <type>com::sun::star::task::InteractionHandler</type> for a - description of well-known arguments.</P> + <P>See <type scope="com::sun::star::task">InteractionHandler</type> + for a description of well-known arguments.</P> */ sequence< any > Arguments; }; diff --git a/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl b/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl index bdff7dddc99a..614e088aac27 100644 --- a/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl +++ b/offapi/com/sun/star/ucb/InteractiveCHAOSException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveCHAOSException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-12 15:53:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * 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 { //============================================================================= /** An error capsuling error information as used by CHAOS. + + @deprecated */ exception InteractiveCHAOSException: com::sun::star::task::ClassifiedInteractionRequest { diff --git a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl index c2ceec68a969..03d3a29e54d3 100644 --- a/offapi/com/sun/star/ucb/InteractiveFileIOException.idl +++ b/offapi/com/sun/star/ucb/InteractiveFileIOException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractiveFileIOException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sb $ $Date: 2001-08-31 08:00:30 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,9 +77,10 @@ module com { module sun { module star { module ucb { //============================================================================= /** An input/output error while processing a file. + <p>This exception is deprecated. Use + <type>InteractiveAugmentedIOException</type> instead. + @deprecated - Use <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> - instead. */ exception InteractiveFileIOException: com::sun::star::ucb::InteractiveIOException { diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl index 16d663b3eeaa..c361d6bd2b33 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:23 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,8 +80,9 @@ struct ListAction <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>. + <type scope="com::sun::star::sdbc">XResultSet</type>, but a position + while doing the changes step by step beginning with the old + <type scope="com::sun::star::sdbc">XResultSet</type>. */ long Position; diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index 45218eb2d10f..be0bf637de21 100644 --- a/offapi/com/sun/star/ucb/ListActionType.idl +++ b/offapi/com/sun/star/ucb/ListActionType.idl @@ -2,9 +2,9 @@ * * $RCSfile: ListActionType.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,10 +85,12 @@ constants ListActionType <p>The member <member>ListAction::ActionInfo</member> is required to contain a struct <type>WelcomeDynamicResultSetStruct</type>. - This struct contains two <type>XResultSet</type>s (old and new). + This struct contains two + <type scope="com::sun::star::sdbc">XResultSet</type>s (old and new). During and after the notification only the new set is valid for access. - But the listener is required to remind both <type>XResultSet</type>s as he - will not get another chance to get them again. + But the listener is required to remind both + <type scope="com::sun::star::sdbc">XResultSet</type>s as he will not get + another chance to get them again. <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> are not used. @@ -100,9 +102,9 @@ constants ListActionType <p>This action is related to <member>ContentAction::INSERTED</member>. - <p>The memners <member>ListAction::Count</member> and + <p>The members <member>ListAction::Count</member> and <member>ListAction::Position</member> contain the position and count of - newly inserted rows. If the Count is greater than one, the inserted rows + newly inserted rows. If the count is greater than one, the inserted rows have to be one after the other. <p> <member>ListAction::ActionInfo</member> could contain something but @@ -137,7 +139,7 @@ constants ListActionType <p>The members <member>ListAction::ListActionType</member>, <member>ListAction::Count</member> and <member>ListAction::Position</member> - are useless. + are ignored. */ const long CLEARED = 23; @@ -169,9 +171,9 @@ constants ListActionType rows with modified properties have to be one after the other. <p> <member>ListAction::ActionInfo</member> could contain something but - this is not required. - E.g it could contain the new properties (i.e. for remote optimizing), - but this is not required nor unrestrictly recommended. + this is not required. For example, it could contain the new properties + (i.e. for remote optimizing), but this is not required nor unrestrictly + recommended. <p>@todo ... further description of allowed contents for <member>ListAction::ActionInfo</member> is needed diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 80a21f163517..0b5ae0ce32fe 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.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2002-07-30 10:41:19 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/PackageFolderContent.idl b/offapi/com/sun/star/ucb/PackageFolderContent.idl index 954c1e8f7053..9507be343485 100644 --- a/offapi/com/sun/star/ucb/PackageFolderContent.idl +++ b/offapi/com/sun/star/ucb/PackageFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageFolderContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl index 47ce061b68df..f759c4c83a1d 100644 --- a/offapi/com/sun/star/ucb/PackageStreamContent.idl +++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: PackageStreamContent.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:02 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl index 44906f7ebefa..c5b86e0da14a 100644 --- a/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/RemoteContentProviderAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: RemoteContentProviderAcceptor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: sb $ $Date: 2001-02-12 09:35:09 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,12 +80,13 @@ service RemoteContentProviderAcceptor interface XRemoteContentProviderAcceptor; //------------------------------------------------------------------------ - /** This optional interface can be used to adopt a layz implement strategy + /** This optional interface can be used to adopt a lazy implement strategy for this service, which can improve performance in certain situations. + <p>The way this works might change, therefore this interface is marked + as deprectated. + @deprecated - The way this works might change, therefore this interface is marked as - deprectated. */ [optional] interface XRemoteContentProviderActivator; }; diff --git a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl index 571670cb0138..05d33fa73543 100644 --- a/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl +++ b/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: RemoteProxyContentProvider.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,9 +79,10 @@ interface XParameterizedContentProvider; <type>RemoteContentProviderAcceptor</type> and <type>XRemoteContentProviderActivator</type> for more information). - @deprecated - The way this works might change, therefore this interface is marked as + <p>The way this works might change, therefore this interface is marked as deprectated. + + @deprecated */ service RemoteProxyContentProvider { diff --git a/offapi/com/sun/star/ucb/TransferCommandOperation.idl b/offapi/com/sun/star/ucb/TransferCommandOperation.idl index ef40f3a4c425..1cccbd0b62d5 100644 --- a/offapi/com/sun/star/ucb/TransferCommandOperation.idl +++ b/offapi/com/sun/star/ucb/TransferCommandOperation.idl @@ -2,9 +2,9 @@ * * $RCSfile: TransferCommandOperation.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:25 $ * * 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 { //============================================================================= /** These are the possible values for - <member>GlobalTransferCommandArgument::Operation</type>. + <member>GlobalTransferCommandArgument::Operation</member>. */ enum TransferCommandOperation { diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index ca47c6d7d0ce..8be2db163085 100644 --- a/offapi/com/sun/star/ucb/UniversalContentBroker.idl +++ b/offapi/com/sun/star/ucb/UniversalContentBroker.idl @@ -2,9 +2,9 @@ * * $RCSfile: UniversalContentBroker.idl,v $ * - * $Revision: 1.13 $ + * $Revision: 1.14 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl index 540189d26e50..11930a0101c0 100644 --- a/offapi/com/sun/star/ucb/WebDAVContentProvider.idl +++ b/offapi/com/sun/star/ucb/WebDAVContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVContentProvider.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,9 +74,9 @@ module com { module sun { module star { module ucb { for the <type>UniversalContentBroker</type> (UCB). <p>It provides access to WebDAV and standard HTTP servers. The DCP - communicates with the server using the <a href="www.webdav.org">WebDAV</a> - protocol which is an extention to the HTTP protocol or using the plain HTTP - protocol in case the server is not WebDAV enabled. + communicates with the server using the WebDAV protocol which is an + extention to the HTTP protocol or using the plain HTTP protocol in case + the server is not WebDAV enabled. @see com::sun::star::ucb::Content */ diff --git a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl index 37c19687fa8d..fe8359f9d136 100644 --- a/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVDocumentContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVDocumentContent.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl index ec984be979c7..20fa138feb37 100644 --- a/offapi/com/sun/star/ucb/WebDAVFolderContent.idl +++ b/offapi/com/sun/star/ucb/WebDAVFolderContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: WebDAVFolderContent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: obo $ $Date: 2002-08-19 16:15:03 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses diff --git a/offapi/com/sun/star/ucb/XAnyCompare.idl b/offapi/com/sun/star/ucb/XAnyCompare.idl index cbf3c0889fd5..eb3ee2f7ffc4 100644 --- a/offapi/com/sun/star/ucb/XAnyCompare.idl +++ b/offapi/com/sun/star/ucb/XAnyCompare.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAnyCompare.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** compares two <type scope="com::sun::star::uno">Any</type>s. +/** compares two <atom>any</atom>s. */ interface XAnyCompare: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** allows comparision of two <type scope="com::sun::star::uno">Any</type>s. + /** allows comparision of two <atom>any</atom>s. @param Any1 is the first compare value diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl index 2c9d8fff1a3a..e798c4a3b4a9 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -84,7 +84,8 @@ module com { module sun { module star { module ucb { interface XCachedContentResultSetFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a remote optimized <type>XResultSet</type>. + /** creates a remote optimized + <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource must be an instance of service <type>CachedContentResultSetStub</type>. diff --git a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl index 3206daf547ac..cffe2c100b9c 100644 --- a/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedContentResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedContentResultSetStubFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * 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 { interface XCachedContentResultSetStubFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a remote optimized <type>XResultSet</type>. + /** creates a remote optimized + <type scope="com::sun::star::sdbc">XResultSet</type>. @param xSource must be an instance of service <type>ContentResultSet</type>. diff --git a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl index 0ebcf134967c..387a7fc2f999 100644 --- a/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl +++ b/offapi/com/sun/star/ucb/XCachedDynamicResultSetStubFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCachedDynamicResultSetStubFactory.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,8 +89,9 @@ module com { module sun { module star { module ucb { <p>Pay attention to instanciate this helper on serverside where your source <type>DynamicResultSet</type> was instanciated. - <p>Method <method>createCachedDynamicResultSetStub</method> can be used to - create a stub on serverside. + <p>Method + <member>XCachedDynamicResultSetStubFactory::createCachedDynamicResultSetStub</member> + can be used to create a stub on serverside. <p>If you have instanciated a <type>CachedDynamicResultSet</type> on client side already, use method <member>connectToCache</member> to connect your diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index a750ee97f228..caaeedaca019 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandProcessor.idl,v $ * - * $Revision: 1.9 $ + * $Revision: 1.10 $ * - * last change: $Author: kso $ $Date: 2002-06-21 12:43:20 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,7 +89,6 @@ module com { module sun { module star { module ucb { @version 1.0 @author Kai Sommerfeld - @deprecated @see com::sun::star::ucb::XCommandProcessor2 for the improved version of this interface. @@ -110,11 +109,11 @@ interface XCommandProcessor : com::sun::star::uno::XInterface only should get one identifier per thread and assign it to every command executed by that thread.</p> - <p>Also, after a call to <method>abort</method>, an identifier should - not be used any longer (and instead be released by a call to - <member>XCommandProcessor2::releaseCommandIdentifier</member>), + <p>Also, after a call to <member>XCommandProcessor::abort</member>, an + identifier should not be used any longer (and instead be released by a + call to <member>XCommandProcessor2::releaseCommandIdentifier</member>), because it may well abort <em>all</em> further calls to - <method>execute</method>.</p> + <member>XCommandProcessor::execute</member>.</p> <p>To avoid ever-increasing resource consumption, the identifier should be released via diff --git a/offapi/com/sun/star/ucb/XCommandProcessor2.idl b/offapi/com/sun/star/ucb/XCommandProcessor2.idl index e2615ec4cf15..4400868a1472 100644 --- a/offapi/com/sun/star/ucb/XCommandProcessor2.idl +++ b/offapi/com/sun/star/ucb/XCommandProcessor2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandProcessor2.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: sb $ $Date: 2001-08-20 15:30:43 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:27 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -77,20 +77,23 @@ interface XCommandProcessor2: com::sun::star::ucb::XCommandProcessor { //------------------------------------------------------------------------ /** releases a command identifier obtainded through - <method>createCommandIdentifier</method> when it is no longer used. + <member>XCommandProcessor::createCommandIdentifier</member> when it is + no longer used. <p>After this call the command identifier cannot be used any longer in - calls to <method>execute</method> and <method>abort</method>. (But it - can happen that a call to <method>createCommandIdentifier</method> + calls to <member>XCommandProcessor::execute</member> and + <member>XCommandProcessor::abort</member>. (But it can happen that a + call to <member>XCommandProcessor::createCommandIdentifier</member> reuses this identifier.)</p> @param CommandId A command identifier obtained through - <method>createCommandIdentifier</method>. If the identifier is zero, - the request is silently ignored; but if the identifier is invalid (not - obtained via <method>createCommandIdentifier</method> or already - handed to <method>releaseCommandIdentifier</method> before), the - behaviour is undefined. + <member>XCommandProcessor::createCommandIdentifier</member>. If the + identifier is zero, the request is silently ignored; but if the + identifier is invalid (not obtained via + <member>XCommandProcessor::createCommandIdentifier</method> or already + handed to <member>XCommandProcessor2::releaseCommandIdentifier</member> + before), the behaviour is undefined. */ [oneway] void releaseCommandIdentifier([in] long CommandId); }; diff --git a/offapi/com/sun/star/ucb/XContentTransmitter.idl b/offapi/com/sun/star/ucb/XContentTransmitter.idl index c7dc466f7a05..ee3245e4f1ca 100644 --- a/offapi/com/sun/star/ucb/XContentTransmitter.idl +++ b/offapi/com/sun/star/ucb/XContentTransmitter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentTransmitter.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** + @deprecated @version 1.0 @author Dirk Voelzke diff --git a/offapi/com/sun/star/ucb/XDataContainer.idl b/offapi/com/sun/star/ucb/XDataContainer.idl index 059d945a9d13..cdf5e16a4aee 100644 --- a/offapi/com/sun/star/ucb/XDataContainer.idl +++ b/offapi/com/sun/star/ucb/XDataContainer.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDataContainer.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,6 +79,8 @@ module com { module sun { module star { module ucb { @version 1.0 @author Kai Sommerfeld + + @deprecated */ interface XDataContainer: com::sun::star::container::XIndexContainer { diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index ffd31b58beca..dbec07c2126c 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSet.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDynamicResultSet.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -105,7 +105,8 @@ module com { module sun { module star { module ucb { about changes on a <type>ContentResultSet</type> and have an listener-controlled update from one version to the next version. Two <type>ContentResultSet</type> implementations were given to the listener in - the first notification as interface <type>XResultSet</type>. + the first notification as interface + <type scope="com::sun::star::sdbc">XResultSet</type>. </p> <p> @@ -130,7 +131,7 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access both ContentResultSets, + <li> The listener is allowed to access both <type>ContentResultSet</type>s, they must be both valid.</li> <li> It is not allowed to start a second notify-call.</li> <li> All addditional things we want to send as notification are to be @@ -143,10 +144,11 @@ module com { module sun { module star { module ucb { </p> <ol> - <li> The listener is allowed to access the new ContentResultSet. - The new one is first assigned in the WELCOME-event and than - the ResultSets are always swapped.</li> - <li> The listener is not allowed to access the old ContentResultSet.</li> + <li> The listener is allowed to access the new + <type>ContentResultSet</type>. The new one is first assigned in the + WELCOME-event and than the ResultSets are always swapped.</li> + <li> The listener is not allowed to access the old + <type>ContentResultSet</type>.</li> </ol> */ @@ -156,8 +158,9 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent /** Call this, if you don't care about any changes. @returns - an <type>XResultSet</type> that is implemented as - <type>ContentResultSet</type>. Its content will never change. + an <type scope="com::sun::star::sdbc">XResultSet</type> that is + implemented as <type>ContentResultSet</type>. Its content will never + change. @trows ListenerAlreadySetException if someone already has registered as listener via diff --git a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl index 4f22947bfbf2..3feaaf605d07 100644 --- a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl +++ b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XDynamicResultSetListener.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:28 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -83,12 +83,13 @@ interface XDynamicResultSetListener: com::sun::star::lang::XEventListener /** A method used to propagate changes of a resultset. <p>In the first notify-call the listener gets two(!) - <type>XResultSet</type>s and has to hold them. The - <type>XResultSet</type>s are implementations of the service - <type>ContentResultSet</type>. + <type scope="com::sun::star::sdbc">XResultSet</type>s and has to hold + them. The <type scope="com::sun::star::sdbc">XResultSet</type>s are + implementations of the service <type>ContentResultSet</type>. - <p>The notified new <type>XResultSet</type> will stay valid after - returning from this method. The old one will become invalid after + <p>The notified new + <type scope="com::sun::star::sdbc">XResultSet</type> will stay valid + after returning from this method. The old one will become invalid after returning. <p>While in notify-call the listener is allowed to read from old and diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index b2892196ea5c..3efcf7c8e4e6 100644 --- a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl +++ b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionHandlerSupplier.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,20 +71,23 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This interface should be implemented by an interbnal XCommandEnvironment - that can not supply an <type>XInteractionHandler</type>, but instead wants - interaction requests to be handled by other internal error handling +/** This interface should be implemented by an internal + <type>XCommandEnvironment</type> that can not supply an + <type scope="com::sun::star::task">XInteractionHandler</type>, but instead + wants interaction requests to be handled by other internal error handling mechanism. - - @see XCommandEnvironment. */ interface XInteractionHandlerSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Returns whether an <type>XInteractionHandler</type> can be supplied. + /** Returns whether an + <type scope="com::sun::star::task">XInteractionHandler</type> can be + supplied. @returns - <TRUE/>, if an XInteractionHandler can be supplied, <FALSE/> otherwise. + <TRUE/>, if an + <type scope="com::sun::star::task">XInteractionHandler</type> can be + supplied, <FALSE/> otherwise. */ boolean hasInteractionHandler(); }; diff --git a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl index d58489add5f6..b62d9ae4e4bd 100644 --- a/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl +++ b/offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionSupplyAuthentication.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,8 +90,11 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'realm' value to hand back. - <p> This method should be called before select(), and should only - be called if canSetRealm() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetRealm</member> returned + <true/>.</p> */ void setRealm( [in] string Realm ); @@ -103,8 +106,11 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'user name' value to hand back. - <p>This method should be called before select(), and should only - be called if canSetUserName() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetUserName</member> + returned <true/>.</p> */ void setUserName( [in] string UserName ); @@ -116,31 +122,39 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'password' value to hand back. - <p>This method should be called before select(), and should only - be called if canSetPassword() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetPassword</member> + returned <true/>.</p> */ void setPassword( [in] string Password ); //------------------------------------------------------------------------- /** Specifies the available modes of how long to remember the password. - @param Default Returns the default mode (to be initially displayed to - the user). + @param Default + Returns the default mode (to be initially displayed to the user). - @returns A sequence of available modes to hand back. Each individual - mode should appear at most once in the sequence. If the sequence is - empty, a new mode cannot be handed back. + @returns + A sequence of available modes to hand back. Each individual mode + should appear at most once in the sequence. If the sequence is empty, + a new mode cannot be handed back. */ sequence<com::sun::star::ucb::RememberAuthentication> getRememberPasswordModes( [out] com::sun::star::ucb::RememberAuthentication Default ); //------------------------------------------------------------------------- /** Set a new mode of how long to remember the password. - <p> This method should be called before select(), and should only - be called if setPassword() is also called. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::setPassword</member> + is also called.</p> - @param Remember The mode to hand back, should be contained in the - sequence returned by getRememberPasswordModes. + @param Remember + The mode to hand back, should be contained in the sequence returned by + <member>XInteractionSupplyAuthentication::getRememberPasswordModes</member>. */ void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember ); @@ -152,8 +166,12 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new 'account' value to hand back. - <p> This method should be called before select(), and should only - be called if canSetAccount() returned true. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::canSetAccount</member> + returned <true/>.</p> + */ void setAccount( [in] string Account ); @@ -172,11 +190,15 @@ interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionCo //------------------------------------------------------------------------- /** Set a new mode of how long to remember the account. - <p> This method should be called before select(), and should only - be called if setAccount() is also called. </p> + <p>This method should be called before + <member scope="com::sun::star::task">XInteractionContinuation::select</member>, + and should only be called if + <member>XInteractionSupplyAuthentication::setAccount</member> + is also called.</p> @param Remember The mode to hand back, should be contained in the - sequence returned by getRememberAccountModes. + sequence returned by + <member>XInteractionSupplyAuthentication::getRememberAccountModes</member>. */ void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember ); diff --git a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl index a469322eca22..454f304b8381 100644 --- a/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl +++ b/offapi/com/sun/star/ucb/XParameterizedContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XParameterizedContentProvider.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -96,8 +96,9 @@ interface XParameterizedContentProvider: com::sun::star::uno::XInterface @param Arguments Any supplementary arguments required by this <type>XContentProvider</type>, represented as a single string. If the - input is malformed, an <type>IllegalArgumentException</type> may be - raised. + input is malformed, an + <type scope="com::sun::star::lang">IllegalArgumentException</type> + may be raised. @param ReplaceExisting If true, and if the given Template conflicts with an already registered instance, the old registration is replaced @@ -127,8 +128,9 @@ interface XParameterizedContentProvider: com::sun::star::uno::XInterface @param Arguments Any supplementary arguments required by this <type>XContentProvider</type>, represented as a single string. If the - input is malformed, an <type>IllegalArgumentException</type> may be - raised. + input is malformed, an + <type scope="com::sun::star::lang">IllegalArgumentException</type> + may be raised. @return Either this <type>XContentProvider</type>, or another, specially adjusted version of this <type>XContentProvider</type> (this diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl index d0fe664fa960..a04839fd7b2c 100644 --- a/offapi/com/sun/star/ucb/XProgressHandler.idl +++ b/offapi/com/sun/star/ucb/XProgressHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProgressHandler.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,12 +82,14 @@ interface XProgressHandler: com::sun::star::uno::XInterface @param Status An object representing the new activity. There has to be an agreement between caller and callee of methods - <member>push</member> and <member>update</member> as to which Status - arguments are meaningful. For example, a <type>string</type> argument - to <member>push</member> should be used to transport some status text - that describes the progress being made (possibly followed by one or - more <member>update</member>s with <type>string</type> arguments, if - the appropriate status text changes as progress is being made). + <member>XProgressHandler::push</member> and + <member>XProgressHandler::update</member> as to which Status + arguments are meaningful. For example, a <atom>string</atom> argument + to <member>XProgressHandler::push</member> should be used to transport + some status text that describes the progress being made (possibly + followed by one or more <member>XProgressHandler::update</member>s with + <atom>string</atom> arguments, if the appropriate status text changes + as progress is being made). */ void push([in] any Status); @@ -96,7 +98,8 @@ interface XProgressHandler: com::sun::star::uno::XInterface progress. @param Status An object representing the progress made. See the - documentation of <member>push</member> for more information. + documentation of <member>XProgressHandler::push</member> for more + information. */ void update([in] any Status); diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl index 4a2448697906..83f2d7c003b1 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderAcceptor.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: sb $ $Date: 2001-03-20 13:31:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -100,12 +100,13 @@ interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface @param DoneListener If not null, the implementation of this interface can---through this callback---tell the calling side that the implementation no longer needs the remote content provider. (And the - calling side should call <member>removeRemoteContentProvider</member> + calling side should call + <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member> then.) To enable connection control, it is recommended that this argument also implements the interface - <type scope="com::sun::star::ucb">XRemoteContentProviderConnectionControl</type>. + <type>XRemoteContentProviderConnectionControl</type>. @return true if the remote content provider has successfully been added. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl index 3c8c4e839666..dde48e3cf20e 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderActivator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderActivator.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:29 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,29 +72,30 @@ interface XContentProviderManager; //============================================================================ /** This interface should be implemented together with - <type scope="com::sun::star::ucb">XRemoteContentProviderAcceptor</type> - and allows for a lazy implementation of - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>. + <type>XRemoteContentProviderAcceptor</type> and allows for a lazy + implementation of + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. - @deprecated The way this works might change, therefore this interface is marked as deprectated. + + @deprecated */ interface XRemoteContentProviderActivator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** Activate (i.e., register at the broker) the remote content providers that until now have only been remembered by - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>, but not registered. + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>, + but not registered. <p>This allows for - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method> + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member> to be implemented in a layz fashion (remember the remote content providers, but do not register them right away), which can increase performance in certain situations. But it is not required that an - implementation of - <type scope"com::sun::star::ucb">XRemoteContentProviderAcceptor</type> - uses this lazy strategy (and thus also implements this interface). + implementation of <type>XRemoteContentProviderAcceptor</type> uses this + lazy strategy (and thus also implements this interface). @return the broker at which the remote content providers have been registered. diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl index 8ea22618948c..e761088697ce 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderChangeNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderChangeNotifier.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-03-21 16:45:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,8 +73,7 @@ module com { module sun { module star { module ucb { module com { module sun { module star { module ucb { //============================================================================ -/** Notify about changes to a - <type scope="com::sun::star::ucb">XRemoteContentProviderSupplier</type>. +/** Notify about changes to a <type>XRemoteContentProviderSupplier</type>. @version 1.0 @author Stephan Bergmann @@ -97,7 +96,7 @@ interface XRemoteContentProviderChangeNotifier: @param Listener. Some listener previously added via - <method>addRemoteContentProviderChangeListener</method>. + <member>XRemoteContentProviderChangeNotifier::addRemoteContentProviderChangeListener</member>. */ void removeRemoteContentProviderChangeListener( diff --git a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl index 1f60852ef30f..6df2873d50d2 100644 --- a/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl +++ b/offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRemoteContentProviderConnectionControl.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: kso $ $Date: 2001-06-14 10:39:37 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,9 +76,9 @@ module com { module sun { module star { module ucb { /** A simple mechanism to find out if the connection between a remote content provider distributor and acceptor gets lost. - <p>This interface should be supported by the <code>DoneListener</code> + <p>This interface should be supported by the <var>DoneListener</var> parameter of - <method scope="com::sun::star::ucb::XRemoteContentProviderAcceptor">addRemoteContentProvider</method>. + <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>. @version 1.0 @author Stephan Bergmann diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl index 4c85290bdb7f..880413e3e5c0 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleFileAccess.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: kso $ $Date: 2001-12-07 14:28:48 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -277,7 +277,7 @@ interface XSimpleFileAccess: com::sun::star::uno::XInterface <type>UnsupportedDataSinkException</type>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources - <method>XSimpleFileAccess2::writeFile</method> may be used. + <member>XSimpleFileAccess2::writeFile</member> may be used. */ com::sun::star::io::XOutputStream openFileWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); @@ -295,7 +295,7 @@ interface XSimpleFileAccess: com::sun::star::uno::XInterface <type>UnsupportedDataSinkException</type>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources - <method>XSimpleFileAccess2::writeFile</method> may be used. + <member>XSimpleFileAccess2::writeFile</member> may be used. */ com::sun::star::io::XStream openFileReadWrite( [in] string FileURL ) raises( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ); diff --git a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl index 2fdec149f11f..cc617b8e9aeb 100644 --- a/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl +++ b/offapi/com/sun/star/ucb/XSimpleFileAccess2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSimpleFileAccess2.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: kso $ $Date: 2001-12-07 14:57:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:30 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,7 +79,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** This is the basic interface to read data from a stream. +/** This is an extension to the interface <type>XSimpleFileAccess</type>. */ interface XSimpleFileAccess2 : com::sun::star::ucb::XSimpleFileAccess { |