udkapi/com/sun/star/script/Converter.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_script_Converter_idl__
  20 #define __com_sun_star_script_Converter_idl__
  21
  22 #include <com/sun/star/script/XTypeConverter.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module script {
  27
  28
  29 /** This service provides a widening converter converting from one type to another,
  30     if possible.
  31
  32     <p>What is possible?
  33     <ul>
  34     <li>byte: byte, (short *1), (long *1), (hyper *1), (float *1), (double *1), (enum *2), (any *3), boolean, (char *4), (string *5)</li>
  35     <li>short: byte, short, (long *1), (hyper *1), (float *7), (double *7), (enum *2), (any *3), boolean, char, (string *5)</li>
  36     <li>long: byte, short, long, (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li>
  37     <li>hyper: byte, short, long, hyper, (float *7), (double *7), enum, (any *3), boolean, char, (string *5)</li>
  38     <li>float: byte, short, long, hyper, float, (double *7), (enum *8), (any *3), boolean, char, (string *5)</li>
  39     <li>double: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, (string *5)</li>
  40     <li>enum: (byte *9), (short *9), (long *9), (hyper *9), (float *9), (double *9), (enum *10), (any *3), (string *11)</li>
  41     <li>void: ok for all types</li>
  42     <li>any: ok for all types</li>
  43     <li>boolean: byte, short, long, hyper, float, double, (any *3), boolean, char, (string *12). 0 => false, != 0 => true</li>
  44     <li>char: byte, short, (long *1), (hyper *1), (float *7), (double *7), enum, (any *3), boolean, char, (string *13)</li>
  45     <li>string: byte, short, long, hyper, float, double, enum, (any *3), boolean, char, string</li>
  46     <li>struct: (any *3), (struct *14)</li>
  47     <li>interface: (any *3), (struct *14)</li>
  48     <li>exception: (any *3), (exception *14)</li>
  49     <li>union: (any *3), (union *14)</li>
  50     <li>sequence: (any *3), (sequence *15)</li>
  51     </ul>
  52     rules:
  53     <ul>
  54     <li>1: only converts if the value is in the range of the target type.</li>
  55     <li>2: only converts if the value, not the position, of the enum is in the range of the target type.</li>
  56     <li>3: get value until it is not an any. Then convert it with the other rules.</li>
  57     <li>4: only converts if the value of the character is between 0 - 255.</li>
  58     <li>5: only converts if the value represents a decimal, hexadecimal (0x...) or a floating point number.
  59     Examples: 10, 0x10, 10.045, 10,555, +10, +10.6e10, -10.6e-10, .16.</li>
  60     <li>7: only converts if the value is in the range of the target type.
  61     The value is rounded to an integer.</li>
  62     <li>8: only converts if the float can be converted back to the same enum value.</li>
  63     <li>9: only converts if the number is one of the enumeration type values. Normally you need
  64     reflection information of the enum type.</li>
  65     <li>10: only converts if it is the same enumeration type.</li>
  66     <li>11: only converts if the string contains the name of an enumeration type value. Normally you need
  67     core reflection information of the enum type.</li>
  68     <li>12: only converts if the value of the string is "1", "true" or "0", "false". The comparison
  69     is case insensitive.</li>
  70     <li>13: only converts if the length of the string is 1 or 0.</li>
  71     <li>14: only converts if the types are equal or the source type is derived from the destination
  72     type.</li>
  73     <li>15: only converts if each element of the source sequence can be converted to an element
  74     of the destination sequence.</li>
  75     </ul>
  76 */
  77 published service Converter: XTypeConverter;
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */