diff options
| author | Kai Sommerfeld <kso@openoffice.org> | 2001-02-09 12:05:26 +0000 |
|---|---|---|
| committer | Kai Sommerfeld <kso@openoffice.org> | 2001-02-09 12:05:26 +0000 |
| commit | ea980662116fe809e7569c6fb944e11cb373c6d2 (patch) | |
| tree | 622e63f28c53d4facd8aa9cbed795bb4fefc8a06 | |
| parent | a35403156851e5f97829c14fe5854a3c6fc44bd9 (diff) | |
Updated/reformatted documentation.
29 files changed, 433 insertions, 319 deletions
diff --git a/offapi/com/sun/star/ucb/ContentProvider.idl b/offapi/com/sun/star/ucb/ContentProvider.idl index 1804b125adf1..fcb73c5e8353 100644 --- a/offapi/com/sun/star/ucb/ContentProvider.idl +++ b/offapi/com/sun/star/ucb/ContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentProvider.idl,v $ * - * $Revision: 1.10 $ + * $Revision: 1.11 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -113,20 +113,6 @@ service ContentProvider */ [optional] interface com::sun::star::ucb::XParameterizedContentProvider; - //------------------------------------------------------------------------- - /** allows the implementation of a proxy object for a content provider. - - <p>The content provider returned by the implementation of this interface - will be the original provider. Implementing a content provider proxy - can be useful if the creation of the real content provider object - shall be deferred for some reason until the first method gets called - on it (i.e. performance). - - <p><b>It is highly recommended to support this interface.</b> - - @see ContentProviderProxy - */ - [optional] interface com::sun::star::ucb::XContentProviderSupplier; }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/ContentProviderProxy.idl b/offapi/com/sun/star/ucb/ContentProviderProxy.idl index 0b301bd11bf3..3f792d63f691 100644 --- a/offapi/com/sun/star/ucb/ContentProviderProxy.idl +++ b/offapi/com/sun/star/ucb/ContentProviderProxy.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentProviderProxy.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-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,15 +79,34 @@ module com { module sun { module star { module ucb { //============================================================================= /** is a proxy for a content provider. + + <p>Implementing a content provider proxy can be useful if the creation of + the real content provider object shall be deferred for some reason + (i.e. performance) until the first method gets called on it. Instaead of + instanciating and registering the real provider at the UCB, a proxy for + the real provider can be created and registered at the UCB. + + @see XContentProviderProxyFactory */ service ContentProviderProxy { //------------------------------------------------------------------------- + /** The implementation of + <member scope="com::sun::star::uno">XInterface::queryInterface</member> + must instanciate the real provider and return the return value + of a queryInterface call at the real provider, except for queries + for the interfaces implemented by the proxy itself. So the caller of + the queryInterface method at the proxy will get access to the real + provider in a completely transparent way. + */ + interface com::sun::star::uno::XInterface; + + //------------------------------------------------------------------------- /** gives access to the original content provider behind the proxy. - <p>The implementation will instantiate the real content provider only on - demand using its UNO service name. This will load the content providers - implementation code (dynamic library), if not already done. + <p>The implementation will instantiate the real content provider only + on demand using its UNO service name. This will load the content + providers implementation code (dynamic library), if not already done. */ interface com::sun::star::ucb::XContentProviderSupplier; diff --git a/offapi/com/sun/star/ucb/XAnyCompare.idl b/offapi/com/sun/star/ucb/XAnyCompare.idl index 7ffe57e4faa7..18c04813c9ef 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,16 +85,16 @@ interface XAnyCompare: com::sun::star::uno::XInterface @param Any2 is the second compare value - @returns the following values: + @returns <ul> <li> - -1, if the first any is smaller than the second ( Any1 < Any2 ) + <code>-1</code>, if the first any is less than the second ( Any1 < Any2 ) </li> <li> - 0, if the first any is equal to the second ( Any1==Any2 ) + <code>0</code>, if the first any is equal to the second ( Any1 == Any2 ) </li> <li> - +1, if the first any is greater than the second ( Any1 > Any2 ) + <code>+1</code>, if the first any is greater than the second ( Any1 > Any2 ) </li> </ul> */ diff --git a/offapi/com/sun/star/ucb/XCommandEnvironment.idl b/offapi/com/sun/star/ucb/XCommandEnvironment.idl index c4befff1ca22..6bb5ba5aa318 100644 --- a/offapi/com/sun/star/ucb/XCommandEnvironment.idl +++ b/offapi/com/sun/star/ucb/XCommandEnvironment.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandEnvironment.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-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,21 +79,28 @@ module com { module sun { module star { module ucb { //============================================================================= -/** defines the environment of a command. +/** defines the environment for a command. @version 1.0 @author Kai Sommerfeld + @see XCommandProcessor */ [ uik(A95AD9A0-00A5-11d4-9F980050-04526AC8), ident( "XCommandEnvironment", 1.0 ) ] interface XCommandEnvironment : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** returns the command's interaction handler. + + @returns + an interaction handler */ com::sun::star::task::XInteractionHandler getInteractionHandler(); //------------------------------------------------------------------------- /** returns the command's progress handler. + + @returns + a progress handler */ com::sun::star::ucb::XProgressHandler getProgressHandler(); }; diff --git a/offapi/com/sun/star/ucb/XCommandInfo.idl b/offapi/com/sun/star/ucb/XCommandInfo.idl index dfe08c048821..55368a0fc6ac 100644 --- a/offapi/com/sun/star/ucb/XCommandInfo.idl +++ b/offapi/com/sun/star/ucb/XCommandInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandInfo.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-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,64 +79,73 @@ module com { module sun { module star { module ucb { //============================================================================= -/** provides access to information about executable commands. +/** provides access to information on a set of commands. @version 1.0 @author Kai Sommerfeld - @see XCommandTask */ [ uik(E2281A13-33D6-11D1-AABE00A0-249D5590), ident( "XCommandInfo", 1.0 ) ] interface XCommandInfo: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** @returns - a sequence of all commands supported by the object. + /** obtains information for all supported commands. + + @returns + a sequence with information for all supported commands. */ [const] sequence<com::sun::star::ucb::CommandInfo> getCommands(); //------------------------------------------------------------------------- - /** @returns - the command with the specified name from the object. + /** returns information for a specific command. + + @returns + the information for the requested command. @param Name - specifies the name of the command. + specifies the name of the requested command. @throws UnsupportedCommandException - if the command name is unknown to the object. + if the command is not supported. */ [const] com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name ) raises( com::sun::star::ucb::UnsupportedCommandException ); //------------------------------------------------------------------------- - /** @returns - the command with the specified handle from the object. + /** returns information for a specific command. + + @returns + the information for the requested command. @param Handle - specifies the handle of the command. + specifies the handle of the requested command. @throws UnsupportedCommandException - if the command handle is unknown to the object. + if the command is not supported. */ [const] com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle ) raises( com::sun::star::ucb::UnsupportedCommandException ); //------------------------------------------------------------------------- - /** @returns + /** checks whether a command specific is supported. + + @returns <TRUE/> if a command with the specified name is supported; otherwise <FALSE/> is returned. @param Name - specifies the name of the command. + specifies the name of the requested command. */ [const] boolean hasCommandByName( [in] string Name ); //------------------------------------------------------------------------- - /** @returns + /** checks whether a apecific command is supported. + + @returns <TRUE/> if a command with the specified handle is supported; otherwise <FALSE/> is returned. @param Name - specifies the handle of the command. + specifies the handle of the requested command. */ [const] boolean hasCommandByHandle( [in] long Handle ); diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl index dc93e4c4e943..eb89770e9df9 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandInfoChangeListener.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:19:06 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** a listener for events related to <type>XCommandInfo</type>s. +/** a listener for events related to changing <type>XCommandInfo</type>s. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl index 334f952e0609..0b061b209602 100644 --- a/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl +++ b/offapi/com/sun/star/ucb/XCommandInfoChangeNotifier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCommandInfoChangeNotifier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:19:06 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * 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 { //============================================================================= -/** a notifier for changes of <type>XCommandInfo</type>s. +/** a notifier for changes of <type>XCommandInfo</type>s. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XCommandProcessor.idl b/offapi/com/sun/star/ucb/XCommandProcessor.idl index 1dadacdf0b07..4ec30f83b4d1 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,45 +90,52 @@ module com { module sun { module star { module ucb { @author Kai Sommerfeld @see Command @see XCommandEnvironment + @see XContent */ [ uik(F4CAAD40-00A5-11d4-9F980050-04526AC8), ident( "XCommandProcessor", 1.0 ) ] interface XCommandProcessor : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a unique identifier for a command, which can be used to - abort the execution of the command accociated with that identifier. - Note that it is generally not necessary to obtain a new id for each - command, because commands are executed synchronously. So the id - for a command is valid again after a command previously associated - with this id has finished. In fact you only should get one identifier - per thread and assign it to every command executed by that thread. + /** creates a unique identifier for a command. + + <p>This identifier can be used to abort the execution of the command + accociated with that identifier. Note that it is generally not + necessary to obtain a new id for each command, because commands are + executed synchronously. So the id for a command is valid again after a + command previously associated with this id has finished. In fact you + only should get one identifier per thread and assign it to every + command executed by that thread. + + @returns + a command identifier. */ long createCommandIdentifier(); //------------------------------------------------------------------------- /** executes a command. + <p>Common command definitions can be found in the soecification of the + service <type>Content</type>. + @param aCommand - The command to execute. + is the command to execute. @param CommandId - A unique id for the command. This identifier was obtained by calling - <type>XCommandProcessor::createCommandIdentifier</type>. A value of - Zero can be used, if the command never shall be aborted. + is a unique id for the command. This identifier was obtained by calling + <member>XCommandProcessor::createCommandIdentifier</member>. A value of + zero can be used, if the command never shall be aborted. @param Environment - The execution environment. + is the execution environment. - @return - The result according to the specification of the command. + @returns + the result according to the specification of the command. @throws CommandAbortedException - thrown to indicate that the command was aborted. + to indicate that the command was aborted. @throws Exception - Different exceptions are thrown to indicate errors during - execution of the command. - + if an error occured during the execution of the command. */ any execute( [in] Command aCommand, [in] long CommandId, @@ -139,8 +146,8 @@ interface XCommandProcessor : com::sun::star::uno::XInterface /** ends the command associated with the given id. @param CommandId - A unique id for the command to abort. This must be the identifier - passed to <type>XCommandProcessor::execute</type> for the command + is a unique id for the command to abort. This must be the identifier + passed to <member>XCommandProcessor::execute</member> for the command to abort. */ [oneway] void abort( [in] long CommandId ); diff --git a/offapi/com/sun/star/ucb/XContent.idl b/offapi/com/sun/star/ucb/XContent.idl index 4bb8351b67bd..ac42559ad31f 100644 --- a/offapi/com/sun/star/ucb/XContent.idl +++ b/offapi/com/sun/star/ucb/XContent.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:19:06 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,8 +79,8 @@ module com { module sun { module star { module ucb { //============================================================================= -/** specifies a content with a type and an identifier, - which is able to manage listeners for special content events. +/** specifies a content with a type and an identifier, which is able to manage + listeners for events that are related to contents. @version 1.0 @author Kai Sommerfeld @@ -99,7 +99,8 @@ interface XContent: com::sun::star::uno::XInterface com::sun::star::ucb::XContentIdentifier getIdentifier(); //------------------------------------------------------------------------- - /** returns a content type string ( i.e. a MIME type ). + /** returns a type string, which is unique for that type of content (e.g. + "application/vnd.sun.star.hierarchy-folder"). @returns the content type string. @@ -111,16 +112,22 @@ interface XContent: com::sun::star::uno::XInterface @param Listener the listener to add. + + @see ContentEvent */ - [oneway] void addContentEventListener( [in] com::sun::star::ucb::XContentEventListener Listener ); + [oneway] void addContentEventListener( + [in] com::sun::star::ucb::XContentEventListener Listener ); //------------------------------------------------------------------------- /** removes a listener for content events. @param Listener the listener to remove. + + @see ContentEvent */ - [oneway] void removeContentEventListener( [in] com::sun::star::ucb::XContentEventListener Listener ); + [oneway] void removeContentEventListener( + [in] com::sun::star::ucb::XContentEventListener Listener ); }; diff --git a/offapi/com/sun/star/ucb/XContentAccess.idl b/offapi/com/sun/star/ucb/XContentAccess.idl index 16b6ab60e9eb..dbd8a19e1ee9 100644 --- a/offapi/com/sun/star/ucb/XContentAccess.idl +++ b/offapi/com/sun/star/ucb/XContentAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentAccess.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-01-15 10:19:07 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,11 +75,12 @@ interface XContentIdentifier; //============================================================================= /** specifies methods for obtaining information on a content in different levels. - <p>In example, if there is a cursor which points to <type>XContent</type>s, + + <p>For example, if there is a cursor which points to <type>XContent</type>s, this interface could be used to give the user access to the content under the cursor. If the client only needs the identifier string of the content, there is no need to first create the content object, then to obtain the - string from it and after that to release the content.</p> + string from it and after that to release the content. @version 1.0 @author Kai Sommerfeld @@ -92,12 +93,13 @@ interface XContentAccess : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** returns the identifier string of the content ( "cheap method" ). - Note that this string can be used later to recreate the content. + + <p>Note that this string can be used later to recreate the content. @returns the identifier string. */ - string queryContentIdentifierString(); + string queryContentIdentifierString(); //------------------------------------------------------------------------- /** returns the identifier object of the content. @@ -113,7 +115,7 @@ interface XContentAccess : com::sun::star::uno::XInterface @returns the content. */ - XContent queryContent(); + XContent queryContent(); }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl index 9916cf815ec7..84e6f042903e 100644 --- a/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl +++ b/offapi/com/sun/star/ucb/XContentIdentifierMapping.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentIdentifierMapping.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-01-15 12:36:02 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,19 +73,18 @@ interface XContent; interface XContentIdentifier; //============================================================================= -/** A mapping from a (source) set of XContentIdentifiers to another (target) - set of XContentIdentifiers. +/** A mapping from a (source) set of <type>XContentIdentifier</type>s to + another (target) set of XContentIdentifiers. - <p> - For convenience and performance, mapping between the string representations - of source/target XContentIdentifiers, as well as mapping between XContents - identified by source/target XContentIdentifiers is also supported. - </p> + <p>For convenience and performance, mapping between the string + representations of source/target XContentIdentifiers, as well as mapping + between <type>XContent</type>s identified by source/target + XContentIdentifiers is also supported. - <p> This interface can be useful in cases where the identifieres (and - associated contents) returned by the various methods of an XContentAccess - need to be mapped to some other space of identifiers (and associated - contents). </p> + <p>This interface can be useful in cases where the identifieres (and + associated contents) returned by the various methods of an + <type>XContentAccess</type> need to be mapped to some other space of + identifiers (and associated contents). @see XContent @see XContentAccess @@ -96,7 +95,7 @@ interface XContentIdentifier; interface XContentIdentifierMapping: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Map the string representation of an XContentIdentifier. + /** Map the string representation of an <type>XContentIdentifier</type>. @param Source The string representation of an XContentIdentifier from the source set. @@ -109,7 +108,7 @@ interface XContentIdentifierMapping: com::sun::star::uno::XInterface string mapContentIdentifierString([in] string Source); //------------------------------------------------------------------------- - /** Map an XContentIdentifier. + /** Map an <type>XContentIdentifier</type>. @param Source An XContentIdentifier from the source set. @@ -121,7 +120,8 @@ interface XContentIdentifierMapping: com::sun::star::uno::XInterface XContentIdentifier mapContentIdentifier([in] XContentIdentifier Source); //------------------------------------------------------------------------- - /** Map the XContent identified by an XContentIdentifier. + /** Map the <type>XContent</type> identified by an + <type>XContentIdentifier</type>. @param Source The XContent identified by an XContentIdentifier from the source set. @@ -135,17 +135,17 @@ interface XContentIdentifierMapping: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Map the content identifiers (or related data) contained in the columns - of a com::sun::star::sdbc::XRow. + of a <type scope="com::sun::star::sdbc">XRow</type>. @param Value On input, a sequence of anys corresponding to the columns - of the com::sun::star::sdbc::XRow (the first column goes into the - zeroth position of the sequence, and so on). On output, the same - sequence, but with the entries mapped as necessary. This is an inout - parameter rather than a comination of in parameter and return value for - performance reasons (assuming that in most cases most elements in the - input sequence will be returned unmodified). - - @returns True if any of the columns contain data that (potentially) + of the XRow (the first column goes into the zeroth position of the + sequence, and so on). On output, the same sequence, but with the + entries mapped as necessary. This is an inout parameter rather than a + comination of in parameter and return value for performance reasons + (assuming that in most cases most elements in the input sequence will + be returned unmodified). + + @returns <TRUE/> if any of the columns contain data that (potentially) needs mapping (though maybe no mapping occured for the concrete input data of this call). This information can be useful to decide whether, for another row, a call to this function is at all necessary. diff --git a/offapi/com/sun/star/ucb/XContentProvider.idl b/offapi/com/sun/star/ucb/XContentProvider.idl index 5d2dd5c0ce53..1024473efab0 100644 --- a/offapi/com/sun/star/ucb/XContentProvider.idl +++ b/offapi/com/sun/star/ucb/XContentProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentProvider.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-19 16:03:51 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** a content provider which creates objects of a special kind. +/** a content provider which creates and manages <type>XContent</type>s. @version 1.0 @author Kai Sommerfeld @@ -93,8 +93,9 @@ module com { module sun { module star { module ucb { interface XContentProvider: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a new UCB content, if the given identifier matches the - content provided by the implementation of this interface. + /** creates a new <type>XContent</type> instance, if the given + <typeXContentIdentifier</type> matches a content provided by the + implementation of this interface. @param Identifier an identifier for the content to query. @@ -102,17 +103,16 @@ interface XContentProvider: com::sun::star::uno::XInterface @returns the content. - @throws - <TYPE>IllegalIdentifierException</TYPE> is thrown, if the given - identifier does not match a content provided by the implementation - of this interface + @throws IllegalIdentifierException + if the given identifier does not match a content provided by the + implementation of this interface */ com::sun::star::ucb::XContent queryContent( [in] com::sun::star::ucb::XContentIdentifier Identifier ) raises ( com::sun::star::ucb::IllegalIdentifierException ); //------------------------------------------------------------------------- - /** compares two XContentIdentifier's. + /** compares two <type>XContentIdentifier</type>s. @param Id1 first content identifier. diff --git a/offapi/com/sun/star/ucb/XContentProviderFactory.idl b/offapi/com/sun/star/ucb/XContentProviderFactory.idl index bf9b14b042cc..f715f7cf866c 100644 --- a/offapi/com/sun/star/ucb/XContentProviderFactory.idl +++ b/offapi/com/sun/star/ucb/XContentProviderFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentProviderFactory.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-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** a factory for a content provider. +/** a factory for a <type>XContentProvider</type>. @version 1.0 @author Kai Sommerfeld @@ -84,11 +84,11 @@ module com { module sun { module star { module ucb { interface XContentProviderFactory : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** creates a content provider implementation object. + /** creates a <type>XContentProvider</type> implementation object. @param Service the name of the UNO service to be used to create the implementation of - the <type>XContentProvider</type>. + the content provider. @returns a content provider. diff --git a/offapi/com/sun/star/ucb/XDataContainer.idl b/offapi/com/sun/star/ucb/XDataContainer.idl index e86b793ca210..c79fe13f03e4 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * 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 { <p>A data container may contain data and/or other data containers. A typical container with children is a MIME message with - attachments.</P> + attachments. @version 1.0 @author Kai Sommerfeld @@ -84,34 +84,50 @@ module com { module sun { module star { module ucb { interface XDataContainer: com::sun::star::container::XIndexContainer { //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XDataContainer::getContentType + /** returns the content type (MIME Type) of the data container. + + @returns + the content type + */ [const] string getContentType(); //------------------------------------------------------------------------- /** sets the content type (MIME Type) of the data container. + + @param aType + the content type */ void setContentType( [in] string aType ); //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XDataContainer::getData + /** returns the data of the data container. + + @returns + the data + */ [const] sequence<byte> getData(); //------------------------------------------------------------------------- - /** sets the data of the data container. It can be used - <B>alternatively</B> to the "DataURL" methods. + /** sets the data of the data container. + + @param aData + the data */ void setData( [in] sequence<byte> aData ); //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XDataContainer::getDataURL + /** Deprecated. Do not use! + + @deprecated + */ [const] string getDataURL(); //------------------------------------------------------------------------- - /** sets a file-URL for the data. It can be used - <B>alternatively</B> to the data methods. + /** Deprecated. Do not use! + + @deprecated */ void setDataURL( [in] string aURL ); - }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/XDynamicResultSet.idl b/offapi/com/sun/star/ucb/XDynamicResultSet.idl index f24c1a772d42..a06a8061cfea 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.8 $ + * $Revision: 1.9 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:25 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -156,14 +156,15 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent //------------------------------------------------------------------------- /** Call this, if you don't care about any changes. - <p>The returned <type>XResultSet</type> is implemented as + @returns + an <type>XResultSet</type> that is implemented as <type>ContentResultSet</type>. Its content will never change. - <p>This method is not allowed to be called, if someone already has - registered as listener via <member>XDynamicResultSet::setListener</member> - or if someone has established a connection to a <type>CashedDynamicresultSet</type> + @trows ListenerAlreadySetException + if someone already has registered as listener via + <member>XDynamicResultSet::setListener</member> or if someone has + established a connection to a <type>CashedDynamicresultSet</type> via <member>XDynamicResultSet::connectToCache</member>. - Otherwise you get the Exception <type>ListenerAlreadySetException</type>. */ com::sun::star::sdbc::XResultSet getStaticResultSet() raises( com::sun::star::ucb::ListenerAlreadySetException ); @@ -171,18 +172,21 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent //------------------------------------------------------------------------- /** Call this, if you want to get notifications about changes. - <p>This method is only allowed to be called once, otherwise you get - the Exception <type>ListenerAlreadySetException</type> + <p>The implementor has to call + <member scope="com::sun::star::lang">XComponent::addEventListener</member> + in this method, so that we can call + <member scope="com::sun::star::lang">XEventListener::disposing</member> + at the listener - <p>This method is not allowed to be called, if someone already has - fetched the <type>ContentResultSet</type> via - <member>XDynamicResultSet::getStaticResultSet</member>. - Otherwise you get the Exception - <type>ListenerAlreadySetException</type>. + @param Listener + a listener for resultset notifications + + @throws ListenerAlreadySetException + if this method is called more than once during the life of the + implementation object or if this method is called if someone already + has fetched the <type>ContentResultSet</type> via + <member>XDynamicResultSet::getStaticResultSet</member>. - <p>The implementor has to call <member>XComponent::addEventListener</member> - in this method, so that we can call - <member>XEventListener::disposing</member> to the listener */ void setListener( [in] XDynamicResultSetListener Listener ) raises( com::sun::star::ucb::ListenerAlreadySetException ); @@ -191,41 +195,39 @@ interface XDynamicResultSet: com::sun::star::lang::XComponent /** Connects this to a <type>CachedDynamicResultSet</type> for optimized remote data transport. - <p><parameter>Cache<parameter> has to be an implementation of the - service <type>CachedDynamicResultSet</type>. In particular - <parameter>Cache<parameter> has to have an interface - <type>XSourceInitialization</type>. - <p>This method creates a <type>CachedDynamicResultSetStub</type> - and sets it as Source to the given <parameter>Cache</parameter>. + and sets it as Source to the given cache. <p>After this method has returned you can and have to use the given - result set <parameter>Cache</parameter> for further access. + result set cache for further access. - <p>This method is not allowed to be called, if someone already has - fetched the <type>ContentResultSet</type> via - <member>XDynamicResultSet::getStaticResultSet</member>. - Otherwise you get the Exception - <type>ListenerAlreadySetException</type>. + @param Cache + has to be an implementation of the service + <type>CachedDynamicResultSet</type>. In particular it has to support + the interface <type>XSourceInitialization</type>. - <p>You will get an <exception>AlreadyInitializedException</exception>, - if <parameter> Cache</parameter> was initialized with another source - already. + @throws ListenerAlreadySetException + if if someone already has fetched the <type>ContentResultSet</type> via + <member>XDynamicResultSet::getStaticResultSet</member>. + + @throws AlreadyInitializedException + if <var>Cache</var> was already initialized with another source. + + @throws ServiceNotFoundException */ void connectToCache( [in] XDynamicResultSet Cache ) raises( com::sun::star::ucb::ListenerAlreadySetException , com::sun::star::ucb::AlreadyInitializedException , com::sun::star::ucb::ServiceNotFoundException ); - //------------------------------------------------------------------------- - /** - With this method you can get information, wether the offered + /** Using this method you can get information, whether the offered <type>ContentResultSet</type>s are sorted or filtered etc correctly as demanded during the creation of the <type>XDynamicResultSet</type>. - The return-value may contain zero or more constants of the - <type>ContentResultSetCapability</type> constants group. + @returns + zero or more constants of the <type>ContentResultSetCapability</type> + constants group. */ short getCapabilities(); }; diff --git a/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl b/offapi/com/sun/star/ucb/XDynamicResultSetListener.idl index c897eb1db2f8..5b92fe7bd29f 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-01-15 13:22:25 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,42 +74,36 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The interface <type>XDynamicResultSetListener</type> provides possibility to - get notifications of type <type>ListEvent</type> from a - <type>XDynamicResultSet</type>. +/** used to receive notifications from an <type>XDynamicResultSet</type>. */ [ uik(55E5B801-3245-11d4-8B130010-4BCAF449), ident( "XDynamicResultSetListener", 1.0 ) ] interface XDynamicResultSetListener: com::sun::star::lang::XEventListener { //------------------------------------------------------------------------- - /** A method used to propagate changes of the resultset. + /** A method used to propagate changes of a resultset. - </p> - In the first notify-call the listener gets the two <type>XResultSet</type>s - and has to hold them. The <type>XResultSet</type>s are implementations of - the service <type>ContentResultSet</type>. - </p> + <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>. - <p> - The notified new <type>XResultSet</type> will stay valid after returning - notification. The old one will become invalid after returning notification. - </p> + <p>The notified new <type>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 old and new - version, except in the first call, where only the new Resultset is valid. - </p> + <p>While in notify-call the listener is allowed to read from old and + new resultset, except in the first call, where only the new resultset + is valid. - <p> - The Listener is allowed to blockade this call, until he really want to go - to the new version. The only situation, where the listener has to return the - update call at once is, while he disposes his broadcaster or while he is - removing himsef as listener (otherwise you deadlock)!!! - </p> + <p>The Listener is allowed to stay (block) this call, until he really + wants to use the new resultset. The only situation, where the listener + has to return immediately is while he disposes his broadcaster or while + he is removing himself as listener (otherwise you deadlock)!!! + @param Changes + the changes to notify. */ - void notify( [in] ListEvent Changes ); }; diff --git a/offapi/com/sun/star/ucb/XFetchProvider.idl b/offapi/com/sun/star/ucb/XFetchProvider.idl index 37ceea4c1639..e2e0b1f51234 100644 --- a/offapi/com/sun/star/ucb/XFetchProvider.idl +++ b/offapi/com/sun/star/ucb/XFetchProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFetchProvider.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,8 +74,8 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides the possibility to get the contents of the columns of several -rows of one result set with only one call. +/** provides the possibility to get the contents of the columns of several + rows of a <type>ContentResultSet</type> with a single function call. */ [ uik(FF9B2A22-3DFB-11d4-8B150010-4BCAF449), ident( "XFetchProvider", 1.0 ) ] @@ -84,17 +84,24 @@ interface XFetchProvider: com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** returns the contents of the columns of the indicated rows - <p>set <parameter>bDirection</parameter> to TRUE, if you want the rows - to be read in the same order, as they are contained in the result set - ( TRUE <-> forward step; FALSE <-> backward step ) + @returns + <member>FetchResult::Rows</member> contains a sequence of anys. Each + of these anys contains a sequence of anys. - <p>the <member>Rows</member> of the returned <type>FetchResult</type> - contains a <atom>sequence</atom> of <atom>any</atom>s. Each of these anys - contains a <atom>sequence</atom> of <atom>any</atom>s. + @param nRowStartPosition + the starting row of the resultset + + @param nRowCount + the count of rows + + @param bDirection + <TRUE/>, if you want the rows to be read in the same order, as they + are contained in the result set ( <TRUE/> <-> forward step; + <FALSE/> <-> backward step ) */ - com::sun::star::ucb::FetchResult - fetch( [in] long nRowStartPosition - , [in] long nRowCount, [in] boolean bDirection ); + com::sun::star::ucb::FetchResult fetch( [in] long nRowStartPosition + , [in] long nRowCount + , [in] boolean bDirection ); }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl index 954cddd393b6..1772b7df5da1 100644 --- a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFetchProviderForContentAccess.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,56 +74,83 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides the possibility load information offered by a -<type>XContentAccess</type> for several rows of one result set at once. +/** provides the possibility to load information offered by a + <type>XContentAccess</type> for several rows of a + <type>ContentResultSet</type> with a single function call. */ [ uik(E5C8C4E1-5E26-11d4-8B1D0010-4BCAF449), ident( "XFetchProviderForContentAccess", 1.0 ) ] interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** returns the ContentIdentfierStrings of the columns of the indicated rows + /** returns the content identifier strings of the columns of the indicated + rows - <p>set <parameter>bDirection</parameter> to TRUE, if you want the rows - to be read in the same order, as they are contained in the result set - ( TRUE <-> forward step; FALSE <-> backward step ) + @returns + <member>FetchResult::Rows</member> contains a sequence of anys. Each + of these anys contains a string. - <p>the <member>Rows</member> of the returned <type>FetchResult</type> - contains a <atom>sequence</atom> of <atom>any</atom>s. Each of these anys - contains a <atom>string</atom>. + @param nRowStartPosition + the starting row of the resultset + + @param nRowCount + the count of rows + + @param bDirection + <TRUE/>, if you want the rows to be read in the same order, as they + are contained in the result set ( <TRUE/> <-> forward step; + <FALSE/> <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContentIdentifierStrings( [in] long nRowStartPosition - , [in] long nRowCount, [in] boolean bDirection ); + , [in] long nRowCount + , [in] boolean bDirection ); //------------------------------------------------------------------------- - /** returns the <type>XContentIdentfier</type>s of the columns of the indicated rows + /** returns the <type>XContentIdentfier</type>s of the columns of the + indicated rows + + @returns + <member>FetchResult::Rows</member> contains a sequence of anys. Each + of these anys contains an <type>XContentIdentifier</type>. - <p>set <parameter>bDirection</parameter> to TRUE, if you want the rows - to be read in the same order, as they are contained in the result set - ( TRUE <-> forward step; FALSE <-> backward step ) + @param nRowStartPosition + the starting row of the resultset - <p>the <member>Rows</member> of the returned <type>FetchResult</type> - contains a <atom>sequence</atom> of <atom>any</atom>s. Each of these anys - contains a <type>XContentIdentifier</type>. + @param nRowCount + the count of rows + + @param bDirection + <TRUE/>, if you want the rows to be read in the same order, as they + are contained in the result set ( <TRUE/> <-> forward step; + <FALSE/> <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContentIdentifiers( [in] long nRowStartPosition - , [in] long nRowCount, [in] boolean bDirection ); + , [in] long nRowCount + , [in] boolean bDirection ); //------------------------------------------------------------------------- /** returns the <type>XContent</types>s of the columns of the indicated rows - <p>set <parameter>bDirection</parameter> to TRUE, if you want the rows - to be read in the same order, as they are contained in the result set - ( TRUE <-> forward step; FALSE <-> backward step ) + @returns + <member>FetchResult::Rows</member> contains a sequence of anys. Each + of these anys contains an <type>XContent</type>. + + @param nRowStartPosition + the starting row of the resultset + + @param nRowCount + the count of rows - <p>the <member>Rows</member> of the returned <type>FetchResult</type> - contains a <atom>sequence</atom> of <atom>any</atom>s. Each of these anys - contains a <type>XContent</type>. + @param bDirection + <TRUE/>, if you want the rows to be read in the same order, as they + are contained in the result set ( <TRUE/> <-> forward step; + <FALSE/> <-> backward step ) */ com::sun::star::ucb::FetchResult fetchContents( [in] long nRowStartPosition - , [in] long nRowCount, [in] boolean bDirection ); + , [in] long nRowCount + , [in] boolean bDirection ); }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl b/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl index e28c27995128..55ca8a92bf3d 100644 --- a/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl +++ b/offapi/com/sun/star/ucb/XFileIdentifierConverter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFileIdentifierConverter.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: sb $ $Date: 2000-12-15 08:23:40 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,7 +82,7 @@ interface XFileIdentifierConverter : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Get information about the 'locality' of a file content provider. - The returned information can be used to chose the 'best' among a + <p>The returned information can be used to chose the 'best' among a number of file content providers implementing this interface. @param BaseURL diff --git a/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl b/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl index f3d0ae2d672c..6a920cff84f8 100644 --- a/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl +++ b/offapi/com/sun/star/ucb/XInteractionCookieHandling.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInteractionCookieHandling.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-15 11:29:29 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,8 +82,8 @@ module com { module sun { module star { module ucb { /** An interaction continuation handing back some cookie request handling policy. - <p> This continuation is typically used in conjunction with - <type>HandleCookiesRequest</type>. </p> + <p>This continuation is typically used in conjunction with + <type>HandleCookiesRequest</type>. */ [ uik(E2281A20-33D6-11D1-AABE00A0-249D5590), ident( "XInteractionCookieHandling", 1.0 ) ] interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinuation @@ -91,7 +91,7 @@ interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinua //------------------------------------------------------------------------- /** Set a general policy to hand back. - <p> This method should be called before select(). </p> + <p>This method should be called before select(). @param Policy Some policy how to handle cookies. @@ -101,16 +101,17 @@ interface XInteractionCookieHandling: com::sun::star::task::XInteractionContinua //------------------------------------------------------------------------- /** Set a policy to hand back for a specific cookie. - <p> This method should be called before select(). </p> + <p>This method should be called before select(). @param ConfirmCookie A cookie that sould come from the sequence of - cookies offered by the HandleCookiesRequest and that should have a - Policy of CONFIRM. + cookies offered by the <type>HandleCookiesRequest</type> and that + should have a policy of <member>CookiePolicy::CONFIRM</member>. @param Accept - If true, set the policy for the cookie to ACCEPT; - otherwise, set it to IGNORE. + If <TRUE/>, set the policy for the cookie to + <member>CookiePolicy::ACCEPT</member>; otherwise, set it to + <member>CookiePolicy::IGNORE</member>. */ void setSpecificPolicy( [in] com::sun::star::ucb::Cookie ConfirmCookie, [in] boolean Accept ); diff --git a/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl b/offapi/com/sun/star/ucb/XInteractionHandlerSupplier.idl index 3913d4a8a752..f52e4f468f7d 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.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:52 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,19 +72,20 @@ module com { module sun { module star { module ucb { //============================================================================= /** This interface should be implemented by an interbnal XCommandEnvironment - that can not supply an XInteractionHandler, but instead wants interaction - requests to be handled by other internal error handling mechanism. + that can not supply an <type>XInteractionHandler</type>, but instead wants + interaction requests to be handled by other internal error handling + mechanism. - @seealso com::sun::star::ucb::XCommandEnvironment. + @see XCommandEnvironment. */ [ uik(55321FF6-84C2-4c66-BF5A7719-71FE3C38), ident( "XInteractionHandlerSupplier", 1.0 ) ] interface XInteractionHandlerSupplier: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Returns whether an XInteractionHandler can be supplied. + /** Returns whether an <type>XInteractionHandler</type> can be supplied. - @return True if an XInteractionHandler can be supplied, false - otherwise. + @returns + <TRUE/>, if an XInteractionHandler can be supplied, <FALSE/> otherwise. */ boolean hasInteractionHandler(); }; diff --git a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl index c713f29e07f8..49501ebf0e02 100644 --- a/offapi/com/sun/star/ucb/XPersistentPropertySet.idl +++ b/offapi/com/sun/star/ucb/XPersistentPropertySet.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPersistentPropertySet.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ interface XPropertySetRegistry; //============================================================================= /** A persistent propertyset, which can be saved in and restored from a - XPropertySetRegistry. + <type>XPropertySetRegistry</type>. @version 1.0 @author Kai Sommerfeld diff --git a/offapi/com/sun/star/ucb/XPropertyMatcher.idl b/offapi/com/sun/star/ucb/XPropertyMatcher.idl index 53b7fdbe09f3..f25e2446ac3c 100644 --- a/offapi/com/sun/star/ucb/XPropertyMatcher.idl +++ b/offapi/com/sun/star/ucb/XPropertyMatcher.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyMatcher.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,7 +80,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** Checks whether a set of properties matches a set of search criteria. - @seealso com::sun::star::ucb::XPropertyMatcherFactory. + @see XPropertyMatcherFactory. */ [ uik(6556F750-1B44-11d4-9FB10050-04526AC8), ident( "XPropertyMatcher", 1.0 ) ] interface XPropertyMatcher : com::sun::star::uno::XInterface @@ -88,13 +88,15 @@ interface XPropertyMatcher : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Checks whether a set of properties matches the given search criteria. - @param Properties A Command Processor through which the set of - properties is accessible. + @param Properties + A Command Processor through which the set of properties is accessible. - @param Environment The environment to use when accessing the property - set via the given Command Processor. It may be null. + @param Environment + The environment to use when accessing the property set via the given + Command Processor. It may be null. - @returns True if the properties match, false otherwise. + @returns + <TRUE/> if the properties match, <FALSE/> otherwise. */ boolean matches([in] com::sun::star::ucb::XCommandProcessor Properties, [in] com::sun::star::ucb::XCommandEnvironment Environment); diff --git a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl index 59c5c76e65ce..f01f0d5e865d 100644 --- a/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl +++ b/offapi/com/sun/star/ucb/XPropertyMatcherFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertyMatcherFactory.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,9 +78,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Creates an XPropertyMatcher, given a set of search criteria. - - @seealso com::sun::star::ucb::XPropertyMatcher. +/** Creates an <type>XPropertyMatcher</type>, given a set of search criteria. */ [ uik(6556F751-1B44-11d4-9FB10050-04526AC8), ident( "XPropertyMatcherFactory", 1.0 ) ] interface XPropertyMatcherFactory : com::sun::star::uno::XInterface @@ -88,10 +86,11 @@ interface XPropertyMatcherFactory : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** Creates an XPropertyMatcher. - @param Criteria The set of search criteria the returned - XPropertyMatcher will use. + @param Criteria + The set of search criteria the returned XPropertyMatcher will use. - @returns An XPropertyMatcher with the given search criteria. + @returns + An XPropertyMatcher with the given search criteria. */ com::sun::star::ucb::XPropertyMatcher createPropertyMatcher( [in] sequence<com::sun::star::ucb::SearchCriterium> Criteria); diff --git a/offapi/com/sun/star/ucb/XPropertySetRegistry.idl b/offapi/com/sun/star/ucb/XPropertySetRegistry.idl index 0862c2c00f6e..c60a1c090ce8 100644 --- a/offapi/com/sun/star/ucb/XPropertySetRegistry.idl +++ b/offapi/com/sun/star/ucb/XPropertySetRegistry.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySetRegistry.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,6 +78,7 @@ module com { module sun { module star { module ucb { @version 1.0 @author Kai Sommerfeld + @see XPersistentPropertySet */ [ uik(7ACF6551-9B46-11d3-9F130050-04526AC8), ident("XPropertySetRegistry", 1.0) ] interface XPropertySetRegistry : com::sun::star::uno::XInterface diff --git a/offapi/com/sun/star/ucb/XPropertySetRegistryFactory.idl b/offapi/com/sun/star/ucb/XPropertySetRegistryFactory.idl index 78c0552db739..bbf2b168d12e 100644 --- a/offapi/com/sun/star/ucb/XPropertySetRegistryFactory.idl +++ b/offapi/com/sun/star/ucb/XPropertySetRegistryFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPropertySetRegistryFactory.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -86,7 +86,8 @@ interface XPropertySetRegistryFactory : com::sun::star::uno::XInterface /** creates a propertyset registry. @param URL - The identifier of the registry to create ( e.g. file-URL ). + The identifier of the registry to create ( e.g. file-URL ). The + value can be an empty string. @returns The registry. diff --git a/offapi/com/sun/star/ucb/XRecycler.idl b/offapi/com/sun/star/ucb/XRecycler.idl index 5b5b7d0cdaad..234e4fd615fb 100644 --- a/offapi/com/sun/star/ucb/XRecycler.idl +++ b/offapi/com/sun/star/ucb/XRecycler.idl @@ -2,9 +2,9 @@ * * $RCSfile: XRecycler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-12-15 11:29:29 $ + * last change: $Author: kso $ $Date: 2001-02-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -78,25 +78,28 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Allows an XContent to delete itself into the trash can. +/** Allows an <type>XContent</type> to delete itself into the trash can. - <p> This is an additional interface the XContent representing the trash - can (URL <vnd.sun.staroffice.trashcan:///>) should support. </p> + <p>This is an additional interface the XContent representing the trash + can (URL: "vnd.sun.staroffice.trashcan:///") should support. */ [ uik(DF1E66B0-24C9-11d4-9FBC0050-04526AC8), ident( "XRecycler", 1.0 ) ] interface XRecycler : com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** Notify the trash can that an XContent is deleting itself into it. + /** Notify the trash can that an <type>XContent</type> is deleting itself + into it. - @param Properties The trash can uses this interface to access the - properties of the content being deleted, to copy them for later - display etc. The trash can will not use the interface after it has - returned from this method. + @param Properties + The trash can uses this interface to access the properties of the + content being deleted, to copy them for later display etc. The + trash can will not use the interface after it has returned from this + method. - @param Identifier When the deleted content is later restored or - ultimately deleted, the trash can will use this identifier to query an - XContent that it will send the undelete or delete command to. + @param Identifier + When the deleted content is later restored or ultimately deleted, the + trash can will use this identifier to query an XContent that it will + send the undelete or delete command to. */ void trashContent([in] com::sun::star::ucb::XCommandProcessor Properties, [in] com::sun::star::ucb::XContentIdentifier Identifier); diff --git a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl index a41f51d82698..c831fb21b0e3 100644 --- a/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl +++ b/offapi/com/sun/star/ucb/XSortedDynamicResultSetFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSortedDynamicResultSetFactory.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,21 +80,33 @@ module com { module sun { module star { module ucb { //============================================================================= -/** Provides a methods to create a sorted <type>XDynamicResultSet</type> which -will be sorted by the given sorting options. +/** Provides a method to create an <type>XDynamicResultSet</type> which + will be sorted according to the given sorting options. */ [ uik(D4E3B8F0-3D1E-11d4-9F6A0050-04D81245), ident( "XSortedDynamicResultSetFactory", 1.0 ) ] interface XSortedDynamicResultSetFactory: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- - /** provides the creation of a sorted <type>XDynamicResultSet</type> - depending on internal data, an XDynamicResultSet and the sorting info. + /** creates a sorted <type>XDynamicResultSet</type> depending on internal + data, an (unsorted) XDynamicResultSet and the sorting info. + + @returns + a sorted resultset. + + @param Source + the (unsorted) source resultset + + @param Info + the sort criteria + + @param CompareFactory + a factory for compare objects. */ com::sun::star::ucb::XDynamicResultSet createSortedDynamicResultSet( - [in] com::sun::star::ucb::XDynamicResultSet Source, - [in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info, - [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory ); + [in] com::sun::star::ucb::XDynamicResultSet Source, + [in] sequence<com::sun::star::ucb::NumberedSortingInfo> Info, + [in] com::sun::star::ucb::XAnyCompareFactory CompareFactory ); }; //============================================================================= diff --git a/offapi/com/sun/star/ucb/XSourceInitialization.idl b/offapi/com/sun/star/ucb/XSourceInitialization.idl index bcb814354f03..639df601faf7 100644 --- a/offapi/com/sun/star/ucb/XSourceInitialization.idl +++ b/offapi/com/sun/star/ucb/XSourceInitialization.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSourceInitialization.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-09 13:05:26 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -82,13 +82,24 @@ interface XSourceInitialization: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** provides the initialization of a component with any source object. - The service description has to specify which type of interface is to be - set as parameter. - <p>Hopefully you will only use this, when <parameter>Source</parameter> - is an <type>XComponent</type> and this is an <type>XEventListener</type>. - Than you should call <member>XComponent::addEventListener()</member> - within this method. + <p>The service description has to specify which type of interface must + be set as parameter. + + <p>Hopefully you will only use this, when <var>Source</var> + is an <type scope="com::sun::star::lang">XComponent</type> and this + is an <type scope="com::sun::star::lang">XEventListener</type>. + Than you should call + <member scope="com::sun::star::lang">XComponent::addEventListener()</member> + from inside the implementation of this method. + + @param Source + the source. + + @throws AlreadyInitializedException + if this method is called more than once during the lifetime of the + object implementing this interface. + */ void setSource( [in] com::sun::star::uno::XInterface Source ) raises (AlreadyInitializedException); |