diff options
| author | Daniel Boelzle <dbo@openoffice.org> | 2002-03-08 16:19:13 +0000 |
|---|---|---|
| committer | Daniel Boelzle <dbo@openoffice.org> | 2002-03-08 16:19:13 +0000 |
| commit | e12c6f8e77c898a6bc9d320469ab00cbf26d12b5 (patch) | |
| tree | d71e41dfccc2901f2716edd8c2b3624ee0d7027c /udkapi | |
| parent | 027c4df7a750d9a47b022a2edcd86d6727efde71 (diff) | |
#96711# reviewed reflection API documentation
Diffstat (limited to 'udkapi')
26 files changed, 645 insertions, 746 deletions
diff --git a/udkapi/com/sun/star/reflection/CoreReflection.idl b/udkapi/com/sun/star/reflection/CoreReflection.idl index c0276a658ba9..3844552aa5ed 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.6 $ + * $Revision: 1.7 $ * - * last change: $Author: dbo $ $Date: 2002-01-23 08:52:21 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,8 +72,9 @@ //============================================================================= -/** This service is the implementation of the API reflection. - You can obtain information about types and call on objects. +/** This service is the implementation of the reflection API. + You can obtain information about types, modify values of reflected types + and call on objects. */ service CoreReflection { @@ -89,6 +90,9 @@ service CoreReflection /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2002/01/23 08:52:21 dbo + #96711# IDL documentation review + Revision 1.5 2000/11/23 11:27:48 dbo #80612# XIdlClassProvider deprecated, XIdlReflection to be supported diff --git a/udkapi/com/sun/star/reflection/FieldAccessMode.idl b/udkapi/com/sun/star/reflection/FieldAccessMode.idl index 44a601d5fc1a..81450b09bc5d 100644 --- a/udkapi/com/sun/star/reflection/FieldAccessMode.idl +++ b/udkapi/com/sun/star/reflection/FieldAccessMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: FieldAccessMode.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:46 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,43 +68,24 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::reflection::FieldAccessMode -/** These values are used to specify the kind of attribute or property. - */ +/** Denotes the access possibilities via <type>XIdlField2</type> to an + interface attribute, enum or compound type (struct/exception). +*/ enum FieldAccessMode { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FieldAccessMode:: READWRITE, - - // DocMerge from xml: value com::sun::star::reflection::FieldAccessMode::READWRITE - /** The property is readable and writeable - */ + /** readable and writeable + */ READWRITE, - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FieldAccessMode:: READONLY, - - // DocMerge from xml: value com::sun::star::reflection::FieldAccessMode::READONLY - /** The property is readonly - */ + /** readable only + */ READONLY, - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FieldAccessMode:: WRITEONLY, - - // DocMerge from xml: value com::sun::star::reflection::FieldAccessMode::WRITEONLY - /** The property is write only - */ + /** writeable only + */ WRITEONLY, - - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR FieldAccessMode:: CONST - - // DocMerge from xml: value com::sun::star::reflection::FieldAccessMode::CONST - /** @deprecated - */ + /** Deprecated. Not used anymore. + @deprecated + */ CONST - }; //============================================================================= @@ -114,6 +95,9 @@ enum FieldAccessMode /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:46 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:31 hjs initial import diff --git a/udkapi/com/sun/star/reflection/InvocationTargetException.idl b/udkapi/com/sun/star/reflection/InvocationTargetException.idl index a5f5457c7def..92b8bc6f5d53 100644 --- a/udkapi/com/sun/star/reflection/InvocationTargetException.idl +++ b/udkapi/com/sun/star/reflection/InvocationTargetException.idl @@ -2,9 +2,9 @@ * * $RCSfile: InvocationTargetException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,14 +72,11 @@ //============================================================================= -// DocMerge from xml: exception com::sun::star::reflection::InvocationTargetException -/** is a checked exception that wraps another exception. +/** This exception denotes a checked exception (wrapping an originating exception) + and may be thrown upon using invocation API. - - <p>Typically such exceptions are thrown by an invoked method or constructor. - - </p>@see XIdlMethod - */ + @see XIdlMethod +*/ exception InvocationTargetException: com::sun::star::lang::WrappedTargetException { }; @@ -91,6 +88,9 @@ exception InvocationTargetException: com::sun::star::lang::WrappedTargetExceptio /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/MethodMode.idl b/udkapi/com/sun/star/reflection/MethodMode.idl index 568e3d503c52..f4161c3ddd1c 100644 --- a/udkapi/com/sun/star/reflection/MethodMode.idl +++ b/udkapi/com/sun/star/reflection/MethodMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: MethodMode.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:46 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,27 +68,19 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::reflection::MethodMode -/** These values are used to specify the calling mode of a method. - */ +/** MethodMode denotes the mode in which method calls are run, i.e. either oneway or + twoway. Mode oneway denotes that a call may be run asynchronously + (thus having no out parameters or return value) +*/ enum MethodMode { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR MethodMode:: ONEWAY, - - // DocMerge from xml: value com::sun::star::reflection::MethodMode::ONEWAY - /** The method call might be asynchronous + /** method may be run asynchronously */ ONEWAY, - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR MethodMode:: TWOWAY - - // DocMerge from xml: value com::sun::star::reflection::MethodMode::TWOWAY - /** The method call is synchron + /** method is run The */ TWOWAY - }; //============================================================================= @@ -98,6 +90,9 @@ enum MethodMode /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4 2000/11/08 12:28:46 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:31 hjs initial import diff --git a/udkapi/com/sun/star/reflection/ParamInfo.idl b/udkapi/com/sun/star/reflection/ParamInfo.idl index 32a35fc99a6f..a1255f8f144f 100644 --- a/udkapi/com/sun/star/reflection/ParamInfo.idl +++ b/udkapi/com/sun/star/reflection/ParamInfo.idl @@ -2,9 +2,9 @@ * * $RCSfile: ParamInfo.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,32 +73,21 @@ interface XIdlClass; //============================================================================= -// DocMerge from xml: struct com::sun::star::reflection::ParamInfo -/** describes a formal parameter of a method. - */ +/** Provides information about a formal parameter of a method. +*/ struct ParamInfo { - // DocMerge from xml: field com::sun::star::reflection::ParamInfo::aName - /** The name of the parameter. - */ + /** name of the parameter + */ string aName; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ParamInfo::aMode - - // DocMerge from xml: field com::sun::star::reflection::ParamInfo::aMode - /** One of the values IN, OUT, INOUT from the ParamMode enumeration. - */ + /** parameter mode: in, out, inout + */ ParamMode aMode; - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ParamInfo::aType - - // DocMerge from xml: field com::sun::star::reflection::ParamInfo::aType - /** The type of the parameter. - */ + /** formal type of the parameter + */ XIdlClass aType; - }; //============================================================================= @@ -108,6 +97,9 @@ struct ParamInfo /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/ParamMode.idl b/udkapi/com/sun/star/reflection/ParamMode.idl index 54891321c1e1..2a9ab97770ca 100644 --- a/udkapi/com/sun/star/reflection/ParamMode.idl +++ b/udkapi/com/sun/star/reflection/ParamMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: ParamMode.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -68,37 +68,21 @@ //============================================================================= -// DocMerge from xml: enum com::sun::star::reflection::ParamMode -/** These values are used to specify if a formal parameter of a method is - used for input, output, or both. - */ +/** The parameter mode denotes the transfer between caller and callee + of a method. +*/ enum ParamMode { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ParamMode:: IN, - - // DocMerge from xml: value com::sun::star::reflection::ParamMode::IN - /** It is an in parameter. Data can only transfered from the - callee to the caller. - */ + /** parameter serves as pure input for a called method + */ IN, - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ParamMode:: OUT, - - // DocMerge from xml: value com::sun::star::reflection::ParamMode::OUT - /** It is an out parameter. Data can only transfered from the - caller to the callee. - */ + /** parameter serves as pure output for the callee (in addition to the return value) + */ OUT, - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR ParamMode:: INOUT - - // DocMerge from xml: value com::sun::star::reflection::ParamMode::INOUT - /** It is an in out parameter. Data can transfered in both - directions. - */ + /** parameter serves as input as well as output; data can transferred in both directions + */ INOUT }; @@ -110,6 +94,9 @@ enum ParamMode /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/ProxyFactory.idl b/udkapi/com/sun/star/reflection/ProxyFactory.idl index fa77299b6d58..14dc279a60fa 100644 --- a/udkapi/com/sun/star/reflection/ProxyFactory.idl +++ b/udkapi/com/sun/star/reflection/ProxyFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: ProxyFactory.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,15 +72,21 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::reflection::ProxyFactory -/** Specifies a factory object to create proxy objects.<br> - These proxy object represent a given target object and can be - be aggregated. The proxy objects are UNO conforming and do NOT provide - original target interfaces on queryInterface() calls. - */ +/** Service to create proxy objects acting on behalf of a given + target object.<br> + A proxy delegates calls to a given target object. + In addition, it is aggregatable, thus it is possible to + intercept calls on the proxy's interfaces. + + @attention + A proxy object is UNO conform, but does NOT provide original target + interfaces on queryInterface() calls. This may lead to problems + regarding object identity, e.g. when dealing with listener proxies. +*/ service ProxyFactory { - // DocMerge: empty anyway + /** Factory interface to produce proxies + */ interface com::sun::star::reflection::XProxyFactory; }; @@ -91,6 +97,9 @@ service ProxyFactory /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.1 2000/11/14 08:29:06 jsc moved from com.sun.star.util diff --git a/udkapi/com/sun/star/reflection/TypeDescriptionManager.idl b/udkapi/com/sun/star/reflection/TypeDescriptionManager.idl index 1cd56fccbec3..2bdc42174c98 100644 --- a/udkapi/com/sun/star/reflection/TypeDescriptionManager.idl +++ b/udkapi/com/sun/star/reflection/TypeDescriptionManager.idl @@ -2,9 +2,9 @@ * * $RCSfile: TypeDescriptionManager.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -73,6 +73,10 @@ #include <com/sun/star/lang/XInitialization.idl> #endif +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + //============================================================================= @@ -80,18 +84,38 @@ //============================================================================= -/** This service is the central manager supporting the - <type scope="com::sun::star::container">XHierarchicalNameAccessy</type> - interface. - At runtime there will only be at most a single instance of the service. - A manager instance is hooked into the C UNO runtime typelib and lives - until the service manager is shut down.<br> - You can manually add a provider by inserting it via the XSet interface. +/** This service manages type descriptions and acts as a central access point + to every type description. It delegates calls for demanded types to + subsequent + <type scope="com::sun::star::reflection>TypeDescriptionProvider</type>s + and may cache read type descriptions.<br> + At runtime there will be a singleton accessable via the initial + component context's key + "/singletons/com.sun.star.reflection.theTypeDescriptionManager". + This object is hooked into the C UNO runtime typelib and lives + until the component context is shut down.<br> + At startup the object enumerates every + <type scope="com::sun::star::reflection>TypeDescriptionProvider</type> + and creates instances of every available one. + You can later on manually add or remove a provider via the + <type scope="com::sun::star::container>XSet</type> interface. + + @see com::sun::star::reflection::XTypeDescription */ service TypeDescriptionManager { + /** Interface to retrieve type descriptions. + */ interface com::sun::star::container::XHierarchicalNameAccess; + /** Interface to modify the set of + <type scope="com::sun::star::container>TypeDescriptionProvider</type>s. + */ interface com::sun::star::container::XSet; + /** Interface to signal shutdown to the manager.<br> + This signals all providers to shut down, because usually each provider + references its manager. + */ + [optional] interface com::sun::star::lang::XComponent; }; //============================================================================= @@ -101,6 +125,9 @@ service TypeDescriptionManager /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.6 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.5 2000/12/04 13:40:22 dbo XInit removed, because providers are initialized at first use from ServiceManager; modifications can be done using XSet. diff --git a/udkapi/com/sun/star/reflection/TypeDescriptionProvider.idl b/udkapi/com/sun/star/reflection/TypeDescriptionProvider.idl index 71d72642b9e7..165282805cc8 100644 --- a/udkapi/com/sun/star/reflection/TypeDescriptionProvider.idl +++ b/udkapi/com/sun/star/reflection/TypeDescriptionProvider.idl @@ -2,9 +2,9 @@ * * $RCSfile: TypeDescriptionProvider.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,19 +76,26 @@ //============================================================================= -// DocMerge from xml: service com::sun::star::reflection::TypeDescriptionProvider -/** A provider service supports the XHierarchicalNameAccess interface to read type descriptions - and constants from a specific source, e.g., a typelib registry file. - <br> - */ +/** This service provides type descriptions, i.e. concrete + service implementations read from source like the persistent registry + database format.<br> + All registered implementations of this service will be inserted to the + initial component context's singleton object + "/singletons/com.sun.star.reflection.theTypeDescriptionManager".<br> + + @see com::sun::star::reflection::TypeDescriptionManager +*/ service TypeDescriptionProvider { - // DocMerge: empty anyway + /** Interface to retrieve type descriptions. + */ interface com::sun::star::container::XHierarchicalNameAccess; - - // DocMerge: empty anyway + /** Interface to signal shutdown to the provider.<br> + This has to be done maunally, because usually each provider references + its manager (which implements type caching) for late resolution of + partial types (e.g. parameter types). + */ interface com::sun::star::lang::XComponent; - }; //============================================================================= @@ -98,6 +105,9 @@ service TypeDescriptionProvider /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XArrayTypeDescription.idl b/udkapi/com/sun/star/reflection/XArrayTypeDescription.idl index f0f4dec9b2b3..faecbda4c4a9 100644 --- a/udkapi/com/sun/star/reflection/XArrayTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XArrayTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArrayTypeDescription.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: jsc $ $Date: 2001-03-30 13:51:23 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,29 +72,34 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XArrayTypeDescription -/** The type description of an array. +/** Deprecated. Arrays are not supported. + Reflects a fixed-size array type. The type class of this description is TypeClass_ARRAY. - */ + + @deprecated +*/ interface XArrayTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns the element type of the array. - // DocMerge from idl: method com::sun::star::reflection::XServiceTypeDescription::getReferencedType - /** @return the typedefed type, if the type is a typedef, - or the base type, if the type is a array or sequence. - */ + @return + element type of the array + */ com::sun::star::reflection::XTypeDescription getType(); - // DocMerge from idl: method com::sun::star::reflection::XServiceTypeDescription::getNumberOfDimensions - /** @return the number of dimensions. - */ - long getNumberOfDimensions(); + /** Returns the number of dimensions of the array. + + @return + dimension of the array + */ + long getNumberOfDimensions(); - // DocMerge from idl: method com::sun::star::reflection::XServiceTypeDescription::getDimensions - /** @return a sequence with the array dimensions. - */ - sequence< long > getDimensions(); + /** Returns dimensions of array (same length as getNumberOfDimensions()). + + @return + dimensions of array + */ + sequence< long > getDimensions(); }; //============================================================================= @@ -104,6 +109,9 @@ interface XArrayTypeDescription: com::sun::star::reflection::XTypeDescription /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.1 2001/03/30 13:51:23 jsc + new + =============================================================================*/ #endif diff --git a/udkapi/com/sun/star/reflection/XCompoundTypeDescription.idl b/udkapi/com/sun/star/reflection/XCompoundTypeDescription.idl index 93564fc72cc7..20d2bc2f2e39 100644 --- a/udkapi/com/sun/star/reflection/XCompoundTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XCompoundTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCompoundTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,30 +72,30 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XCompoundTypeDescription -/** the type description of a struct or exception. - */ +/** Reflects a compound type, i.e. a struct or exception. +*/ interface XCompoundTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns the type of the base type of the compound type. + If the compound does not have a base type, the method returns a null interface. - // DocMerge from xml: method com::sun::star::reflection::XCompoundTypeDescription::getBaseType - /** returns the type of the base type from the compound. If the compound does not have a base type, the method returns a NULL. - */ + @return + base interface or null + */ com::sun::star::reflection::XTypeDescription getBaseType(); - //------------------------------------------------------------------------- + /** Returns the member types of the struct/exception in IDL declaration order. - // DocMerge from idl: method com::sun::star::reflection::XCompoundTypeDescription::getMemberTypes - /** @return the members of the struct or exception. - */ + @return + members of struct/exception + */ sequence<com::sun::star::reflection::XTypeDescription> getMemberTypes(); - //------------------------------------------------------------------------- + /** Returns the member names of the struct/exception in IDL declaration order. - // DocMerge from idl: method com::sun::star::reflection::XCompoundTypeDescription::getMemberNames - /** @return the member names of the struct or exception. - */ + @return + members names of struct/exception + */ sequence<string> getMemberNames(); }; @@ -106,6 +106,9 @@ interface XCompoundTypeDescription: com::sun::star::reflection::XTypeDescription /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XEnumTypeDescription.idl b/udkapi/com/sun/star/reflection/XEnumTypeDescription.idl index 08599993cae2..27970b8f88d6 100644 --- a/udkapi/com/sun/star/reflection/XEnumTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XEnumTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XEnumTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,32 +72,30 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XEnumTypeDescription -/** the type description of an enum. - */ +/** Reflects an enum type. +*/ interface XEnumTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns the default enum value. - // DocMerge from xml: method com::sun::star::reflection::XEnumTypeDescription::getDefaultEnumValue - /** returns the value of the the first enum. - */ + @return + default enum value + */ long getDefaultEnumValue(); - //------------------------------------------------------------------------- + /** Returns the enum member values. - // DocMerge from idl: method com::sun::star::reflection::XEnumTypeDescription::getEnumNames - /** @return the names of the enum values. - */ + @return + enum member values + */ sequence<string> getEnumNames(); - //------------------------------------------------------------------------- + /** Returns the enum member names. - // DocMerge from idl: method com::sun::star::reflection::XEnumTypeDescription::getEnumValues - /** @return the values of the enum (corresponding to names in similar order). - */ + @return + enum member names + */ sequence<long> getEnumValues(); - }; //============================================================================= @@ -107,6 +105,9 @@ interface XEnumTypeDescription: com::sun::star::reflection::XTypeDescription /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XIdlArray.idl b/udkapi/com/sun/star/reflection/XIdlArray.idl index 265368e29141..620eba5ceac1 100644 --- a/udkapi/com/sun/star/reflection/XIdlArray.idl +++ b/udkapi/com/sun/star/reflection/XIdlArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlArray.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,73 +79,83 @@ module com { module sun { module star { module reflection { //============================================================================= -// DOCUMENTATION CHANGED FOR XIdlArray -// DocMerge from xml: interface com::sun::star::reflection::XIdlArray -/** provides methods to dynamically access arrays. +/** Reflects an IDL sequence and provides dynamic access to instances of + that sequence. + This interface supports widening conversion when getting or setting elements. - <p>Array permits widening conversions to occur during a get or set - operation, but throws an IllegalArgumentException if a narrowing - conversion would occur. - - </p>@see IdlClass - */ + @attention + Although the name of this interface denotes arrays, + sequences are meant. Don't be obfuscated, arrays are not supported by UNO! +*/ interface XIdlArray: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlArray::realloc - - // DocMerge from xml: method com::sun::star::reflection::XIdlArray::realloc - /** Change the size of the array to the new size. - If the new length is greater, the additional - elements are default constructed, otherwise - the elements are destructed. - */ - void realloc( [inout] any array, - [in] long length ) - raises( com::sun::star::lang::IllegalArgumentException ); + /** Rellocates the length of the sequence instance. - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlArray::getLen - /** @returns - the number of elements in the array. + @param array + sequence instance + @length + new length of sequence */ + void realloc( + [inout] any array, + [in] long length ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** Returns the length of the given sequence. + + @param array + sequence instance + @return + length of sequence + */ long getLen( [in] any array ) - raises( com::sun::star::lang::IllegalArgumentException ); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlArray::get - /** @returns - the value of the indexed component in the specified array object. - - @throws IllegalArgumentException - if the specified object is not an array or if the - specified object is <NULL/>. - - @throws ArrayIndexOutOfBoundsException - if the specified index argument is negative, - or if it is greater than or equal to the - length of the specified array. - */ - any get( [in] any aArray, - [in] long nIndex ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::lang::ArrayIndexOutOfBoundsException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XIdlArray::set - /** sets the value of the indexed component of the specified array object - to the specified new value. - */ - void set( [inout] any aArray, - [in] long nIndex, - [in] any aNewValue ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::lang::ArrayIndexOutOfBoundsException ); - + raises( com::sun::star::lang::IllegalArgumentException ); + + /** Returns element at given index. + + @param aArray + sequence instance + @param nIndex + index + @return + value + + @throws IllegalArgumentException + if the specified object is not a sequence or if the specified object is null + + @throws ArrayIndexOutOfBoundsException + if the specified index argument is negative, or if it is greater than or equal to the + length of the specified sequence. + */ + any get( + [in] any aArray, + [in] long nIndex ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::ArrayIndexOutOfBoundsException ); + + /** Sets a new value at given index. + + @param aArray + sequence instance + @param nIndex + index + @param aNewValue + new value to be set + + @throws IllegalArgumentException + if the specified object is not a sequence or if the specified object is null + + @throws ArrayIndexOutOfBoundsException + if the specified index argument is negative, or if it is greater than or equal to the + length of the specified sequence. + */ + void set( + [inout] any aArray, + [in] long nIndex, + [in] any aNewValue ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::ArrayIndexOutOfBoundsException ); }; //============================================================================= @@ -155,6 +165,9 @@ interface XIdlArray: 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/XIdlField.idl b/udkapi/com/sun/star/reflection/XIdlField.idl index 72c2133f4421..6cb7e883f0e9 100644 --- a/udkapi/com/sun/star/reflection/XIdlField.idl +++ b/udkapi/com/sun/star/reflection/XIdlField.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlField.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,112 +88,23 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlField -/** makes it possible to access the specification of a field dynamically. - <p> - XIdlField contains a specification error in the <method>XIdlField::set</method> method. - The first parameter the object itself must be specified as an [inout] parameter. - <type scope="com::sun::star::reflection">XIdlField2</type> correct this specification error. - </p> - <p> - The new <type scope="com::sun::star::reflection">XIdlField2</type> interface must be - implemented in all places where XIdlField is implemented. For a correct - working <method>com:.sun::star:.reflection::XIdlField2::set</method> method in all use - cases a queryInterface to <type scope="com::sun::star::reflection">XIdlField2</type> is - necessary. - </p> - */ +/** Deprecated. Use <type scope="com::sun::star::reflection">XIdlField2</type> + instead. + + @deprecated +*/ interface XIdlField: com::sun::star::reflection::XIdlMember { - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlField::getType - /** @returns - an <type>XIdlClass</type> object that identifies the declared - type for the field represented by this <type>XIdlField</type>. - */ com::sun::star::reflection::XIdlClass getType(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlField::getAccessMode - /** @returns - an enumeration value which denotes whether the field is - "const", "readonly", "writeonly", or "readwrite". - */ com::sun::star::reflection::FieldAccessMode getAccessMode(); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlField::get - /** @returns - the value of the field represented by this field on the specified object. - - <p>The underlying field's value is obtained as follows: - - <ul> - <li>If the underlying field is a constant, the - object argument is ignored; it may be NULL. - - <li>Otherwise, the underlying field is an instance - field. If the specified object argument is - NULL, the method throws an - "IllegalArgumentException". If the specified - object is not an instance of the class, - interface, struct, union, or enum declaring - the underlying field, the method throws an - "IllegalArgumentException". - - <li>Otherwise, the value is retrieved from the - underlying instance or constant. - </ul> - - @throws IllegalArgumentException - if the specified object is <NULL/> and if the - specified object is not an instance of the class or - interface declaring the underlying field. - */ - any get( [in] any obj ) - raises( com::sun::star::lang::IllegalArgumentException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XIdlField::set - /** sets the field represented by this <type>XIdlField</type> on the - specified object argument to the specified new value. - - <p>The operation proceeds as follows: - - </p> - <ul> - <li>If the specified object argument is NULL, the method - throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. If - the specified object argument is not an instance of - the class or interface declaring the underlying field, - then the method throws an - <type scope="com::sun::star::lang">IllegalArgumentException</type>. - - </li> - <li>If the underlying field is constant, the method throws an - <type scope="com::sun::star::lang">IllegalAccessException</type>. - - <p>If the new value cannot be converted to the type - of underlying field by an identity or widening - conversion, the method throws an - <type scope="com::sun::star::lang">IllegalArgumentException</type>. - </p> - </li> - </ul> - - <p>The field is set to the possibly widened new value. - - </p> - */ - void set( [in] any obj, - [in] any value ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::lang::IllegalAccessException ); - + any get( + [in] any obj ) + raises( com::sun::star::lang::IllegalArgumentException ); + void set( + [in] any obj, + [in] any value ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::IllegalAccessException ); }; //============================================================================= @@ -203,6 +114,9 @@ interface XIdlField: com::sun::star::reflection::XIdlMember /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.7 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.6 2001/05/03 13:59:05 jsc change docu, reference to XIdlField2 because of specification error in set method diff --git a/udkapi/com/sun/star/reflection/XIdlField2.idl b/udkapi/com/sun/star/reflection/XIdlField2.idl index 953077c273cf..7cf0fcd5f586 100644 --- a/udkapi/com/sun/star/reflection/XIdlField2.idl +++ b/udkapi/com/sun/star/reflection/XIdlField2.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlField2.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -88,111 +88,63 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlField2 -/** has the same functionallity as <type scope="com::sun::star::reflection">XIdlField</type>. - <p> - XIdlField2 correct a specification error of the - <method>com::sun::star::reflection::XIdlField::set</method> method. - The first parameter the object itself must be specified as an [inout] parameter. - </p> - <p> - This new interface must be implemented in all places where - <type scope="com::sun::star::reflection">XIdlField</type> is implemented. For a correct - working <method>XIdlField2::set</method> method in all use cases a queryInterface to - XIdlField2 is necessary. - </p> - */ +/** Reflects an IDL interface attribute, enum or compound type + (i.e. struct/exception) member. +*/ interface XIdlField2: com::sun::star::reflection::XIdlMember { - //------------------------------------------------------------------------- + /** Returns the type of the field. - // DocMerge from idl: method com::sun::star::reflection::XIdlField2::getType - /** @returns - an <type>XIdlClass</type> object that identifies the declared - type for the field represented by this <type>XIdlField</type>. - */ + @return + type of the field + */ com::sun::star::reflection::XIdlClass getType(); - //------------------------------------------------------------------------- + /** Returns the access mode of the field, i.e. read-write, read-only or + write-only (access mode "const" is deprecated). - // DocMerge from idl: method com::sun::star::reflection::XIdlField2::getAccessMode - /** @returns - an enumeration value which denotes whether the field is - "const", "readonly", "writeonly", or "readwrite". - */ + @return + access mode of the field + */ com::sun::star::reflection::FieldAccessMode getAccessMode(); - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlField2::get - /** @returns - the value of the field represented by this field on the specified object. - - <p>The underlying field's value is obtained as follows: - - <ul> - <li>If the underlying field is a constant, the - object argument is ignored; it may be NULL. - - <li>Otherwise, the underlying field is an instance - field. If the specified object argument is - NULL, the method throws an - "IllegalArgumentException". If the specified - object is not an instance of the class, - interface, struct, union, or enum declaring - the underlying field, the method throws an - "IllegalArgumentException". - - <li>Otherwise, the value is retrieved from the - underlying instance or constant. - </ul> - - @throws IllegalArgumentException - if the specified object is <NULL/> and if the - specified object is not an instance of the class or - interface declaring the underlying field. - */ - any get( [in] any obj ) - raises( com::sun::star::lang::IllegalArgumentException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XIdlField2::set - /** sets the field represented by this <type>XIdlField2</type> on the - specified object argument to the specified new value. - - <p>The operation proceeds as follows: - - </p> - <ul> - <li>If the specified object argument is NULL, the method - throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. If - the specified object argument is not an instance of - the class or interface declaring the underlying field, - then the method throws an - <type scope="com::sun::star::lang">IllegalArgumentException</type>. - - </li> - <li>If the underlying field is constant, the method throws an - <type scope="com::sun::star::lang">IllegalAccessException</type>. - - <p>If the new value cannot be converted to the type - of underlying field by an identity or widening - conversion, the method throws an - <type scope="com::sun::star::lang">IllegalArgumentException</type>. - </p> - </li> - </ul> - - <p>The field is set to the possibly widened new value. - - </p> - */ - void set( [inout] any obj, - [in] any value ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::lang::IllegalAccessException ); - + /** Gets the value of the reflected field from the given object, + i.e. an interface, enum or compound type (struct/exception). + For enums, the given object is ignored; the returned value + reflects the constant enum 32-bit value. + + @param obj + object instance having member of reflected type + @return + value of field + + @throws IllegalAccessException + An <type scope="com::sun::star::lang>IllegalAccessException</type> + is thrown if the given object is no interface, enum or compound type; + or the given object does not have the reflected field. + */ + any get( + [in] any obj ) + raises( com::sun::star::lang::IllegalArgumentException ); + + /** Sets the value of the reflected field of the given object, + i.e. an interface or compound type (struct/exception). + + @param obj + object instance having member of reflected type + @param value + value to be set + + @throws IllegalAccessException + An <type scope="com::sun::star::lang>IllegalAccessException</type> + is thrown if the given object is no interface or compound type; + or the given object does not have the reflected field. + */ + void set( + [inout] any obj, + [in] any value ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::IllegalAccessException ); }; //============================================================================= @@ -202,6 +154,9 @@ interface XIdlField2: com::sun::star::reflection::XIdlMember /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.2 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.1 2001/05/03 13:58:08 jsc new diff --git a/udkapi/com/sun/star/reflection/XIdlMember.idl b/udkapi/com/sun/star/reflection/XIdlMember.idl index dc76e1155874..0db2229db67b 100644 --- a/udkapi/com/sun/star/reflection/XIdlMember.idl +++ b/udkapi/com/sun/star/reflection/XIdlMember.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlMember.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,33 +72,23 @@ interface XIdlClass; -//============================================================================= - -// DocMerge from xml: interface com::sun::star::reflection::XIdlMember -/** makes it possible to access members of classes dynamically. - */ +/** Base interface for <type>XidlField2</type>s and <type>XIdlMethod</type>s. +*/ interface XIdlMember: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::reflection::XIdlMember::getDeclaringClass - /** @returns - the <type>XIdlClass</type> object representing the class, - interface, struct, union, or enum that declares the member - represented by this member. - */ + /** Returns the declaring type of this field, i.e. the type having + the member declared (interface, enum, struct, exception). + + @returns + declaring type + */ XIdlClass getDeclaringClass(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlMember::getName + /** Returns the fully-qualified name of the member. - // DocMerge from xml: method com::sun::star::reflection::XIdlMember::getName - /** Returns the fully-qualified name of the type (class, interface, - array, sequence, struct, union, enum, or primitive) represented by this - XIdlClass object, as a String. - */ + @return fully-qualified name of the member + */ string getName(); - }; //============================================================================= @@ -108,6 +98,9 @@ interface XIdlMember: 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/XIdlMethod.idl b/udkapi/com/sun/star/reflection/XIdlMethod.idl index a45468b20fc4..dcc24a15b8d1 100644 --- a/udkapi/com/sun/star/reflection/XIdlMethod.idl +++ b/udkapi/com/sun/star/reflection/XIdlMethod.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIdlMethod.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -90,117 +90,79 @@ interface XIdlClass; //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIdlMethod -/** makes it possible to access the specification of a method dynamically. - */ +/** Reflects an IDL interface method. +*/ interface XIdlMethod: com::sun::star::reflection::XIdlMember { - //------------------------------------------------------------------------- + /** Returns the return type of the reflected method. - // DocMerge from idl: method com::sun::star::reflection::XIdlMethod::getReturnType - /** @returns - an <type>XIdlClass</type> object that represents the formal - return type of the method represented by this method object. - */ + @return + return type of reflected method + */ XIdlClass getReturnType(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlMethod::getParameterTypes + /** Returns the formal parameter types of the reflected method in order of IDL + declaration. - // DocMerge from idl: method com::sun::star::reflection::XIdlMethod::getParameterTypes - /** Returns a sequence of XIdlClass objects that represent the formal - parameter types, in declaration order, of the method - represented by this Method object. Returns a sequence of length - 0 if the underlying method takes no parameters. - */ + @return + formal parameter types of reflected method + */ sequence<XIdlClass> getParameterTypes(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlMethod::getParameterInfos + /** Returns formal parameter informations of the reflected method + in order of IDL declaration. + Parameter information reflects the parameter's access mode (in, out, inout), + the parameter's name and formal type. - // DocMerge from idl: method com::sun::star::reflection::XIdlMethod::getParameterInfos - /** Returns a sequence of ParamInfo objects that represent all informations - about the formal parameter types, in declaration order, of the method - represented by this Method object. Returns a sequence of length - 0 if the underlying method takes no parameters. - */ + @return + parameter informations of reflected method + */ sequence<ParamInfo> getParameterInfos(); - //------------------------------------------------------------------------- - // DOCUMENTATION CHANGED FOR XIdlMethod::getExceptionTypes + /** Returns the declared exceptions types of the reflected method. - // DocMerge from idl: method com::sun::star::reflection::XIdlMethod::getExceptionTypes - /** Returns a sequence of XIdlClass objects that represent the types of - the checked exceptions thrown by the underlying method - represented by this Method object. Returns a sequence of length - 0 if the method throws no checked exceptions. - */ + @return + declared exception types of reflected method + */ sequence<com::sun::star::reflection::XIdlClass> getExceptionTypes(); - //------------------------------------------------------------------------- + /** Returns the method mode in which calls are run, i.e. either oneway or + twoway. Method mode oneway denotes that a call may be run asynchronously + (thus having no out parameters or return value) - // DocMerge from idl: method com::sun::star::reflection::XIdlMethod::getMode - /** @returns - an enumeration value which denotes whether the method is one-way or two-way. - */ + @return + method mode of reflected method + */ com::sun::star::reflection::MethodMode getMode(); - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XIdlMethod::invoke - /** Invokes the underlying method represented by this method object on - the specified object with the specified parameters. Individual - parameters are subject to widening conversions as necessary. - - <p>Method invocation proceeds in the following order of steps: - - </p> - <p>If the specified object argument is NULL, the invocation - throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. Otherwise, - if the specified object argument is not an instance of the - class or interface declaring the underlying method, the - invocation throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. - - </p> - <p>If the number of actual parameters supplied via <var>args</var> is - different from the number of formal parameters required by - the underlying method, the invocation throws an - <type scope="com::sun::star::lang">IllegalArgumentException</type>. - - </p> - <p>For each actual parameter in the supplied <var>args</var> array: - - <dl> - <dd>If the parameter value cannot be converted to the - corresponding formal parameter type by an - identity or widening conversion, the - invocation throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. - </dd> - </dl> - - </p> - <p>When the control transfers to the underlying method and - the method stops abruptly by throwing an exception, the exception - is placed in an <type>InvocationTargetException</type> and thrown - in turn to the caller of -<!-- jrh: Is something missing here? --> - . - - </p> - <p>If the method completes normally, the value it returns - is returned to the caller of -<!-- jrh: Is something missing here? --> - . - If the underlying method return type is void, the invocation - returns <void/>. - - </p> - */ - any invoke( [in] any obj, - [inout] sequence<any> args ) - raises( com::sun::star::lang::IllegalArgumentException, - com::sun::star::reflection::InvocationTargetException ); - + /** Invokes the reflected method on a given object with the given parameters. + The parameters may be widening converted to fit their exact IDL type, + meaning no loss of information. + + @param obj + object to call on + @param args + arguments passed to the method + @return + return value of the method call (may be empty for methods returning void) + + @throws IllegalArgumentException + if the given object is a nuull reference or does not support the reflected + method's interface + @throws IllegalArgumentException + if the given number of arguments differ from the expected number + or the given arguments' types differ from the expected ones (even a + widening conversion was not possible) + @throws InvocationTargetException + if the reflected method that has been invoked has thrown an exception. + The original exception will be wrapped up and signalled by the + InvocationTargetException + */ + any invoke( + [in] any obj, + [inout] sequence<any> args ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::reflection::InvocationTargetException ); }; //============================================================================= @@ -210,6 +172,9 @@ interface XIdlMethod: com::sun::star::reflection::XIdlMember /*============================================================================= $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/XIndirectTypeDescription.idl b/udkapi/com/sun/star/reflection/XIndirectTypeDescription.idl index ef96b5280cf6..2d52e688bebd 100644 --- a/udkapi/com/sun/star/reflection/XIndirectTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XIndirectTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XIndirectTypeDescription.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,21 +72,19 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XIndirectTypeDescription -/** The type description of a typedef, array, or sequence. +/** Reflects a typedef or sequence type. The type class of this description is TypeClass_TYPEDEF or - TypeClass_SEQUENCE or TypeClass_ARRAY. - */ + TypeClass_SEQUENCE. +*/ interface XIndirectTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns the typedefed type, if the type is a typedef, + or the element type, if the type is a sequence. - // DocMerge from idl: method com::sun::star::reflection::XIndirectTypeDescription::getReferencedType - /** @return the typedefed type, if the type is a typedef, - or the base type, if the type is a array or sequence. - */ + @return + referenced type + */ com::sun::star::reflection::XTypeDescription getReferencedType(); - }; //============================================================================= @@ -96,6 +94,9 @@ interface XIndirectTypeDescription: com::sun::star::reflection::XTypeDescription /*============================================================================= $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/XInterfaceAttributeTypeDescription.idl b/udkapi/com/sun/star/reflection/XInterfaceAttributeTypeDescription.idl index 595114dc9156..2e0d81499588 100644 --- a/udkapi/com/sun/star/reflection/XInterfaceAttributeTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XInterfaceAttributeTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterfaceAttributeTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,26 +76,24 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XInterfaceAttributeTypeDescription -/** The interface attribute type description. - The type class of this description is TypeClass_INTERFACE_ATTRIBUTE. - */ +/** Reflects an interface attribute type. + The type class of this type is TypeClass_INTERFACE_ATTRIBUTE. +*/ interface XInterfaceAttributeTypeDescription: com::sun::star::reflection::XInterfaceMemberTypeDescription { - //------------------------------------------------------------------------- + /** Returns true, if this attribute is read-only. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceAttributeTypeDescription::isReadOnly - /** @return if the attribute is read only or not. - */ + @return + true, if attribute is read-only + */ boolean isReadOnly(); - //------------------------------------------------------------------------- + /** Returns the type of the attribute. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceAttributeTypeDescription::getType - /** @return the type of the attribute. - */ + @return + type of attribute + */ com::sun::star::reflection::XTypeDescription getType(); - }; //============================================================================= @@ -105,6 +103,9 @@ interface XInterfaceAttributeTypeDescription: com::sun::star::reflection::XInter /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XInterfaceMemberTypeDescription.idl b/udkapi/com/sun/star/reflection/XInterfaceMemberTypeDescription.idl index f5ef58f41f97..e728e0c42bd1 100644 --- a/udkapi/com/sun/star/reflection/XInterfaceMemberTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XInterfaceMemberTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterfaceMemberTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,28 +72,27 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XInterfaceMemberTypeDescription -/** The type description of a member (method or attribute) of an interface. - The type class of this description is TypeClass_INTERFACE_METHOD or - TypeClass_INTERFACE_ATTRIBUTE. - */ +/** Base interface for reflected interface members. + + @see XInterfaceAttributeTypeDescription + @see XInterfaceMethodTypeDescription +*/ interface XInterfaceMemberTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns name of member - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMemberTypeDescription::getMemberName - /** @return the name of the member - */ + @return + member name + */ string getMemberName(); - //------------------------------------------------------------------------- + /** Returns the position the member including all inherited members of base + interfaces. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMemberTypeDescription::getPosition - /** @return the position of this method in the interface definition - plus the count of members in the base interface. - */ + @return + position of member + */ long getPosition(); - }; //============================================================================= @@ -103,6 +102,9 @@ interface XInterfaceMemberTypeDescription: com::sun::star::reflection::XTypeDesc /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XInterfaceMethodTypeDescription.idl b/udkapi/com/sun/star/reflection/XInterfaceMethodTypeDescription.idl index b620f9c96a2b..c2649fdf72b8 100644 --- a/udkapi/com/sun/star/reflection/XInterfaceMethodTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XInterfaceMethodTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterfaceMethodTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,40 +80,38 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XInterfaceMethodTypeDescription -/** The interface method type description. - The type class of this description is TypeClass_INTERFACE_METHOD. - */ +/** Reflects an interface method type. + The type class of this type is TypeClass_INTERFACE_METHOD. +*/ interface XInterfaceMethodTypeDescription: com::sun::star::reflection::XInterfaceMemberTypeDescription { - //------------------------------------------------------------------------- + /** Returns the method's return type. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMethodTypeDescription::getReturnType - /** @return the type of the return value. - */ + @return + method's return type + */ com::sun::star::reflection::XTypeDescription getReturnType(); - //------------------------------------------------------------------------- + /** Returns true, if this method is declared oneway. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMethodTypeDescription::isOneway - /** @return true if the function is oneway, otherwise false. - */ + @return + true, if this method is declared oneway + */ boolean isOneway(); - //------------------------------------------------------------------------- + /** Returns all parameters of the method in order of IDL declaration. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMethodTypeDescription::getParameters - /** @return the array of parameters. - */ + @return + method parameters + */ sequence<com::sun::star::reflection::XMethodParameter> getParameters(); - //------------------------------------------------------------------------- + /** Returns declared exceptions that may occur upon invocations of the method. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceMethodTypeDescription::getExceptions - /** @return the array of exceptions. - */ + @return + declared exceptions of method + */ sequence<com::sun::star::reflection::XTypeDescription> getExceptions(); - }; //============================================================================= @@ -123,6 +121,9 @@ interface XInterfaceMethodTypeDescription: com::sun::star::reflection::XInterfac /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XInterfaceTypeDescription.idl b/udkapi/com/sun/star/reflection/XInterfaceTypeDescription.idl index 8633ab927cb1..a4099c36ed91 100644 --- a/udkapi/com/sun/star/reflection/XInterfaceTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XInterfaceTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XInterfaceTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,34 +80,36 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XInterfaceTypeDescription -/** The type description of an interface. - The type class of this description is TypeClass_INTERFACE_INTERFACE. - */ +/** Reflects an interface type. + + @see XInterfaceMemberTypeDescription +*/ interface XInterfaceTypeDescription: com::sun::star::reflection::XTypeDescription { - //------------------------------------------------------------------------- + /** Returns the base interface or null, if the reflected interface is not + inherited from another. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceTypeDescription::getBaseType - /** @return the base interface, if the interface has one, - null if no base interface exist. - */ + @return + base interface or null + */ com::sun::star::reflection::XTypeDescription getBaseType(); - //------------------------------------------------------------------------- + /** Deprecated. UIK are not used anymore, a type is uniquely identified by + its name.<br> + Returns the UIK, i.e. the unique identifier of the interface. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceTypeDescription::getUik - /** @return the UIK of the interface. - */ + @return + uik of the interface + @deprecated + */ com::sun::star::uno::Uik getUik(); - //------------------------------------------------------------------------- + /** Returns the members of the interfaces, i.e. attributes and methods. - // DocMerge from idl: method com::sun::star::reflection::XInterfaceTypeDescription::getMembers - /** @return the array of members. - */ + @returns + interface members + */ sequence<com::sun::star::reflection::XInterfaceMemberTypeDescription> getMembers(); - }; //============================================================================= @@ -117,6 +119,9 @@ interface XInterfaceTypeDescription: com::sun::star::reflection::XTypeDescriptio /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XMethodParameter.idl b/udkapi/com/sun/star/reflection/XMethodParameter.idl index 70463ab1e7bb..f3c7b5cf8521 100644 --- a/udkapi/com/sun/star/reflection/XMethodParameter.idl +++ b/udkapi/com/sun/star/reflection/XMethodParameter.idl @@ -2,9 +2,9 @@ * * $RCSfile: XMethodParameter.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-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,49 +76,46 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XMethodParameter -/** The description of an interface method parameter.<br> - One of the methods isIn() or isOut() must return true. - */ +/** Reflects a method parameter. + + @see XInterfaceMethodTypeDescription +*/ interface XMethodParameter: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + /** Returns the name of the parameter - // DocMerge from idl: method com::sun::star::reflection::XMethodParameter::getName - /** @return the name of the parameter. - */ + @return + name of parameter + */ string getName(); - //------------------------------------------------------------------------- + /** Returns the type of the parameter. - // DocMerge from idl: method com::sun::star::reflection::XMethodParameter::getType - /** @return the type of the parameter. - */ + @return + type of parameter + */ com::sun::star::reflection::XTypeDescription getType(); - //------------------------------------------------------------------------- + /** Returns true, if the parameter is declared as [in] or [inout] in IDL. - // DocMerge from idl: method com::sun::star::reflection::XMethodParameter::isIn - /** @return true, if the call type of this parameter IN or INOUT if in - parameter, false, if the call type is OUT. - */ + @return + true, if declared [in] or [inout] parameter + */ boolean isIn(); - //------------------------------------------------------------------------- + /** Returns true, if the parameter is declared as [out] or [inout] in IDL. - // DocMerge from idl: method com::sun::star::reflection::XMethodParameter::isOut - /** @return true, if the call type of this parameter OUT or INOUT, - false, if the call type is IN. - */ + @return + true, if declared [out] or [inout] parameter + */ boolean isOut(); - //------------------------------------------------------------------------- + /** Returns the position of the parameter regarding the IDL method declaration. - // DocMerge from idl: method com::sun::star::reflection::XMethodParameter::getPosition - /** @return the position of this parameter in the method definition. - */ + @return + position of the parameter + */ long getPosition(); - }; //============================================================================= @@ -128,6 +125,9 @@ interface XMethodParameter: 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/XProxyFactory.idl b/udkapi/com/sun/star/reflection/XProxyFactory.idl index 3edd07fd3242..44f0e8fa189c 100644 --- a/udkapi/com/sun/star/reflection/XProxyFactory.idl +++ b/udkapi/com/sun/star/reflection/XProxyFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XProxyFactory.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2001-11-16 15:02:57 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,24 +74,28 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XProxyFactory -/** You can create proxy interfaces via this interface. - */ +/** Factory interface to produce proxy objects. +*/ interface XProxyFactory: com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::reflection::XProxyFactory::createProxy - /** Creates a new object that represents the given target object and can - be aggregated. The proxy object acts UNO conforming and does NOT provide - original target interfaces on queryInterface() calls.<br> - Be careful, e.g., when registering as a listener at the proxy, - you will get event notification from the original object, meaning - a different object! - */ + /** This method creates a new proxy object that acts on behalf of the given + target object.<br> + The proxy delegates calls to the given target object. + In addition, it is aggregatable, thus it is possible to + intercept calls on the proxy's interfaces. + + @attention + The proxy object is UNO conform, but does NOT provide original target + interfaces on queryInterface() calls. This may lead to problems + regarding object identity, e.g. when dealing with listener proxies. + + @param xTarget + target object + @return + proxy object + */ com::sun::star::uno::XAggregation createProxy( [in] com::sun::star::uno::XInterface xTarget ); - }; //============================================================================= @@ -101,6 +105,9 @@ interface XProxyFactory: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3 2001/11/16 15:02:57 mi + proofing by Richard Holt + Revision 1.2 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/XTypeDescription.idl b/udkapi/com/sun/star/reflection/XTypeDescription.idl index 9b739fa1626a..56efbdfc646b 100644 --- a/udkapi/com/sun/star/reflection/XTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,25 +76,31 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XTypeDescription -/** The generic idl type description. - */ -interface XTypeDescription: com::sun::star::uno::XInterface +/** Reflects an IDL type. + + @see XCompoundTypeDescription + @see XUnionTypeDescription + @see XArrayTypeDescription + @see XIndirectTypeDescription + @see XEnumTypeDescription + @see XInterfaceTypeDescription + @see XInterfaceMemberTypeDescription +*/ +interface XTypeDescription : com::sun::star::uno::XInterface { - //------------------------------------------------------------------------- + /** Returns the type class of the reflected type. - // DocMerge from idl: method com::sun::star::reflection::XTypeDescription::getTypeClass - /** @return the typeclass of the type. - */ + @return + typeclass of type + */ com::sun::star::uno::TypeClass getTypeClass(); - //------------------------------------------------------------------------- + /** Returns the fully qualified name of the type. - // DocMerge from idl: method com::sun::star::reflection::XTypeDescription::getName - /** @return the full qualified type name of the type. - */ + @return + fully qualified type name of the type + */ string getName(); - }; //============================================================================= @@ -104,6 +110,9 @@ interface XTypeDescription: com::sun::star::uno::XInterface /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api diff --git a/udkapi/com/sun/star/reflection/XUnionTypeDescription.idl b/udkapi/com/sun/star/reflection/XUnionTypeDescription.idl index 440a0deaaa54..e774c7adc7f4 100644 --- a/udkapi/com/sun/star/reflection/XUnionTypeDescription.idl +++ b/udkapi/com/sun/star/reflection/XUnionTypeDescription.idl @@ -2,9 +2,9 @@ * * $RCSfile: XUnionTypeDescription.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:38 $ + * last change: $Author: dbo $ $Date: 2002-03-08 17:19:13 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,45 +72,55 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::reflection::XUnionTypeDescription -/** The type description of a union. - */ +/** Deprecated. Unions are not supported. + Reflects a union type. + The discriminant of a union switches between the current value types. + In addition, there is also a default case, having no discriminant. + + @deprecated +*/ interface XUnionTypeDescription: com::sun::star::reflection::XTypeDescription { + /** Returns the (ordinal) discriminant type. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getDiscriminantType - /** * @return The type of the discriminant (ordinal type). - */ + @return + type of the discriminant + */ com::sun::star::reflection::XTypeDescription getDiscriminantType(); + /** Returns the default discriminant value. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getDefaultDiscriminant - /** * @return Union default descriminant (ordinal). - */ + @return + default discriminant value + */ any getDefaultDiscriminant(); + /** Returns the type of the default value. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getDefaultMemberType - /** * @return Union default member type (might be 0). - */ + @return + type of the default value + */ com::sun::star::reflection::XTypeDescription getDefaultMemberType(); + /** Returns discriminants of all members in order of IDL declaration. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getDiscriminants - /** * @return Union member discriminant values (same order as idl declaration). - */ + @return + discriminants of all members + */ sequence< any > getDiscriminants(); + /** Returns types of all members in order of IDL declaration. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getMemberTypes - /** * @return Union value member types (same order as idl declaration). - */ + @return + types of all members + */ sequence< com::sun::star::reflection::XTypeDescription > getMemberTypes(); + /** Returns names of all members in order of IDL declaration. - // DocMerge from idl: method com::sun::star::reflection::XUnionTypeDescription::getMemberNames - /** * @return Union value member names (same order as idl declaration). - */ + @return + names of all members + */ sequence< string > getMemberNames(); }; @@ -121,6 +131,9 @@ interface XUnionTypeDescription: com::sun::star::reflection::XTypeDescription /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.5 2001/03/16 15:10:38 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/11/08 12:28:46 mi moved from api |