diff options
author | Kai Sommerfeld <kso@openoffice.org> | 2001-02-22 08:48:32 +0000 |
---|---|---|
committer | Kai Sommerfeld <kso@openoffice.org> | 2001-02-22 08:48:32 +0000 |
commit | 65b469fc08caaa6ad486273cb37011522716a9f9 (patch) | |
tree | ea21d0c92dd2cd5fc722afcdb0e35b2ecc76aeea /offapi/com/sun | |
parent | a78f337e122c4fb86ebc2efd20ed37f1b7dbd8fb (diff) |
Documentation.
Diffstat (limited to 'offapi/com/sun')
-rw-r--r-- | offapi/com/sun/star/ucb/CachedContentResultSet.idl | 14 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/Content.idl | 12 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/ContentEvent.idl | 9 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/ContentInfo.idl | 17 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/ListActionType.idl | 29 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/OpenCommandArgument.idl | 20 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/OpenCommandArgument2.idl | 6 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/OpenMode.idl | 11 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/Store.idl | 8 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/TransferCommandOperation.idl | 8 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/UniversalContentBroker.idl | 21 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl | 6 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/XCommandEnvironment.idl | 10 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/XContentCreator.idl | 8 | ||||
-rw-r--r-- | offapi/com/sun/star/ucb/XContentProviderManager.idl | 22 |
15 files changed, 102 insertions, 99 deletions
diff --git a/offapi/com/sun/star/ucb/CachedContentResultSet.idl b/offapi/com/sun/star/ucb/CachedContentResultSet.idl index 69cbccc55d3b..a5c62c52b6df 100644 --- a/offapi/com/sun/star/ucb/CachedContentResultSet.idl +++ b/offapi/com/sun/star/ucb/CachedContentResultSet.idl @@ -2,9 +2,9 @@ * * $RCSfile: CachedContentResultSet.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -99,14 +99,14 @@ service CachedContentResultSet //------------------------------------------------------------------------- /** contains the direction for fetching rows from an underlying database. - <p>could contain a value of constants group - <type scope="com::sun::star::sdbc">FetchDirection</type>. + <p>The value can be one of the + <type scope="com::sun::star::sdbc">FetchDirection</type> constants group. <p>The default value is implementation specific. - <p>If you set <var>FetchDirection</var> to UNKNOWN, an implementation - specific <type scope="com::sun::star::sdbc">FetchDirection</type> will be - used. + <p>If you set the value to + <member scope="com::sun::star::sdbc">FetchDirection::UNKNOWN</member> an + implementation specific direction will be used. */ [property] long FetchDirection; }; diff --git a/offapi/com/sun/star/ucb/Content.idl b/offapi/com/sun/star/ucb/Content.idl index 78d6b12268ea..352d70c39514 100644 --- a/offapi/com/sun/star/ucb/Content.idl +++ b/offapi/com/sun/star/ucb/Content.idl @@ -2,9 +2,9 @@ * * $RCSfile: Content.idl,v $ * - * $Revision: 1.11 $ + * $Revision: 1.12 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -190,7 +190,7 @@ service Content // contained, that are unknown to the content! void setPropertyValues - sequence< <type scope="com::sun::star::beans">PropertyValue</type> < aValues + sequence< <type scope="com::sun::star::beans">PropertyValue</type> > aValues ----------------------------------------------------------------------- Optional commands: @@ -318,8 +318,8 @@ service Content // <b>Important note:</b> A client that wants to transfer data should // not execute this command, but it should execute the command - // "globalTransfer" at the/ <type>UniversalContentBroker</type> - // instance. This command is able to transfer all kind of content + // "globalTransfer" at the <type>UniversalContentBroker</type>. + // This command is able to transfer all kind of content // supported by that UCB. // // This command transfers (copies/moves) an object from one location @@ -631,7 +631,7 @@ service Content //------------------------------------------------------------------------- /** creates new contents (i.e. creates a new folder in another folder somewhere in the local file system). - * + <p>A content is "new", if it does not physically exist before creating it using this interface. diff --git a/offapi/com/sun/star/ucb/ContentEvent.idl b/offapi/com/sun/star/ucb/ContentEvent.idl index eca0de0aed0b..4da015690be9 100644 --- a/offapi/com/sun/star/ucb/ContentEvent.idl +++ b/offapi/com/sun/star/ucb/ContentEvent.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentEvent.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -85,8 +85,9 @@ struct ContentEvent: com::sun::star::lang::EventObject long Action; //------------------------------------------------------------------------- - /** The content the action is related to (e.g., the content that was just - physically destroyed, the content just inserted into a folder content). + /** The content to that the action is related (e.g., the content that was + just physically destroyed, the content that was just inserted into a + folder content). <p>This member must be filled as follows: diff --git a/offapi/com/sun/star/ucb/ContentInfo.idl b/offapi/com/sun/star/ucb/ContentInfo.idl index ef04d1db7a7a..e3c3857fc9f6 100644 --- a/offapi/com/sun/star/ucb/ContentInfo.idl +++ b/offapi/com/sun/star/ucb/ContentInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: ContentInfo.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:07 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,8 +90,8 @@ struct ContentInfo //------------------------------------------------------------------------- /** Additional attributes. - <p>These flags contain extra information on the content, like it's kind - ( KIND_FOLDER, KIND_DOCUMENT, KIND_LINK ). + <p>These flags contain extra information on the content, like its kind + (KIND_FOLDER, KIND_DOCUMENT, KIND_LINK). <p>It is highly recommended to fill these flags very accurately, as they are very important when transferring contents between different @@ -106,17 +106,18 @@ struct ContentInfo /** This field contains a list with the properties which must be set at a content that was just created using <member>XContentCreator::createNewContent</member> before it can be - committed ( via executing the command "insert" at the new content ). - If one of the properties is missing, the insert command will fail. + committed (by executing the command "insert" at the new content). + + <p>If one of the properties is missing, the insert command will fail. <p>In example, a new file system folder content will need a title. The Properties member of the ContentInfo provided for this kind of content must include the property "Title". <p><b>Important:</b> The required properties must have one of the - following basic data types ( in order to make it possible to implement + following basic data types (in order to make it possible to implement client applications with a small set of generic input methods for the - values ): + values): <p> <ul> diff --git a/offapi/com/sun/star/ucb/ListActionType.idl b/offapi/com/sun/star/ucb/ListActionType.idl index 8ed11a1cf974..45218eb2d10f 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.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 15:53:18 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,20 +72,20 @@ module com { module sun { module star { module ucb { <p>A change happened is sended from an <type>XDynamicResultSet</type> as <type>ListAction</type> to a <type>XDynamicResultSetListener</type>. - <p>The values are contained in <member>ListAction::ListActionType</member> + <p>The values are contained in <member>ListAction::ListActionType</member>. */ constants ListActionType { //------------------------------------------------------------------------- - /** first notification to a single listener for purpose of initialization. + /** First notification to a single listener for purpose of initialization. <p>This type of notification is required to be sended first and only once to a new listener. <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>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. @@ -107,9 +107,10 @@ constants ListActionType <p> <member>ListAction::ActionInfo</member> could contain something but this is not required. For example, it could contain the properties of - the new rows ( e.g. for remote optimizing ), but this is not required + the new rows (i.e. for remote optimizing), but this is not required nor unrestrictly recommended. - @todo ... further description of allowed contents for + + <p>@todo ... further description of allowed contents for <member>ListAction::ActionInfo</member> is needed */ const long INSERTED = 21; @@ -150,10 +151,10 @@ constants ListActionType <p><member>ListAction::ListActionType</member> is required to contain a 'long', which gives the shift of position. - ( e.g. When two rows at position 3 and 4 are moved for a shift '+1', + (i.e. When two rows at position 3 and 4 are moved for a shift '+1', they will appear at the positions 4 and 5. In this action is included, that the row on old position 5 now appears on position 3. - No other notification is needed, to explain or complete this action ). + No other notification is needed, to explain or complete this action). */ const long MOVED = 24; @@ -169,9 +170,10 @@ constants ListActionType <p> <member>ListAction::ActionInfo</member> could contain something but this is not required. - E.g it could contain the new properties ( e.g. for remote - optimizing ), but this is not required nor unrestrictly recommended. - @todo ... further description of allowed contents for + E.g 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 */ const long PROPERTIES_CHANGED = 25; @@ -189,7 +191,8 @@ constants ListActionType rows with changed identity have to be one after the other. <p><member>ListAction::ListActionType</member> must contain the new identities - @todo ... + + <p>@todo ... const long EXCHANGED = 26; */ diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument.idl b/offapi/com/sun/star/ucb/OpenCommandArgument.idl index 2ce7897ae0ef..8aa2236245ad 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.7 $ + * $Revision: 1.8 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -81,21 +81,23 @@ module com { module sun { module star { module ucb { struct OpenCommandArgument { //------------------------------------------------------------------------- - /** The mode should be one of the <type>OpenMode</type> constants. + /** A mode. + + <p>The value can be one of the <type>OpenMode</type> constants. */ long Mode; //------------------------------------------------------------------------- - /** The tasks priority, in the range <code>0</code> (highest) to + /** The command's priority, in the range <code>0</code> (highest) to <code>65535</code> (lowest). */ long Priority; //------------------------------------------------------------------------- - /** The data sink to write the contents into ( supporting either - <type scope="com::sun::star::io">XActiveDataSink</type> or - <type scope="com::sun::star::io">XOutputStream</type> ) or - <type scope="com::sun::star::io">XActiveDataStreamer</type>. + /** The data sink to write the contents into (supporting either + <type scope="com::sun::star::io">XActiveDataSink</type>, + <type scope="com::sun::star::io">XOutputStream</type> or + <type scope="com::sun::star::io">XActiveDataStreamer</type>). <p>XActiveDataSink and XOutputStream give the caller read-only access to the contents. XActiveDataStreamer offers both read and @@ -106,7 +108,7 @@ struct OpenCommandArgument interface <type scope="com::sun::star::io">XInputStream</type>. It is highly recommended that this object also implements the interface <type scope="com::sun::star::io">XSeekable</type>, if this can be done - without wasting resources ( i.e. allocating huge memory buffers ). + without wasting resources (i.e. allocating huge memory buffers). The implementation object has to be supplied to the data sink. */ com::sun::star::uno::XInterface Sink; diff --git a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl index ff0468f7f5c4..75ed6d6274cd 100644 --- a/offapi/com/sun/star/ucb/OpenCommandArgument2.idl +++ b/offapi/com/sun/star/ucb/OpenCommandArgument2.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenCommandArgument2.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,7 @@ module com { module sun { module star { module ucb { //============================================================================= -/** The argument for the commands like "open", "update", and "synchronize". +/** The argument for commands like "open", "update", and "synchronize". <p>This strcut extends the original OpenCommandArgument, which must not be changed for compatibility reasons. diff --git a/offapi/com/sun/star/ucb/OpenMode.idl b/offapi/com/sun/star/ucb/OpenMode.idl index 74c815281431..2f80ab931e58 100644 --- a/offapi/com/sun/star/ucb/OpenMode.idl +++ b/offapi/com/sun/star/ucb/OpenMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: OpenMode.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 15:53:18 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,14 +67,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** These are the possible values for the - <member>OpenCommandArgument::Mode</member>. +/** These are the possible values for <member>OpenCommandArgument::Mode</member>. */ constants OpenMode { //------------------------------------------------------------------------- - /** open a folder, include all children in result set ( documents and - folders ). + /** open a folder, include all children in result set (documents and + folders). */ const short ALL = 0; diff --git a/offapi/com/sun/star/ucb/Store.idl b/offapi/com/sun/star/ucb/Store.idl index bc5936f11972..51274eb32e0f 100644 --- a/offapi/com/sun/star/ucb/Store.idl +++ b/offapi/com/sun/star/ucb/Store.idl @@ -2,9 +2,9 @@ * * $RCSfile: Store.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,13 +70,13 @@ module com { module sun { module star { module ucb { //============================================================================= -/** creates implementations of the service <typePropertySetRegistry</type>. +/** creates instances of the service <type>PropertySetRegistry</type>. */ service Store { //------------------------------------------------------------------------- /** A factory for propertyset registries. This factory must create - implementations of the service <typePropertySetRegistry</type> + instances of the service <typePropertySetRegistry</type> */ interface com::sun::star::ucb::XPropertySetRegistryFactory; }; diff --git a/offapi/com/sun/star/ucb/TransferCommandOperation.idl b/offapi/com/sun/star/ucb/TransferCommandOperation.idl index e2d3a7897693..ef40f3a4c425 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.1 $ + * $Revision: 1.2 $ * - * last change: $Author: kso $ $Date: 2001-01-31 08:18:14 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -67,8 +67,8 @@ module com { module sun { module star { module ucb { //============================================================================= -/** These are the possible values for the member Operation of the struct - <type>GlobalTransferCommandArgument</type>. +/** These are the possible values for + <member>GlobalTransferCommandArgument::Operation</type>. */ enum TransferCommandOperation { diff --git a/offapi/com/sun/star/ucb/UniversalContentBroker.idl b/offapi/com/sun/star/ucb/UniversalContentBroker.idl index 2fd796eb5eae..b68f2f8de938 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.10 $ + * $Revision: 1.11 $ * - * last change: $Author: kso $ $Date: 2001-02-08 14:05:20 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -93,9 +93,9 @@ module com { module sun { module star { module ucb { /** is a one-instance service that provides access to a set of <type>Content</type>s via <type>ContentProvider</type>s. - <p>If the instance is created with two arguments of type - <type>string</type>, these two strings are used to configure the newly - instantiated broker; see the description of the required + <p>If the instance is created with two arguments of type string, + these two strings are used to configure the newly instantiated broker; + see the description of the required <type scope="com::sun::star::lang">XInitialization</type> interface for details. @@ -115,8 +115,8 @@ service UniversalContentBroker must be called at the Broker. The implementation of this method must call <member scope="com::sun::star::lang">XEventListener::disposing</member> - on the registered listeners ( the providers holding the Broker must be - those listeners ) and release the appropriate object references. At + on the registered listeners (the providers holding the Broker must be + those listeners) and release the appropriate object references. At the other hand, the implementation of XEventListener::disposing must release its appropriate references. @@ -152,10 +152,9 @@ service UniversalContentBroker <p>The <member scope="com::sun::star::lang"XInitialization::initialize</member> - method should be called with two arguments of type - <type>string</type>. These strings are used as a pair of keys to - retrieve a set of content provider descriptions from the configuration - management (stored at + method should be called with two arguments of type string. These strings + are used as a pair of keys to retrieve a set of content provider + descriptions from the configuration management (stored at <code>org.openoffice.ucb.Configuration.ContentProviders.<var>key<sub>1</sub></var>.SecondaryKeys.<var>key<sub>2</sub></var>.ProviderData</code> within the configuration management's hierarchy). The retrieved descriptions are in turn used to register the corresponding content diff --git a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl index 06141f4445da..0d4a83ae0c03 100644 --- a/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl +++ b/offapi/com/sun/star/ucb/WelcomeDynamicResultSetStruct.idl @@ -2,9 +2,9 @@ * * $RCSfile: WelcomeDynamicResultSetStruct.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: kso $ $Date: 2001-02-12 13:41:08 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -71,7 +71,7 @@ module com { module sun { module star { module ucb { //============================================================================= /** This struct is to be contained in the first notification of an - <type>XDynamicResultSet</type> + <type>XDynamicResultSet</type>. @see XDynamicResultSet @see ListEvent diff --git a/offapi/com/sun/star/ucb/XCommandEnvironment.idl b/offapi/com/sun/star/ucb/XCommandEnvironment.idl index 745cd670767a..d9d9d7d44df5 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.5 $ + * $Revision: 1.6 $ * - * last change: $Author: sb $ $Date: 2001-02-12 13:26:50 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -91,8 +91,7 @@ interface XCommandEnvironment : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** returns the command's interaction handler. - @descr - If called multiple times, this method should consistently return the + <p>If called multiple times, this method should consistently return the same value (to allow caching). @returns @@ -103,8 +102,7 @@ interface XCommandEnvironment : com::sun::star::uno::XInterface //------------------------------------------------------------------------- /** returns the command's progress handler. - @descr - If called multiple times, this method should consistently return the + <p>If called multiple times, this method should consistently return the same value (to allow caching). @returns diff --git a/offapi/com/sun/star/ucb/XContentCreator.idl b/offapi/com/sun/star/ucb/XContentCreator.idl index aaa329ece760..f04062344fff 100644 --- a/offapi/com/sun/star/ucb/XContentCreator.idl +++ b/offapi/com/sun/star/ucb/XContentCreator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentCreator.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: kso $ $Date: 2001-01-30 10:46:56 $ + * last change: $Author: kso $ $Date: 2001-02-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,12 +79,12 @@ module com { module sun { module star { module ucb { //============================================================================= -/** A creator for new (persistent) contents ( like file system folders ). +/** A creator for new (persistent) contents, like file system folders. <p>Creation of a new (persistent) content: <ol> <li>newObject = creator.createNewContent( ... ) - <li>initialize the new object ( i.e. newObject.Property1 = ... ) + <li>initialize the new object (i.e. newObject.Property1 = ...) <li>let the new content execute the command "insert". That command commits the data and makes the new content persistent. </ol> diff --git a/offapi/com/sun/star/ucb/XContentProviderManager.idl b/offapi/com/sun/star/ucb/XContentProviderManager.idl index 30797242e07e..130557ac1f29 100644 --- a/offapi/com/sun/star/ucb/XContentProviderManager.idl +++ b/offapi/com/sun/star/ucb/XContentProviderManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: XContentProviderManager.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-22 09:48:32 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -101,7 +101,7 @@ interface XContentProviderManager: com::sun::star::uno::XInterface the content provider to register. <p>This may be <NULL/>, in which case a later - <member>XContentProvider::queryContent</metmber> with an + <member>XContentProvider::queryContent</member> with an <type>XContentIdentifier</type> that matches the <var>Scheme</var> will simply return <NULL/>. These "dummy" content providers are useful in combination with other content providers that are registered on a @@ -138,24 +138,24 @@ interface XContentProviderManager: com::sun::star::uno::XInterface <li><code>sescape = "\" (DQUOTE / "\")</code></li> </ul> - <p>A <code><scheme>:<code/> matches any URL of exactly the given + <p>A <code><scheme>:</code> matches any URL of exactly the given scheme (ignoring case), keeping the extension from URL schemes to URL - templates backwards compatible. The <code><simple>:<code/> + templates backwards compatible. The <code><simple>:</code> regexps match any URL starting with a given string literal, followed - by arbitrary characters (<code><simple-prefix>:<code/>), or + by arbitrary characters (<code><simple-prefix>:</code>), or by arbitrary characters that start with one of '/', '?', or '#', if any - (<code><simple-authority>:<code/>), or by arbitrary characters not + (<code><simple-authority>:</code>), or by arbitrary characters not including any of '/', '?', or '#', followed by a given string literal, followed by arbitrary characters that start with one of '/', '?', or '#', if any. The comparision of string literals is done ignoring the - case of ASCII letters. The <code><translation>:<code/> regexps - match the same URLs as their <code><simple>:<code/> counterparts, + case of ASCII letters. The <code><translation>:</code> regexps + match the same URLs as their <code><simple>:</code> counterparts, but they also describe how a (local) URL is mapped to another (remote) URL. This mapping is only relevant for methods of the <type>RemoteAccessContentProvider</type>'s <type>XParameterizedContentProvider</type> interface; in all other - cases, <code><translation>:<code/> regexps have the same semantics - as their <code><simple>:<code/> counterparts. + cases, <code><translation>:</code> regexps have the same semantics + as their <code><simple>:</code> counterparts. @param ReplaceExisting <TRUE/>: replace the provider possibly registered for the given URL |