1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: Converter.idl,v $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_script_Converter_idl__
31 #define __com_sun_star_script_Converter_idl__
33 #ifndef __com_sun_star_script_XTypeConverter_idl__
34 #include
<com
/sun
/star
/script
/XTypeConverter.idl
>
38 //=============================================================================
40 module com
{ module sun
{ module star
{ module script
{
42 //=============================================================================
44 /** This service provides a widening converter converting from one type to another,
49 <li>byte: byte, (short *1), (long *1), (hyper *1), (float *1), (double *1), (enum *2), (any *3), boolean, (char *4), (string *5)</li>
50 <li>short: byte, short, (long *1), (hyper *1), (float *7), (double *7), (enum *2), (any *3), boolean, char, (string *5)</li>
51 <li>long: byte, short, long, (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li>
52 <li>hyper: byte, short, long, hyper, (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li>
53 <li>float: byte, short, long, hyper, float, (double *7), (enum *8), (any *3), boolean, char, (string *5)</li>
54 <li>double: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, (string *5)</li>
55 <li>enum: (byte *9), (short *9), (long *9), (hyper *9), (float *9), (double *9), (enum *10), (any *3), (string *11)</li>
56 <li>void: ok for all types</li>
57 <li>any: ok for all types</li>
58 <li>boolean: byte, short, long, hyper, float, double, (any *3), boolean, char, (string *12). 0 => false, != 0 => true</li>
59 <li>char: byte, short, (long *1), (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *13)</li>
60 <li>string: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, string</li>
61 <li>struct: (any *3), (struct *14)</li>
62 <li>interface: (any *3), (struct *14)</li>
63 <li>exception: (any *3), (exception *14)</li>
64 <li>union: (any *3), (union *14)</li>
65 <li>sequence: (any *3), (sequence *15)</li>
69 <li>1: only converts if the value is in the range of the target type.</li>
70 <li>2: only converts if the value, not the position, of the enum is in the range of the target type.</li>
71 <li>3: get value until it is not an any. Then convert it with the other rules.</li>
72 <li>4: only converts if the value of the character is between 0 - 255.</li>
73 <li>5: only converts if the value represents a decimal, hexadecimal (0x...) or a floating point number.
74 Examples: 10, 0x10, 10.045, 10,555, +10, +10.6e10, -10.6e-10, .16.</li>
75 <li>7: only converts if the value is in the range of the target type.
76 The value is rounded to an integer.</li>
77 <li>8: only converts if the float can be converted back to the same enum value.</li>
78 <li>9: only converts if the number is one of the enumeration type values. Normally you need
79 reflection information of the enum type.</li>
80 <li>10: only converts if it is the same enumeration type.</li>
81 <li>11: only converts if the string contains the name of an enumeration type value. Normally you need
82 core reflection information of the enum type.</li>
83 <li>12: only converts if the value of the string is "1", "true" or "0", "false". The comparision
84 is case insensitive.</li>
85 <li>13: only converts if the length of the string is 1 or 0.</li>
86 <li>14: only converts if the types are equal or the source type is derived from the destination
88 <li>15: only converts if each element of the source sequence can be converted to an element
89 of the destination sequence.</li>
92 published service Converter
94 /** Conversion interface.
96 interface com
::sun
::star
::script
::XTypeConverter
;
100 //=============================================================================
104 /*=============================================================================
106 =============================================================================*/