1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_script_XTypeConverter_idl__
28#define __com_sun_star_script_XTypeConverter_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_reflection_XIdlClass_idl__
35#include <com/sun/star/reflection/XIdlClass.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42#ifndef __com_sun_star_script_CannotConvertException_idl__
43#include <com/sun/star/script/CannotConvertException.idl>
44#endif
45
46#ifndef __com_sun_star_uno_TypeClass_idl__
47#include <com/sun/star/uno/TypeClass.idl>
48#endif
49
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module script {
54
55//=============================================================================
56
57/** Interface to provide standard type conversions.
58
59    @see Converter
60*/
61published interface XTypeConverter: com::sun::star::uno::XInterface
62{
63	/** Converts the value <code>aFrom</code> to the specified type
64        <code>xDestinationType</code>.
65        Throws an <type>CannotConvertException</type> if the conversion
66        failed.
67        @param aFrom
68               source value
69        @param xDestinationType
70               destination type
71        @return
72                converted value (any carrying value of type <code>xDestinationType</code>
73    */
74	any convertTo(
75        [in] any aFrom,
76        [in] type xDestinationType )
77        raises( com::sun::star::lang::IllegalArgumentException,
78                com::sun::star::script::CannotConvertException );
79
80	/** Converts the value <code>aFrom</code> to the specified simple type
81        <code>aDestinationType</code>.
82        Throws an <type>CannotConvertException</type> if the conversion
83        failed and an <type scope="com::sun::star::lang">IllegalArgumentException</type>
84        if the destination
85        <type scope="com::sun::star::uno">TypeClass</type> is not simple,
86        e.g. not long or byte.
87
88        @param aFrom
89               source value
90        @param aDestinationType
91               destination type class
92        @return
93                converted value (any carrying value of type <code>aDestinationType</code>
94    */
95	any convertToSimpleType(
96        [in] any aFrom,
97        [in] com::sun::star::uno::TypeClass aDestinationType )
98        raises( com::sun::star::lang::IllegalArgumentException,
99                com::sun::star::script::CannotConvertException );
100};
101
102//=============================================================================
103
104}; }; }; };
105
106/*=============================================================================
107
108=============================================================================*/
109#endif
110