diff options
| author | Daniel Boelzle <dbo@openoffice.org> | 2002-01-23 07:52:21 +0000 |
|---|---|---|
| committer | Daniel Boelzle <dbo@openoffice.org> | 2002-01-23 07:52:21 +0000 |
| commit | 7e130dd78fdfffc06fe9260d6961607430715ecb (patch) | |
| tree | ffb01faaf04bfb9d424435c58bc4c750916938ee /udkapi/com | |
| parent | 52981ef07bb83d9a801bee8fd4e747f931e45bed (diff) | |
#96711# IDL documentation review
Diffstat (limited to 'udkapi/com')
26 files changed, 747 insertions, 978 deletions
diff --git a/udkapi/com/sun/star/lang/MultiServiceFactory.idl b/udkapi/com/sun/star/lang/MultiServiceFactory.idl index 61a57f912653..fdb223e1df1d 100644 --- a/udkapi/com/sun/star/lang/MultiServiceFactory.idl +++ b/udkapi/com/sun/star/lang/MultiServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: MultiServiceFactory.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,39 +79,35 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: service com::sun::star::lang::MultiServiceFactory -/** provides a collection of implementations for services. +/** Provides a collection of implementations of services. - <p>The factories for instantiating objects from the implemetations - are accessed with a service name. </p> + <p>The factories for instantiating objects of implemetations + are accessed via a service name.</p> <p>The <type scope="com::sun::star::container">XContentEnumerationAccess</type> - interface can be supported optionally. If it is suported, it is possible to - enumerate all implementations that support the service specified with the - argument of <member scope="com::sun::star::container">XContentEnumerationAccess::createContentEnumeration</member>. + interface can be supported optionally. + If it is suported, it is possible to enumerate all implementations that + support the service specified with the argument of + <member scope="com::sun::star::container">XContentEnumerationAccess::createContentEnumeration</member>. The enumerator returns interfaces. The type of the interface is not specified. - Normally these are <type>XSingleServiceFactory</type>. </p> - */ + Commonly this is <type>XSingleComponentFactory</type>.</p> +*/ service MultiServiceFactory { - // DocMerge from xml: service com::sun::star::lang::MultiServiceFactory: interface com::sun::star::lang::XMultiServiceFactory - /** uses a service name with this interface to instantiate a - component which supports the specified service. - */ + /** This interface uses a service name to instantiate a component + which supports the specified service. + */ interface com::sun::star::lang::XMultiServiceFactory; - /** uses a service name and context with this interface to instantiate a - component which supports the specified service. - interface com::sun::star::lang::XMultiComponentFactory; + /** This interface uses a service name and a component context to instantiate + a component which supports the specified service. */ + interface com::sun::star::lang::XMultiComponentFactory; - // DocMerge from xml: service com::sun::star::lang::MultiServiceFactory: interface com::sun::star::lang::XServiceInfo - /** A factory, as well as all other services, should always support - this interface. At minimum the service - "com.sun.star.lang.MultiServiceFactory" must be supported. - */ + /** Factories, as well as all other services, should always support + this interface. + */ interface com::sun::star::lang::XServiceInfo; - }; //============================================================================= @@ -121,6 +117,9 @@ service MultiServiceFactory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8 2001/11/16 14:57:39 mi + proofing by Richard Holt + Revision 1.7 2001/05/04 14:32:20 dbo prepared service descr of service manager for XMultiComponentFactory diff --git a/udkapi/com/sun/star/lang/RegistryServiceManager.idl b/udkapi/com/sun/star/lang/RegistryServiceManager.idl index 89b8e02e121c..ebc898505a1b 100644 --- a/udkapi/com/sun/star/lang/RegistryServiceManager.idl +++ b/udkapi/com/sun/star/lang/RegistryServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: RegistryServiceManager.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,84 +88,40 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: service com::sun::star::lang::RegistryServiceManager -/** provides a collection of and a registry for implementations for services. - - <p>The factories are accessed with a service name. It is possible to - access the factories with their implementation name, but that should be - avoided. </p> - - <p>The first argument of the <member>XInitialization::initialization</member> - method may be a reference to a simple registry (<type scope="com::sun::star::registry">XSimpleRegistry</type>). - If it is not initialized with a registry, then the default registry - "com::sun::star::registry::DefaultRegistry" is used. If this registry is not - found, then the manager works without a registry. </p> - - <p>You can get the current registry with - <member scope="com::sun::star:beans">XPropertySet::getPropertyValue</member>. </p> - - <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> - interfaces should support the following interfaces: </p> - - <dl> - <dt> <type>XServiceInfo</type> </dt> - <dd>is used to support access through the implementation with - service names. - </dd> - - <dt> <type>XSingleServiceFactory</type> </dt> - <dd>is used to instantiate components from the implementation. - </dd> - - <dt> <type scope="com::sun::star::beans">XPropertySet</type> (optional) </dt> - <dd>provides additional information on the implementation. - </dd> - - <dt> <type>XComponent</type> (optional) </dt> - <dd>The service manager calls dispose on the registered - factories. The service manager adds a listener to this - factory. The factory is automatically revoked if the - disposing listener is notified. - </dd> - </dl> - - @suspicious - */ +/** Provides a collection of implementations for services reading from a + persistent registry storage. + + For usage of the service manager have a look at service description + of <type>ServiceManager</type>. + + @see ServiceManager +*/ service RegistryServiceManager { - // DocMerge: empty anyway + /** This is a derived ServiceManager service. + */ service com::sun::star::lang::ServiceManager; - // DocMerge: empty anyway - service com::sun::star::lang::MultiServiceFactory; - - - // DocMerge from xml: service com::sun::star::lang::RegistryServiceManager: interface com::sun::star::lang::XInitialization - /** The first argument of the intitialization method of this - interface may be a reference to a simple registry - (<type scope="com::sun::star::registry">XSimpleRegistry</type>). - */ + /** The first two arguments of the intitialization arguments reference: + <ol> + <li>a simple registry + (<type scope="com::sun::star::registry">XSimpleRegistry</type>), + i.e. the registry to be read from</li> + <li>a component context + (<type scope="com::sun::star::uno">XComponentContext</type>) + to be installed as "DefaultContext" property of the + <type>ServiceManager</type> which is the context to be used + using the <type>XMultiServiceFactory</type> interface.</li> + </ol> + */ interface com::sun::star::lang::XInitialization; - - // DocMerge from xml: service com::sun::star::lang::RegistryServiceManager: interface com::sun::star::beans::XPropertySet - /** The method <member>getPropertyValue</member> must be implemented - to get the read-only property <member>Registry</member>. All - other methods are optional. - */ + /** Property access. + */ interface com::sun::star::beans::XPropertySet; - - //------------------------------------------------------------------------- - - // DocMerge from xml: property com::sun::star::lang::RegistryServiceManager::Registry - /** specifies the current registry. - - <p>This property will be initialized by - <type>XInitialization</type> or the default registry. - </p> - */ + /** Specifies the current registry to be read from. + */ [readonly, property] com::sun::star::registry::XSimpleRegistry Registry; - }; //============================================================================= @@ -175,6 +131,9 @@ service RegistryServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 14:57:39 mi + proofing by Richard Holt + Revision 1.6 2000/12/19 15:32:24 mi documentation syntax fixed diff --git a/udkapi/com/sun/star/lang/ServiceManager.idl b/udkapi/com/sun/star/lang/ServiceManager.idl index 7de281628b13..b9a448f6bb69 100644 --- a/udkapi/com/sun/star/lang/ServiceManager.idl +++ b/udkapi/com/sun/star/lang/ServiceManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: ServiceManager.idl,v $ * - * $Revision: 1.8 $ + * $Revision: 1.9 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -89,110 +89,80 @@ #include <com/sun/star/lang/XServiceInfo.idl> #endif +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + //============================================================================= module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: service com::sun::star::lang::ServiceManager -/** provides a collection of implementations for services. +/** Provides a collection of implementations for services. This is a singleton + you commonly find in your component context under key + <code>/singletons/com.sun.star.lang.theServiceManager</code>. - <p>The factories are accessed with a service name. It is possible to + <p> + The factories are accessed with a service name. It is possible to access the factories with their implementation names, but you should - avoid this. </p> + avoid this. + </p> - <p>The interfaces added through the <type scope="com::sun::star::container">XSet</type> - interfaces should support the following interfaces: </p> + <p>Service factories added via <type scope="com::sun::star::container">XSet</type> + should support the following interfaces: </p> <dl> - <dt> <type>XServiceInfo</type> </dt> - <dd>is used to support access through the implementation with - service names. - </dd> - - <dt> <type>XSingleServiceFactory</type> (optional) </dt> - <dd>is used to instantiate components from the implementation. - </dd> - - <dt> <type scope="com::sun::star::beans">XPropertySet</type> (optional) </dt> - <dd>offers additional information on the implementation. - </dd> - - <dt> <type>XComponent</type> (optional) </dt> - <dd>The service manager calls the method - <member scope="com::sun::star::lang">XComponent::dispose</member> - on the registered factories. The service manager adds a - listener to this factory. The factory is automatically - revoked when the disposing listener is notified. - </dd> + <dt><type>XServiceInfo</type></dt> + <dd>supported interfaces/ implementation name</dd> + + <dt><type>XSingleComponentFactory</type>(optional)</dt> + <dd>is used to create instances of the implementation.</dd> + + <dt><type>XComponent</type> (optional)</dt> + <dd>The service manager calls the method + <member scope="com::sun::star::lang">XComponent::dispose</member> + on the factory when going down (i.e. it is commonly disposed by the component context).</dd> </dl> - */ + + @see com::sun::star::uno::XComponentContext +*/ service ServiceManager { + /** This is a derived MultiServiceFactory service. + */ service com::sun::star::lang::MultiServiceFactory; - // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XComponent - /** Normally you should call the method - <member scope="com::sun::star::util">XComponent::dispose</member> - at the service manager just before the application terminates. - - <p>First, the service manager broadcasts the - <member scope="com::sun::star::util">XEventListener::disposing()</member> - message to all registered listeners. In this state you can still get all - factories from the service manager, but it is not possible to - add disposing listeners. Second, the service manager calls - <member scope="com::sun::star::util">XComponent::dispose</member> - at all registered factories that implement <type>XComponent</type>. - In this second state the service manager does not provide any factory. - This is called a two-phase shut down. </p> - */ + /** Disposing of service manager. + <p> + The component context disposes its service manager singleton when going down + (i.e. when the component context is disposed). + </p> + */ interface com::sun::star::lang::XComponent; - - // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::container::XSet - /** The implementations are managed with this interface. - The supported services (<type>XServiceInfo</type> is used) - are registered automatically. - */ + /** Management of service factories. + */ interface com::sun::star::container::XSet; - - // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::container::XContentEnumerationAccess - /** It is possible to enumerate all implementations that support the + /** Enumeration of all service factories. + <p> + It is possible to enumerate all implementations that support the service specified with the argument of the <member>XContentEnumerationAccess::createContentEnumeration</member> method. - - <p>The enumerator returns interfaces. The type of interfaces - are not specified. Normally these are - <type>XSingleServiceFactory</type>. - */ + The enumerator commonly returns <type>XSingleComponentFactory</type> + interfaces. + </p> + */ interface com::sun::star::container::XContentEnumerationAccess; - - // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XMultiServiceFactory - /** Use a service name or an implementation name to instantiate a - component with this interface. - - <p>First the service manager gets the factory registered - under the service name. Then - <member>XMultiServiceFactory::createInstance</type> or - <member>XMultiServiceFactory::createInstanceWithArguments</member> - of this factory is called. - */ - interface com::sun::star::lang::XMultiServiceFactory; - - /** Use this interface to raise services giving a <type>com.sun.star.uno.XComponentContext</type>. - */ - interface com::sun::star::lang::XMultiComponentFactory; - - // DocMerge from xml: service com::sun::star::lang::ServiceManager: interface com::sun::star::lang::XServiceInfo - /** Services should always support this interface. For a - <type>RegistryServiceManager</type>, at least the service - "com.sun.star.lang.RegistryServiceManager" must be supported. - */ - interface com::sun::star::lang::XServiceInfo; - + /** Property access. + */ + [optional] interface com::sun::star::beans::XPropertySet; + /** specifies the default component context to be used, if instanciating services + via <type>XMultiServiceFactory</type> + */ + [optional, property] com::sun::star::uno::XComponentContext DefaultContext; }; //============================================================================= @@ -202,6 +172,9 @@ service ServiceManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.8 2001/11/16 14:57:39 mi + proofing by Richard Holt + Revision 1.7 2001/06/13 10:44:10 dbo #87233# ServiceManager has to export lang.XMultiComponentFactory diff --git a/udkapi/com/sun/star/lang/XMain.idl b/udkapi/com/sun/star/lang/XMain.idl index 79572c6c7776..dca3e130966f 100644 --- a/udkapi/com/sun/star/lang/XMain.idl +++ b/udkapi/com/sun/star/lang/XMain.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMain.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:37 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,15 +76,20 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: interface com::sun::star::lang::XMain -/** Executable components implement this interface. - */ +/** Executing interface for executable components run by the uno executable + loader. This is an application to run components passing the command + line arguments. +*/ interface XMain: com::sun::star::uno::XInterface { - - // DocMerge from xml: method com::sun::star::lang::XMain::run /** This method is called to run the component. - */ + + @param aArguments + arguments passed to the component, + i.e. the command line arguments + @return + return value passed to be returned by main() + */ long run( [in] sequence< string > aArguments ); }; @@ -95,6 +100,9 @@ interface XMain: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/03/16 15:10:37 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2000/12/13 15:47:01 mi symtactical documentation and minor semantic documentation flaws fixed diff --git a/udkapi/com/sun/star/lang/XMultiComponentFactory.idl b/udkapi/com/sun/star/lang/XMultiComponentFactory.idl index 6b46d9fd104c..fd177150b23b 100644 --- a/udkapi/com/sun/star/lang/XMultiComponentFactory.idl +++ b/udkapi/com/sun/star/lang/XMultiComponentFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiComponentFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,8 +70,10 @@ module com { module sun { module star { module lang { -/** Factory object for launching component instances giving a context from +/** Factory interface for creating component instances giving a context from which to retrieve deployment values. + + @see XInitialization */ interface XMultiComponentFactory : com::sun::star::uno::XInterface { @@ -91,10 +93,9 @@ interface XMultiComponentFactory : com::sun::star::uno::XInterface raises (com::sun::star::uno::Exception); /** Creates an instance of a component which supports the - services specified by the factory, and initializes the new object + services specified by the factory, and initializes the new instance with the given arguments and context. - @see XInitialization::init @param ServiceSpecifier service name @param Arguments @@ -110,10 +111,10 @@ interface XMultiComponentFactory : com::sun::star::uno::XInterface [in] com::sun::star::uno::XComponentContext Context ) raises (com::sun::star::uno::Exception); - /** Gets the service names of all supported services. + /** Gets the names of all supported services. @returns - sequence of all service names which can be instantiated. + sequence of all service names */ sequence< string > getAvailableServiceNames(); }; diff --git a/udkapi/com/sun/star/lang/XMultiServiceFactory.idl b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl index 325114b19727..5844eff1cd1d 100644 --- a/udkapi/com/sun/star/lang/XMultiServiceFactory.idl +++ b/udkapi/com/sun/star/lang/XMultiServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMultiServiceFactory.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,69 +76,49 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: interface com::sun::star::lang::XMultiServiceFactory -/** Factory objects support this interface for creating components - by a specifying string, for example, the service name. +/** Factories support this interface creating instances giving a name, + e.g. a service name. - <p>This specifying string is not necessarily a service name. </p> - - @example - - <ol> - <li>You want to load data from a location specified with a URL - (file://..., http://..., ...). </li> - - <li>You get the factory that can create loader components. </li> - - <li>You call the <member>XMultiServiceFactory::createInstance()</member> - method with arguments like "file", "http" or something else. </li> - - <li>The factory knows something about this string and specifies that - <ul> - <li>"file" means for example the service "com::sun::star::url::File" </li> - <li>"http" means for example the service "com::sun::star::url::Http" </li> - <li>"javascript" means for example the service "com::netscape::url::.JavaScript" </li> - </ul> - or something else. </li> - - <li>Finally you start the download with <code>start( URL )</code> - at the newly created component. </li> - </ol> - - @see XInitialization - @see XSingleServiceFactory - */ + <p> + Note: + Although this interface deals with the notion of "services", this is not + generally be meant. In general this interface can be used for all kinds + of factories for all kinds of instances, indeed not only UNO services. + </p> +*/ interface XMultiServiceFactory: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + /** Creates an instance classified by the specified name. - // DocMerge from xml: method com::sun::star::lang::XMultiServiceFactory::createInstance - /** creates an instance of a component which supports the - services specified by the factory. - */ + @param aServiceSpecifier + classified name of instance + @return + instance + */ com::sun::star::uno::XInterface createInstance( [in] string aServiceSpecifier ) - raises( com::sun::star::uno::Exception ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments - /** creates an instance of a component which supports the - services specified by the factory, and initializes the new object with given arguments. - - @see XInitialization::init - */ - com::sun::star::uno::XInterface createInstanceWithArguments( [in] string ServiceSpecifier, - [in] sequence<any> Arguments ) - raises( com::sun::star::uno::Exception ); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::lang::XMultiServiceFactory::getAvailableServiceNames - /** @returns - a sequence of all service identifiers which can be instantiated. - */ + raises( com::sun::star::uno::Exception ); + + /** Creates an instance classified by the specified name and passes the arguments + to that instance. + + @param ServiceSpecifier + classified name of instance + @param Arguments + arguments passed to the instance + @return + instance + */ + com::sun::star::uno::XInterface createInstanceWithArguments( + [in] string ServiceSpecifier, + [in] sequence<any> Arguments ) + raises( com::sun::star::uno::Exception ); + + /** Provides the available names of the factory to be used to create instances. + + @returns + sequence of all names + */ sequence<string> getAvailableServiceNames(); - }; //============================================================================= @@ -148,6 +128,9 @@ interface XMultiServiceFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 14:57:39 mi + proofing by Richard Holt + Revision 1.6 2001/03/16 15:10:37 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/lang/XServiceInfo.idl b/udkapi/com/sun/star/lang/XServiceInfo.idl index 9ca567cd59a5..9eb756777a82 100644 --- a/udkapi/com/sun/star/lang/XServiceInfo.idl +++ b/udkapi/com/sun/star/lang/XServiceInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: XServiceInfo.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jbu $ $Date: 2002-01-18 15:34:15 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,48 +72,35 @@ module com { module sun { module star { module lang { //============================================================================= -/** provides information regarding which services are implemented. - - <p> This interface is in general provided by a concrete instance of an - implementation and by the <type>XSingleServiceFactory</type> or - <type>XSingleComponentFactory</type> - factories, which instantiate a - concrete implementation. - */ +/** Provides information regarding the implementation, i.e. which services + are implemented and the name of the implementation. +*/ interface XServiceInfo: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - /** returns an implementation-identifier. - - <p>This string must uniquely identify a concrete implementation. - Therefor this should be a fully qualified name like - "com.sun.star.comp.office.writer.SwTextDocument". The <em>comp</em> ( - short for component) should appear in the name to distinguish it from servicenames. + /** Provides the implementation name of the service implementation. @returns - an identifier for the implementation of this object. - */ + unique name of the implementation + */ string getImplementationName(); - //------------------------------------------------------------------------- + /** Tests whether the specified service is supported, i.e. implemented + by the implementation. - /** asks whether a service is supported or not. - @returns true in case the service is supported, false otherwise. - */ + @param ServiceName + name of service to be tested + @return + true, if service is supported, false otherwise + */ boolean supportsService( [in] string ServiceName ); - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::lang::XServiceInfo::getSupportedServiceNames - /** returns the names of the services supported by this implementation. - - <p> + /** Provides the supported service names of the implementation, including + also indirect service names. - @returns - a sequence of the names of all supported services. - - */ + @return + sequence of service names that are supported + */ sequence<string> getSupportedServiceNames(); - }; //============================================================================= @@ -123,6 +110,9 @@ interface XServiceInfo: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2002/01/18 15:34:15 jbu + #96701# API review + Revision 1.6 2001/03/16 15:10:37 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/lang/XSingleComponentFactory.idl b/udkapi/com/sun/star/lang/XSingleComponentFactory.idl index fadebb8f4f64..97c2d2ae6ccf 100644 --- a/udkapi/com/sun/star/lang/XSingleComponentFactory.idl +++ b/udkapi/com/sun/star/lang/XSingleComponentFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSingleComponentFactory.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: dbo $ $Date: 2001-05-04 14:24:26 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,19 +70,17 @@ module com { module sun { module star { module lang { -/** A factory supports this interface if the component which is created - by this factory implements the service specification defined by the - factory. +/** Factory interface to create instances of an implementation of a service + specification. @see XInitialization - @see XMultiServiceFactory */ interface XSingleComponentFactory : com::sun::star::uno::XInterface { - /** Creates an instance of a component. + /** Creates an instance of a service implementation. @param Context - context the component instance gets its deployment values from + the instance gets its deployment values from this @return component instance */ @@ -90,14 +88,13 @@ interface XSingleComponentFactory : com::sun::star::uno::XInterface [in] com::sun::star::uno::XComponentContext Context ) raises (com::sun::star::uno::Exception); - /** Creates an instance of a component and initializes the new object + /** Creates an instance of a component and initializes the new instance with the given arguments and context. - @see XInitialization::init @param Arguments - arguments + arguments passed to implementation @param Context - context the component instance gets its deployment values from + the instance gets its deployment values from this @return component instance */ diff --git a/udkapi/com/sun/star/lang/XSingleServiceFactory.idl b/udkapi/com/sun/star/lang/XSingleServiceFactory.idl index 8bbac93b48fb..824aa40d1025 100644 --- a/udkapi/com/sun/star/lang/XSingleServiceFactory.idl +++ b/udkapi/com/sun/star/lang/XSingleServiceFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSingleServiceFactory.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:37 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,39 +76,34 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: interface com::sun::star::lang::XSingleServiceFactory -/** A factory supports this interface if the component which is created - by this factory implements the service specification defined by the - factory. +/** Factory interface to produce instances of an implementation + of a service specification. + + This interface is deprecated. Please use <type>XSingleComponentFactory</type>. @see XInitialization - @see XMultiServiceFactory - */ + @deprecated +*/ interface XSingleServiceFactory: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::lang::XSingleServiceFactory::createInstance - /** creates an instance of a component. + /** Creates an instance of a service implementation. - <p>This component must support the services specified by the factory.</p> - */ + @return + service instance + */ com::sun::star::uno::XInterface createInstance() - raises( com::sun::star::uno::Exception ); - - //------------------------------------------------------------------------- + raises( com::sun::star::uno::Exception ); - // DocMerge from xml: method com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments - /** creates an instance of a component and initializes the component - with some arguments. + /** Creates an instance of a service implementation initialized with + some arguments. - <p>This component must support the services specified by the factory. </p> - - @see XInitialization::init - */ + @param aArguments + arguments passed to implementation + @return + service instance + */ com::sun::star::uno::XInterface createInstanceWithArguments( [in] sequence<any> aArguments ) - raises( com::sun::star::uno::Exception ); - + raises( com::sun::star::uno::Exception ); }; //============================================================================= @@ -118,6 +113,9 @@ interface XSingleServiceFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/03/16 15:10:37 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2000/12/13 15:47:01 mi symtactical documentation and minor semantic documentation flaws fixed diff --git a/udkapi/com/sun/star/lang/XUnoTunnel.idl b/udkapi/com/sun/star/lang/XUnoTunnel.idl index 3816a2a608df..4f04364bf123 100644 --- a/udkapi/com/sun/star/lang/XUnoTunnel.idl +++ b/udkapi/com/sun/star/lang/XUnoTunnel.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnoTunnel.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 14:57:39 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:20 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,23 +73,35 @@ module com { module sun { module star { module lang { //============================================================================= -// DocMerge from xml: interface com::sun::star::lang::XUnoTunnel -/** the interface to tunnel UNO. This means providing access to data - or something else, which is not specified in the UNO-IDL.<br> - */ -interface XUnoTunnel: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- +/** An interface to tunnel UNO. This means providing access to data or + something else, which is not specified by UNO-IDL. - // DocMerge from xml: method com::sun::star::lang::XUnoTunnel::getSomething - /** call this method to get something which is not specified in UNO. + @attention + Restrictive useage. Use only, if there is no better possibility left. + It is definitely a hack. - <p>The identifier specifies how the return is specified. The identifier - must be globally unique, because it is unknown where the implementation - lies.</p> - */ + <p> + Common usage: + Getting a C++ object pointer in the same process, thus to use an + implementation directly, most often because of a design flaw. + </p> +*/ +interface XUnoTunnel: com::sun::star::uno::XInterface +{ + /** Call this method to get something which is not specified in UNO, e.g. + an address to some C++ object. + + @attention + The identifier specifies how the return value is to be reinterpreted. + The identifier must be globally unique, because it is unknown where + the implementation resides. + + @param aIdentifier + identifier + @return + something + */ hyper getSomething( [in] sequence< byte > aIdentifier ); - }; //============================================================================= @@ -99,6 +111,9 @@ interface XUnoTunnel: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 14:57:39 mi + proofing by Richard Holt + Revision 1.6 2001/03/16 15:10:37 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/reflection/CoreReflection.idl b/udkapi/com/sun/star/reflection/CoreReflection.idl index d0a1ca8337a0..c0276a658ba9 100644 --- a/udkapi/com/sun/star/reflection/CoreReflection.idl +++ b/udkapi/com/sun/star/reflection/CoreReflection.idl @@ -2,9 +2,9 @@ * * $RCSfile: CoreReflection.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: dbo $ $Date: 2000-11-23 11:27:48 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,10 +72,13 @@ //============================================================================= -/** This service is the implementation of the interface XIdlReflection. +/** This service is the implementation of the API reflection. + You can obtain information about types and call on objects. */ service CoreReflection { + /** Interface to reflect types. + */ interface com::sun::star::reflection::XIdlReflection; }; @@ -86,6 +89,9 @@ service CoreReflection /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2000/11/23 11:27:48 dbo + #80612# XIdlClassProvider deprecated, XIdlReflection to be supported + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XIdlClass.idl b/udkapi/com/sun/star/reflection/XIdlClass.idl index b4f988a6f303..37a6c78b984c 100644 --- a/udkapi/com/sun/star/reflection/XIdlClass.idl +++ b/udkapi/com/sun/star/reflection/XIdlClass.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlClass.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * 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 reflection { +module com { module sun { module star { module reflection { interface XIdlField; interface XIdlMethod; @@ -83,211 +83,160 @@ interface XIdlArray; //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlClass -/** provides information about a type or module in an UNO environment. - - - Every array also belongs to a type that is reflected as an - <type>XIdlClass</type> object that is shared by all arrays with the - same element type and number of dimensions. Finally, any of the - primitive IDL types are also represented as <type>XIdlClass</type> - objects. These include "void, any, boolean, char, float, double, octet, - short, long, hypher, unsigned octet, unsigned short, unsigned long, and - unsigned hypher". - */ +/** Provides information reflecting an UNO type. +*/ interface XIdlClass: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getClasses - /** @returns - all types and modules which are declared in this class. - */ + /** Deprecated. Do not call. + @deprecated + */ sequence<XIdlClass> getClasses(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getClass - /** @returns - a type or module with the given name that is declared in this - class. - */ + /** Deprecated. Do not call. + @deprecated + */ XIdlClass getClass( [in] string aName ); - //------------------------------------------------------------------------- + /** Tests whether two reflecting objects reflect the same type. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::equals - /** @returns - <TRUE/> if the instances describe the same type, - otherwise <FALSE/>. - */ + @returns + true, if the objects reflect the same type, false otherwise. + */ boolean equals( [in] XIdlClass Type ); - //------------------------------------------------------------------------- + /** Tests whether values of this reflected type are assignable from values + of a second one (<code>xType</code>). - // DocMerge from xml: method com::sun::star::reflection::XIdlClass::isAssignableFrom - /** tests if the parameter <var>xType</var> is a subclass of this - class. - */ + @param xType + another reflected type + @return + true, if values of this reflected type are assignable + from values of <code>xType</code>. + */ boolean isAssignableFrom( [in] XIdlClass xType ); - //------------------------------------------------------------------------- + /** Returns the <type scope="com::sun::star::uno">TypeClass</type> + of the reflected type. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getTypeClass - /** @returns - the type that this instance represents. - */ + @returns + type class of the reflected type. + */ com::sun::star::uno::TypeClass getTypeClass(); - //------------------------------------------------------------------------- + /** Returns the fully-qualified name of the reflected type. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getName - /** @returns - the fully-qualified name of the type of object - (class, interface, array, sequence, struct, union, enum, or - primitive) represented by this <type>XIdlClass</type>. - */ + @returns + the fully-qualified name of the type + */ string getName(); - //------------------------------------------------------------------------- + /** Deprecated. Do not call. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getUik - /** @returns - the UIK from this type. If the type has no UIK, then the - returned UIK is zero. - */ + @deprecated + */ com::sun::star::uno::Uik getUik(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlClass::getSuperclasses + /** If the reflected type is an interface, then the returned + sequence of <type>XIdlClass</type> reflect the base interfaces. + <br> + If the reflected type is not an interface or an interface that is + not derived from another, then an empty sequence is returned. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getSuperclasses - /** If this object represents an interface or a class, - then the objects that represents the superclasses or superinterfaces - of that class are returned. - <p> - If this object is the one that represents the topmost class - or interface, an empty sequence is returned. - - @return the superclass or interface of the type represented by this object. - */ + @return + all base interfaces of an interface type or an empty sequence. + */ sequence<XIdlClass> getSuperclasses(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlClass::getInterfaces - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getInterfaces - /** Determines the interfaces implemented by the class or interface - represented by this object. - <p> - If the class or interface implements no interfaces, the method - returns a sequence of length 0. - - @return a sequence of interfaces implemented by this class. - */ + /** Deprecated. Do not call. + @deprecated + */ sequence<XIdlClass> getInterfaces(); - //------------------------------------------------------------------------- + /** If the reflected type is an array or sequence, then this method + returns a <type>XIdlClass</type> interface reflecting + the element. - // DocMerge from xml: method com::sun::star::reflection::XIdlClass::getComponentType - /** If this class represents an array or sequence type, this method - returns the <type>XIdlClass</type> object representing the - component type of the array or sequence; otherwise, it returns - <NULL/>. - */ + @return + reflection interface of the element type of an array or + sequence type (null-reference otherwise). + */ XIdlClass getComponentType(); - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getField - /** @returns - an <type>XIdlField</type> that reflects the specified member - field of the class, interface, struct, union, enum, or - exception represented by this <type>XIdlClass</type> object. - If a field with the specified name is not found, 0 is returned. - - <p>The field to be reflected is located by searching all the - member fields of the class, interface, struct, union, enum, or - exception represented by this <type>XIdlClass</type> object - for a field with the specified name or for NULL, if a field - with the specified name is not found. - - @param aName - specifies the simple name of the desired field. - */ + /** If the reflected type is an interface, struct or union, then you + get a <type>XIdlField</type> interface reflecting the demanded + field (/interface attribute) by name. + <br> + If the reflected type is not an interface, struct or union or the + interace, struct or union does not have a field (/interface attribute) + with the demanded name, then a null-reference is returned. + + @param aName + name of the demanded field reflection + @return + demanded field (/interface attribute) reflection (or null-reference) + */ XIdlField getField( [in] string aName ); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlClass::getFields - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getFields - /** Returns a sequence containing Field objects reflecting all the - accessible fields of the class, interface, struct, union, or enum represented - by this XIdlClass object. Returns a sequence of length 0 if the - class or interface has no accessible fields, or if it - represents an array, a sequence, or a primitive type. - - <p>Specifically, if this XIdlClass object represents a class, - returns the fields of this class and of all its - superclasses. If this XIdlClass object represents an interface, - returns the fields of this interface and of all its - superinterfaces. If this XIdlClass object represents an array, - sequence or primitive type, returns a sequence of length 0. - */ + /** If the reflected type is an interface, struct or union, then you + get a sequence of <type>XIdlField</type> interfaces reflecting all fields + (/interface attributes). This also includes all inherited + fields (/interface attributes) of the interface, struct of union. + <br> + If the reflected type is not an interface, struct or union or the + interface, struct or union does not have any field (/interface attribute), + then an empty sequence is returned. + + @return + all field (/interface attribute) reflections (or empty sequence) + */ sequence<XIdlField> getFields(); - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getMethod - /** @returns - an <type>XIdlMethod</type> that reflects the specified - member method of the interface represented by this - <type>XIdlClass</type> object. If a method with the specified - name is not found, "0" is returned. - - <p>The method to be reflected is located by searching all the - member methods of the interface represented by this - <type>XIdlClass</type> object for a method with the specified - name. - - @param aName - specifies the simple name of the desired method. - */ + /** If the reflected type is an interface, then you get + a <type>XIdlMethod</type> interface reflecting the demanded method by name. + <br> + If the reflected type is not an interface or the interface does not have + a method with the demanded name (including inherited methods), + then a null-reference is returned. + + @param aName + name of demanded method reflection + @return + demanded method reflection (or null-reference) + */ XIdlMethod getMethod( [in] string aName ); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlClass::getMethods + /** If the reflected type is an interface, then you get + a sequence of <type>XIdlMethod</type> interfaces reflecting all methods + of the interface. This also includes the inherited methods of the interface. + <br> + If the reflected type is not an interface or the interface + does not have any methods, then a null-reference is returned. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getMethods - /** Returns a sequence containing XIdlMethod objects reflecting all the - <em>member</em> methods of the class or interface - represented by this XIdlClass object, including those declared by - the class or interface and and those inherited from - superclasses and superinterfaces. Returns a sequence of length 0 - if the class or interface has no member methods. - - */ + @return + all method reflections (or empty sequence) + */ sequence<XIdlMethod> getMethods(); - //------------------------------------------------------------------------- + /** If the reflected type is an array, then you get + a <type>XIdlArray</type> interface to modify instances of the array type. + <br> + If the reflected type is not an array, then a null-reference is returned. - // DocMerge from idl: method com::sun::star::reflection::XIdlClass::getArray - /** @returns - the <type>XIdlArray</type> interface to get and set the - elements by index if the represented type is an array or - sequence. - */ + @return + inteface to modify array instances (or null-reference) + */ XIdlArray getArray(); - //------------------------------------------------------------------------- + /** This method creates instances of the reflected type. - // DocMerge from xml: method com::sun::star::reflection::XIdlClass::createObject - /** creates an instance of the type represented by this - <type>XIdlClass</type> object if the represented type is a - basic type, struct, enum, or sequence. - */ - void createObject( [out] any obj ); + @attention + Instances of type <code>any</code> can not be passed using an <code>any</code>, because + anys cannot be nested. So if the reflected type is an <code>any</code>, then the + returned value is empty. + @param obj + pure out parameter to pass the created instance + */ + void createObject( [out] any obj ); }; //============================================================================= @@ -297,6 +246,9 @@ interface XIdlClass: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.6 2001/03/16 15:10:38 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/reflection/XIdlClassProvider.idl b/udkapi/com/sun/star/reflection/XIdlClassProvider.idl index f99911e079e4..0ed4c7987be0 100644 --- a/udkapi/com/sun/star/reflection/XIdlClassProvider.idl +++ b/udkapi/com/sun/star/reflection/XIdlClassProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlClassProvider.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,24 +76,13 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlClassProvider -/** makes it possible to access the <type>XIdlClass</type> interfaces of the - implementation. - */ +/** Deprecated interface. Do not use anymore. + + @deprecated +*/ interface XIdlClassProvider: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlClassProvider::getIdlClasses - - // DocMerge from idl: method com::sun::star::reflection::XIdlClassProvider::getIdlClasses - /** Returns the sequence of the XIdlClasses, that represents the type of the implementation. - If the object does not aggregate other objects, then the length of the sequence is 1. - If the object aggregates other objects, then all XIdlClasses from these objects - are appended to the sequence. - - */ sequence<com::sun::star::reflection::XIdlClass> getIdlClasses(); - }; //============================================================================= @@ -103,6 +92,9 @@ interface XIdlClassProvider: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.5 2001/03/16 15:10:38 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/reflection/XIdlReflection.idl b/udkapi/com/sun/star/reflection/XIdlReflection.idl index c97fcb4de2b9..fb643db49def 100644 --- a/udkapi/com/sun/star/reflection/XIdlReflection.idl +++ b/udkapi/com/sun/star/reflection/XIdlReflection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlReflection.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,43 +76,35 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlReflection -/** offers access to the repository of all known IDL types. +/** Interface to reflect types. - <p>The core reflection service has the name "uno.CoreReflection". - You can get this service from the global service manager. - The implementation of this interface must also look in the - global service manager (<code>getGlobalServiceManager()</code>) to - get the <type>XIdlClass</type> from a service provider. - - </p> - <p>For information about the concept see <a>href=service.html&gt;Global Service Manager</a>. - - </p> - */ + @see CoreReflection + @see XIdlClass +*/ interface XIdlReflection: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XIdlReflection::forName - /** @example The following code fragment returns the run-time - descriptor for the interface named <code>XInterface</code>: - - <listing> - IdlClass = xIdlReflection.forName("XInterface") - </listing> - */ + /** Obtaining a reflection interface for a type. You specify the type by + its name. + If the given type name can not be reflected, then a null-reference + is returned. + + @param aTypeName + the type's name + @return + reflection interface for the demanded type (or null) + */ com::sun::star::reflection::XIdlClass forName( [in] string aTypeName ); - //------------------------------------------------------------------------- + /** Obtaining a reflection interface for an object. This method takes + the type of the object the any contains into account. If the any + contains no object, then a null-reference is returned. - // DocMerge from idl: method com::sun::star::reflection::XIdlReflection::getType - /** @returns - the <type>XIdlClass</type> that represents the type of - passed object. - */ + @param aObj + an object + @return + reflection interface of the type of the demanded object (or null) + */ com::sun::star::reflection::XIdlClass getType( [in] any aObj ); - }; //============================================================================= @@ -122,6 +114,9 @@ interface XIdlReflection: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.5 2001/03/16 15:10:38 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/script/CannotConvertException.idl b/udkapi/com/sun/star/script/CannotConvertException.idl index b340ed523549..bf28117c43ef 100644 --- a/udkapi/com/sun/star/script/CannotConvertException.idl +++ b/udkapi/com/sun/star/script/CannotConvertException.idl @@ -2,9 +2,9 @@ * * $RCSfile: CannotConvertException.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,34 +76,24 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::script::CannotConvertException -/** is thrown to indicate that a type conversion can not be performed. - */ +/** This exception is thrown to indicate that a type conversion can not be performed. +*/ exception CannotConvertException: com::sun::star::uno::Exception { - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::CannotConvertException::DestinationTypeClass - /** contains the class of the type to which the value should be + /** This member contains the class of the type to which the value should be converted. - */ + */ com::sun::star::uno::TypeClass DestinationTypeClass; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::CannotConvertException::Reason - /** contains the reason that the conversion failed. - */ + /** This member contains the reason that the conversion failed. + Have a look at <type>FailReason</type>. + */ long Reason; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::script::CannotConvertException::ArgumentIndex /** If the conversion of a method argument fails, this is the index of the value in the "IN" argument list. [optional] - */ + */ long ArgumentIndex; - }; //============================================================================= @@ -113,6 +103,9 @@ exception CannotConvertException: com::sun::star::uno::Exception /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:35 hjs initial import diff --git a/udkapi/com/sun/star/script/Converter.idl b/udkapi/com/sun/star/script/Converter.idl index 84cfdf1108ed..356a81db163b 100644 --- a/udkapi/com/sun/star/script/Converter.idl +++ b/udkapi/com/sun/star/script/Converter.idl @@ -2,9 +2,9 @@ * * $RCSfile: Converter.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,69 +72,59 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::script::Converter -/** This service provide a widening converter. This means it can convert - from one type to another, if possible. - - What is possible?<br> - byte: byte, (short *1), (long *1), (hyper *1), (float *1), (double *1), (enum *2), (any *3), - boolean, (char *4), (string *5)<br> - short: byte, short, (long *1), (hyper *1), (float *7), (double *7), (enum *2), (any *3), - boolean, char, (string *5)<br> - long: byte, short, long, (hyper *1), (float *7), (double *7), enum, (any *3), - boolean, char, (string *5)<br> - hyper: byte, short, long, hyper, (float *7), (double *7), enum, (any *3), - boolean, char, (string *5)<br> - float: byte, short, long, hyper, float, (double *7), (enum *8), (any *3), - boolean, char, (string *5)<br> - double: byte, short, long, hyper, float, double, enum, (any *3), - boolean, char, (string *5)<br> - enum: (byte *9), (short *9), (long *9), (hyper *9), (float *9), (double *9), (enum *10), (any *3), - (string *11)<br> - void: ok for all types. - any: ok for all types. - boolean: byte, short, long, hyper, float, double, (any *3), - boolean, char, (string *12). 0 -&gt; false, != 0 -&gt; true<br> - char: byte, short, (long *1), (hyper *1), (float *7), (double *7), enum, (any *3), - boolean, char, (string *13)<br> - string: byte, short, long, hyper, float, double, enum, (any *3), - boolean, char, string<br> - struct: (any *3), (struct *14) - interface: (any *3), (struct *14) - exception: (any *3), (exception *14) - union: (any *3), (union *14) - sequence: (any *3), (sequence *15) - - - short: byte, short, (long *1), (hyper *1), (float *1), (double *1), (enum *2), (any *3), - boolean, (char *4), (string *5), (interface *6)<br> - - 1: only convert if the value is in the range of the target type.<br> - 2: only convert if the value, not the position, of the enum is in the range of the target type.<br> - 3: get value until it is not an any. Then convert it with the other rules.<br> - 4: only convert if the value of the character is between 0 - 255.<br> - 5: only convert if the value represents a decimal, hexadecimal (0x...) or a floating point number. - Examples: 10, 0x10, 10.045, 10,555, +10, +10.6e10, -10.6e-10, .16. - 6: only convert if the interface supplies the <!-- jrh: missing object of sentence. --> - 7: only convert if the value is in the range of the target type. - The value is rounded to an integer.<br> - 8: only converted if the float can be converted back to the same enum value. - 9: only converted if the number is one of the enumeration type values. Normally you need - core reflection information of the enum type. - 10: only converted if it is the same enumeration type. - 11: only converted if the string contains the name of an enumeration type value. Normally you need - core reflection information of the enum type. - 12: only converted if the value of the string is "1", "true" or "0", "false". The comparision - is case insensitive. - 13: only converted if the length of the string is 1 or 0. - 14: only converted if the types are equal or the source type is derived from the destination - type. - 15: only converted if each element of the source sequence can be converted to an element - of the destination sequence. - */ +/** This service provides a widening converter converting from one type to another, + if possible.<br> + + What is possible? + <ul> + <li>byte: byte, (short *1), (long *1), (hyper *1), (float *1), (double *1), (enum *2), (any *3), boolean, (char *4), (string *5)</li> + <li>short: byte, short, (long *1), (hyper *1), (float *7), (double *7), (enum *2), (any *3), boolean, char, (string *5)</li> + <li>long: byte, short, long, (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li> + <li>hyper: byte, short, long, hyper, (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li> + <li>float: byte, short, long, hyper, float, (double *7), (enum *8), (any *3), boolean, char, (string *5)</li> + <li>double: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, (string *5)</li> + <li>enum: (byte *9), (short *9), (long *9), (hyper *9), (float *9), (double *9), (enum *10), (any *3), (string *11)</li> + <li>void: ok for all types</li> + <li>any: ok for all types</li> + <li>boolean: byte, short, long, hyper, float, double, (any *3), boolean, char, (string *12). 0 => false, != 0 => true</li> + <li>char: byte, short, (long *1), (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *13)</li> + <li>string: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, string</li> + <li>struct: (any *3), (struct *14)</li> + <li>interface: (any *3), (struct *14)</li> + <li>exception: (any *3), (exception *14)</li> + <li>union: (any *3), (union *14)</li> + <li>sequence: (any *3), (sequence *15)</li> + </ul> + + rules: + <ul> + <li>1: only converts if the value is in the range of the target type.</li> + <li>2: only converts if the value, not the position, of the enum is in the range of the target type.</li> + <li>3: get value until it is not an any. Then convert it with the other rules.</li> + <li>4: only converts if the value of the character is between 0 - 255.</li> + <li>5: only converts if the value represents a decimal, hexadecimal (0x...) or a floating point number. + Examples: 10, 0x10, 10.045, 10,555, +10, +10.6e10, -10.6e-10, .16.</li> + <li>7: only converts if the value is in the range of the target type. + The value is rounded to an integer.</li> + <li>8: only converts if the float can be converted back to the same enum value.</li> + <li>9: only converts if the number is one of the enumeration type values. Normally you need + reflection information of the enum type.</li> + <li>10: only converts if it is the same enumeration type.</li> + <li>11: only converts if the string contains the name of an enumeration type value. Normally you need + core reflection information of the enum type.</li> + <li>12: only converts if the value of the string is "1", "true" or "0", "false". The comparision + is case insensitive.</li> + <li>13: only converts if the length of the string is 1 or 0.</li> + <li>14: only converts if the types are equal or the source type is derived from the destination + type.</li> + <li>15: only converts if each element of the source sequence can be converted to an element + of the destination sequence.</li> + </ul> +*/ service Converter { - // DocMerge: empty anyway + /** Conversion interface. + */ interface com::sun::star::script::XTypeConverter; }; @@ -146,6 +136,9 @@ service Converter /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/11/16 15:09:06 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:52 mi moved from api diff --git a/udkapi/com/sun/star/script/FailReason.idl b/udkapi/com/sun/star/script/FailReason.idl index c72ba6f5edf0..e7804a4e5be2 100644 --- a/udkapi/com/sun/star/script/FailReason.idl +++ b/udkapi/com/sun/star/script/FailReason.idl @@ -2,9 +2,9 @@ * * $RCSfile: FailReason.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:10:40 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,91 +68,51 @@ //============================================================================= -// DocMerge from idl: constants com::sun::star::script::FailReason -/** these values are used to specify the reason why a type conversion failed. - */ +/** These values specify the reason why a type conversion failed. +*/ constants FailReason { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::1 - - // DocMerge from idl: value com::sun::star::script::FailReason::OUT_OF_RANGE /** The given value does not fit in the range of the destination type. - */ + */ const long OUT_OF_RANGE = 1; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::2 - - // DocMerge from idl: value com::sun::star::script::FailReason::IS_NOT_NUMBER /** The given value cannot be converted to a number. - */ + */ const long IS_NOT_NUMBER = 2; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::3 - - // DocMerge from idl: value com::sun::star::script::FailReason::IS_NOT_ENUM /** The given value cannot be converted to an enumeration. - */ + */ const long IS_NOT_ENUM = 3; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::4 - - // DocMerge from idl: value com::sun::star::script::FailReason::IS_NOT_BOOL /** The given value cannot be converted to a boolean. - */ + */ const long IS_NOT_BOOL = 4; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::5 - - // DocMerge from idl: value com::sun::star::script::FailReason::NO_SUCH_INTERFACE /** The given value is not an interface or cannot queried to the right interface. - */ + */ const long NO_SUCH_INTERFACE = 5; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::6 - - // DocMerge from idl: value com::sun::star::script::FailReason::SOURCE_IS_NO_DERIVED_TYPE /** The given value cannot be converted to right structure or exception type. - */ + */ const long SOURCE_IS_NO_DERIVED_TYPE = 6; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::7 - - // DocMerge from idl: value com::sun::star::script::FailReason::TYPE_NOT_SUPPORTED /** The type class of the given value is not supported. - */ + */ const long TYPE_NOT_SUPPORTED = 7; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::8 - - // DocMerge from idl: value com::sun::star::script::FailReason::INVALID /** The given value cannot be converted and none of the other reasons match. - */ + */ const long INVALID = 8; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::9 - - // DocMerge from idl: value com::sun::star::script::FailReason::NO_DEFAULT_AVAILABLE - /** @deprecated - */ + /** This value is deprecated. Do not use. + @deprecated + */ const long NO_DEFAULT_AVAILABLE = 9; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR constants::10 - - // DocMerge from idl: value com::sun::star::script::FailReason::UNKNOWN - /** @deprecated - */ + /** This value is deprecated. Do not use. + @deprecated + */ const long UNKNOWN = 10; - }; //============================================================================= @@ -162,6 +122,9 @@ constants FailReason /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/11/16 15:10:40 mi + proofing by Richard Holt + Revision 1.5 2001/11/16 15:09:06 mi proofing by Richard Holt diff --git a/udkapi/com/sun/star/script/InvocationAdapterFactory.idl b/udkapi/com/sun/star/script/InvocationAdapterFactory.idl index 4d7a98f60578..a3f8ee23ff3d 100644 --- a/udkapi/com/sun/star/script/InvocationAdapterFactory.idl +++ b/udkapi/com/sun/star/script/InvocationAdapterFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvocationAdapterFactory.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:52 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -65,6 +65,10 @@ #include <com/sun/star/script/XInvocationAdapterFactory.idl> #endif +#ifndef __com_sun_star_script_XInvocationAdapterFactory2_idl__ +#include <com/sun/star/script/XInvocationAdapterFactory2.idl> +#endif + //============================================================================= @@ -72,16 +76,19 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::script::InvocationAdapterFactory -/** allows you to create adapter interfaces of any given type for an invocation - interface. - <p>You can do this via an adapter factory instance.</p> - <br> - */ +/** Service to create adapter objects giving types to be supported and a + an invocation interface incoming calls are delegated to. +*/ service InvocationAdapterFactory { - // DocMerge: empty anyway + /** Interface for creating adapter objects. + This interface is deprecated. Use <type>XInvocationAdapterFactory2</type>. + @deprecated + */ interface com::sun::star::script::XInvocationAdapterFactory; + /** Interface for creating adapter objects. + */ + interface com::sun::star::script::XInvocationAdapterFactory2; }; //============================================================================= @@ -91,6 +98,9 @@ service InvocationAdapterFactory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:52 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:35 hjs initial import diff --git a/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl b/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl index f3ac4dd5b8d4..362058c430d5 100644 --- a/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl +++ b/udkapi/com/sun/star/script/XInvocationAdapterFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocationAdapterFactory.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:40 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,31 +76,29 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::script::XInvocationAdapterFactory -/** creates adapter interfaces of any given type for an invocation - interface by using this adapter factory interface. - <br> - */ +/** Interface to create adapter objects giving a type to be supported and a + an invocation interface incoming calls are delegated to. + + This interface is deprecated. Use <type>XInvocationAdapterFactory2</type>. + @deprecated +*/ interface XInvocationAdapterFactory: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XInvocationAdapterFactory::createAdapter /** Creates an adapter interface of given type for calling the given - XInvocation interface. + <type>XInvocation</type> interface. @param Invocation - invocation interface being called on incoming adapter calls - + invocation interface being called on incoming adapter calls @param aType - type of adapter interface given back + supported type of adapter @returns - adapter interface; this interface can be queried for - XInterface and given type - */ - com::sun::star::uno::XInterface createAdapter( [in]XInvocation Invocation, - [in]type aType ); + adapter interface; this interface can be queried for + XInterface and given type + */ + com::sun::star::uno::XInterface createAdapter( + [in]XInvocation Invocation, + [in]type aType ); }; //============================================================================= @@ -110,6 +108,9 @@ interface XInvocationAdapterFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/03/16 15:10:40 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.5 2001/01/31 09:45:41 mi TYPE_XIDLCLASS is now 'type' diff --git a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl index 7ea9f71e30c2..d244c55f1704 100644 --- a/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl +++ b/udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInvocationAdapterFactory2.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,8 +58,8 @@ * * ************************************************************************/ -#ifndef __com_sun_star_script_XInvocationAdapterFactory_idl__ -#define __com_sun_star_script_XInvocationAdapterFactory_idl__ +#ifndef __com_sun_star_script_XInvocationAdapterFactory2_idl__ +#define __com_sun_star_script_XInvocationAdapterFactory2_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> @@ -72,32 +72,28 @@ //============================================================================= - module com { module sun { module star { module script { +module com { module sun { module star { module script { -//============================================================================= -/** - You can create adapter object of given types for an invocation - interface by using this adapter factory interface. - - @author Daniel Boelzle - @version 1.0 08/22/00 +/** Interface to create adapter objects giving types to be supported and a + an invocation interface incoming calls are delegated to. */ interface XInvocationAdapterFactory2 : com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - /** - Creates an adapter object of given types for calling the given - XInvocation interface. - <BR> - @param Invocation - invocation interface being called on incoming adapter calls - @param aTypes - types of adapter - @return adapter; - this interface can be queried for given types - */ + /** Creates an adapter interface of given types for calling the given + <type>XInvocation</type> interface. + + @param Invocation + invocation interface being called on incoming adapter calls + @param aType + supported types of adapter + + @returns + adapter interface; this interface can be queried for + XInterface and given types + */ com::sun::star::uno::XInterface createAdapter( - [in] XInvocation Invocation, [in] sequence< type > aTypes ); + [in] XInvocation Invocation, + [in] sequence< type > aTypes ); }; //============================================================================= @@ -107,6 +103,9 @@ interface XInvocationAdapterFactory2 : com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 15:09:06 mi + proofing by Richard Holt + Revision 1.6 2001/03/16 15:10:40 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/script/XTypeConverter.idl b/udkapi/com/sun/star/script/XTypeConverter.idl index 562e4cbdac3d..69c0a0acfdcc 100644 --- a/udkapi/com/sun/star/script/XTypeConverter.idl +++ b/udkapi/com/sun/star/script/XTypeConverter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTypeConverter.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,31 +88,50 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::script::XTypeConverter -/** provides standard type conversions. - */ +/** Interface to provide standard type conversions. + + @see Converter +*/ interface XTypeConverter: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XTypeConverter::convertTo - /** converts the value in <var>aFrom</var> to the specified type - */ - any convertTo( [in] any aFrom, - [in] type xDestinationType ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::script::CannotConvertException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::script::XTypeConverter::convertToSimpleType - /** converts the value in <var>aFrom</var> to the specified simple type. - */ - any convertToSimpleType( [in] any aFrom, - [in] com::sun::star::uno::TypeClass aDestinationType ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::script::CannotConvertException ); - + /** Converts the value <code>aFrom</code> to the specified type + <code>xDestinationType</code>. + Throws an <type>CannotConvertException</type> if the conversion + failed. + + @param aFrom + source value + @param xDestinationType + destination type + @return + converted value (any carrying value of type <code>xDestinationType</code> + */ + any convertTo( + [in] any aFrom, + [in] type xDestinationType ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::script::CannotConvertException ); + + /** Converts the value <code>aFrom</code> to the specified simple type + <code>aDestinationType</code>. + Throws an <type>CannotConvertException</type> if the conversion + failed and an <type scope="com::sun::star::lang">IllegalArgumentException</type> + if the destination + <type scope="com::sun::star::uno">TypeClass</type> is not simple, + e.g. not long or byte. + + @param aFrom + source value + @param aDestinationType + destination type class + @return + converted value (any carrying value of type <code>aDestinationType</code> + */ + any convertToSimpleType( + [in] any aFrom, + [in] com::sun::star::uno::TypeClass aDestinationType ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::script::CannotConvertException ); }; //============================================================================= @@ -122,6 +141,9 @@ interface XTypeConverter: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 15:09:06 mi + proofing by Richard Holt + Revision 1.6 2001/03/16 15:10:40 jsc remove interfaceheader with uik and remove [const] in method definitions diff --git a/udkapi/com/sun/star/test/performance/XPerformanceTest.idl b/udkapi/com/sun/star/test/performance/XPerformanceTest.idl index dc82a116f778..e44eabd05b2f 100644 --- a/udkapi/com/sun/star/test/performance/XPerformanceTest.idl +++ b/udkapi/com/sun/star/test/performance/XPerformanceTest.idl @@ -2,9 +2,9 @@ * * $RCSfile: XPerformanceTest.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:43 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,9 +76,8 @@ module test module performance { -/** - * struct of simple types to be carried. - */ +/** struct of simple types to be carried +*/ struct SimpleTypes { boolean Bool; @@ -93,9 +92,8 @@ struct SimpleTypes float Float; double Double; }; -/** - * struct ComplexTypes adding Sequence, String, Interface, Any to SimpleTypes. - */ +/** struct ComplexTypes adding Sequence, String, Interface, Any to SimpleTypes +*/ struct ComplexTypes : SimpleTypes { sequence< long > Sequence; @@ -104,20 +102,21 @@ struct ComplexTypes : SimpleTypes any Any; }; -/** - * A performance test object has to be implemented in a special way, that:<BR> - * <li>queryInterface() execution times remain (nearly) static</li> - * <li>functions kept simple, thus there is (nearly) no execution time of the function itself</li> - * <li>no dynamic data is ever returned except of createObject(), so return 0, empty strings etc.</li> - * - * The interface is divided into three sections:<BR> - * <li>measuring asynchron/ synchron calls</li> - * <li>complex data calls with/out return value; in/out parameters</li> - * <li>single data types like long, float, string etc.</li> - * <li>method calls versa attribute calls</li> - * <li>raising RuntimeException</li> - *<BR> - */ +/** A performance test object has to be implemented in a special way, that: + <ul> + <li>queryInterface() execution times remain (nearly) static</li> + <li>functions kept simple, thus there is (nearly) no execution time of the function itself</li> + <li>no dynamic data is ever returned except of createObject(), so return 0, empty strings etc.</li> + </ul> + The interface is divided into three sections: + <ul> + <li>measuring asynchron/ synchron calls</li> + <li>complex data calls with/out return value; in/out parameters</li> + <li>single data types like long, float, string etc.</li> + <li>method calls versa attribute calls</li> + <li>raising RuntimeException</li> + </ul> +*/ interface XPerformanceTest : com::sun::star::uno::XInterface { [oneway] void async(); diff --git a/udkapi/com/sun/star/uno/TypeClass.idl b/udkapi/com/sun/star/uno/TypeClass.idl index e1f4feb0ce9a..a0988b330fde 100644 --- a/udkapi/com/sun/star/uno/TypeClass.idl +++ b/udkapi/com/sun/star/uno/TypeClass.idl @@ -2,9 +2,9 @@ * * $RCSfile: TypeClass.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:29:00 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,179 +68,104 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::uno::TypeClass -/** describe all type classes which can be defined in the IDL. - */ +/** This enum describes all type classes of UNO. Every specific type has a type + class specifying the general context of the reflected type. + + <p> + Example: + A type reflecting the interface <type>XInterface</type> is of type class + INTERFACE and its name is "com.sun.star.uno.XInterface". + </p> +*/ enum TypeClass { - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: VOID, - - // DocMerge: empty anyway + /** reflecting the void type; denotes no type + */ VOID, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: CHAR, - - // DocMerge: empty anyway + /** reflecting the 16-bit unicode character type + */ CHAR, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: BOOLEAN, - - // DocMerge: empty anyway + /** reflecting the boolean type; true and false + */ BOOLEAN, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: BYTE, - - // DocMerge: empty anyway + /** reflecting the 8-bit ordinal type + */ BYTE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: SHORT, - - // DocMerge: empty anyway + /** reflecting the signed 16-bit ordinal type + */ SHORT, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: UNSIGNED_SHORT, - - // DocMerge: empty anyway + /** reflecting the unsigned 16-bit ordinal type + */ UNSIGNED_SHORT, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: LONG, - - // DocMerge: empty anyway + /** reflecting the signed 32-bit ordinal type + */ LONG, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: UNSIGNED_LONG, - - // DocMerge: empty anyway + /** reflecting the unsigned 32-bit type + */ UNSIGNED_LONG, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: HYPER, - - // DocMerge: empty anyway + /** reflecting the signed 64-bit ordinal type + */ HYPER, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: UNSIGNED_HYPER, - - // DocMerge: empty anyway + /** reflecting the unsigned 64-bit ordinal type + */ UNSIGNED_HYPER, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: FLOAT, - - // DocMerge: empty anyway + /** reflecting the 32-bit floating point type + */ FLOAT, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: DOUBLE, - - // DocMerge: empty anyway + /** reflecting the 64-bit floating point type + */ DOUBLE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: STRING, - - // DocMerge: empty anyway + /** reflecting the string type; strings of unicode characters + */ STRING, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: TYPE, - - // DocMerge: empty anyway + /** reflecting the meta type + */ TYPE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: ANY, - - // DocMerge: empty anyway + /** reflecting the any type; anys can carry any UNO value except of any values + */ ANY, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: ENUM, - - // DocMerge: empty anyway + /** reflecting enum types + */ ENUM, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: TYPEDEF, - - // DocMerge: empty anyway + /** reflecting typedefed types referencing other types + */ TYPEDEF, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: STRUCT, - - // DocMerge: empty anyway + /** reflecting compound types + */ STRUCT, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: UNION, - - // DocMerge: empty anyway + /** reflecting union types + */ UNION, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: EXCEPTION, - - // DocMerge: empty anyway + /** reflecting exception types + */ EXCEPTION, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: SEQUENCE, - - // DocMerge: empty anyway + /** reflecting sequence types + */ SEQUENCE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: ARRAY, - - // DocMerge: empty anyway + /** reflecting array types + */ ARRAY, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: INTERFACE, - - // DocMerge: empty anyway + /** reflecting interface types + */ INTERFACE, - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: SERVICE, - - // DocMerge: empty anyway + /** reflecting services + */ SERVICE, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: MODULE, - - // DocMerge: empty anyway + /** reflecting modules + */ MODULE, - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: INTERFACE_METHOD, - - // DocMerge: empty anyway + /** reflecting interface methods + */ INTERFACE_METHOD, - - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: INTERFACE_ATTRIBUTE, - - // DocMerge: empty anyway + /** reflecting interface attributes + */ INTERFACE_ATTRIBUTE, - //------------------------------------------------------------------------- - // DOCUMENTATION OMITTED FOR TypeClass:: UNKNOWN - - // DocMerge: empty anyway + /** reflecting the unreflectable type + */ UNKNOWN - }; //============================================================================= @@ -250,6 +175,9 @@ enum TypeClass /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:29:00 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:36:18 hjs initial import diff --git a/udkapi/com/sun/star/uno/Uik.idl b/udkapi/com/sun/star/uno/Uik.idl index b4a5d141308f..c7f245323f8a 100644 --- a/udkapi/com/sun/star/uno/Uik.idl +++ b/udkapi/com/sun/star/uno/Uik.idl @@ -2,9 +2,9 @@ * * $RCSfile: Uik.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:29:00 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,50 +66,32 @@ module com { module sun { module star { module uno { -//============================================================================= - -// DocMerge from xml: struct com::sun::star::uno::Uik -/** specifies a universal interface key. - +/** Specifies an universal interface key (globally unique). - - <p>An UIK is an unambiguous 16-byte value for every interface.</p> - */ + This struct is deprecated. Uiks are not used anymore. + @deprecated +*/ struct Uik { - // DocMerge from xml: field com::sun::star::uno::Uik::m_Data1 /** specifies a 4 byte data block. */ unsigned long m_Data1; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::uno::Uik::m_Data2 /** specifies a 2 byte data block. */ unsigned short m_Data2; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::uno::Uik::m_Data3 /** specifies a 2 byte data block. */ unsigned short m_Data3; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::uno::Uik::m_Data4 /** specifies a 4 byte data block. */ unsigned long m_Data4; - //------------------------------------------------------------------------- - - // DocMerge from xml: field com::sun::star::uno::Uik::m_Data5 /** specifies a 4 byte data block. */ unsigned long m_Data5; - }; //============================================================================= @@ -119,6 +101,9 @@ struct Uik /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:29:00 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:36:18 hjs initial import diff --git a/udkapi/com/sun/star/uno/XComponentContext.idl b/udkapi/com/sun/star/uno/XComponentContext.idl index db6469ac732e..6f77f3a4d254 100644 --- a/udkapi/com/sun/star/uno/XComponentContext.idl +++ b/udkapi/com/sun/star/uno/XComponentContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XComponentContext.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-20 10:20:42 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,9 @@ interface XMultiComponentFactory; module com { module sun { module star { module uno { -/** Component context to be granted to a component for running. - Arbitrary values can be retrieved from the context. +/** Component context to be passed to a component via + <type scope="com::sun::star::lang">XSingleComponentFactory</type>. + Arbitrary values (e.g. deployment values) can be retrieved from the context. */ interface XComponentContext : XInterface { @@ -85,9 +86,14 @@ interface XComponentContext : XInterface value */ any getValueByName( [in] string Name ); - /** Gets the service manager instance to be used (or null). + + /** Gets the service manager instance to be used from key + <code>/singletons/com.sun.star.lang.theServiceManager</code> (maybe null ref). This method has been added for convenience, because the - service manager is an often used object. + service manager is used very often. + + @return + service manager, if any */ com::sun::star::lang::XMultiComponentFactory getServiceManager(); }; diff --git a/udkapi/com/sun/star/uno/XCurrentContext.idl b/udkapi/com/sun/star/uno/XCurrentContext.idl index 9881ce9876c4..1ba743c146af 100644 --- a/udkapi/com/sun/star/uno/XCurrentContext.idl +++ b/udkapi/com/sun/star/uno/XCurrentContext.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCurrentContext.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: mi $ $Date: 2001-11-20 10:20:42 $ + * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,17 +68,19 @@ module com { module sun { module star { module uno { -/** Task local execution context for UNO. +/** Task (e.g. thread) local execution context for UNO. Arbitrary values can be retrieved from the context. - - Use UNO runtime functions to obtain the current context in your language. + <p> + You have to use UNO runtime functions to obtain the current context + in your target language. + </p> + @attention + In general, do not spread the current context across different tasks. + Values of the current context are destined for that task only. */ interface XCurrentContext : XInterface { /** Gets a value from the context. - You should carefully use the obtained value, because the current context - (value container) lives only for the running task (i.e., often the - executing thread) only! @param Name name of value |