summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script
diff options
context:
space:
mode:
authorDaniel Boelzle <dbo@openoffice.org>2002-01-23 07:52:21 +0000
committerDaniel Boelzle <dbo@openoffice.org>2002-01-23 07:52:21 +0000
commit7e130dd78fdfffc06fe9260d6961607430715ecb (patch)
treeffb01faaf04bfb9d424435c58bc4c750916938ee /udkapi/com/sun/star/script
parent52981ef07bb83d9a801bee8fd4e747f931e45bed (diff)
#96711# IDL documentation review
Diffstat (limited to 'udkapi/com/sun/star/script')
-rw-r--r--udkapi/com/sun/star/script/CannotConvertException.idl33
-rw-r--r--udkapi/com/sun/star/script/Converter.idl119
-rw-r--r--udkapi/com/sun/star/script/FailReason.idl79
-rw-r--r--udkapi/com/sun/star/script/InvocationAdapterFactory.idl28
-rw-r--r--udkapi/com/sun/star/script/XInvocationAdapterFactory.idl39
-rw-r--r--udkapi/com/sun/star/script/XInvocationAdapterFactory2.idl49
-rw-r--r--udkapi/com/sun/star/script/XTypeConverter.idl72
7 files changed, 200 insertions, 219 deletions
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 -&amp;gt; false, != 0 -&amp;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