1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XTextConversion.idl,v $
* $Revision: 1.7 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_i18n_XTextConversion_idl__
#define __com_sun_star_i18n_XTextConversion_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_i18n_TextConversionResult_idl__
#include <com/sun/star/i18n/TextConversionResult.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_NoSupportException_idl__
#include <com/sun/star/lang/NoSupportException.idl>
#endif
//=============================================================================
module com { module sun { module star { module i18n {
//=============================================================================
/** Method to convert text from one type to another
@since OOo 1.1.2
*/
published interface XTextConversion : ::com::sun::star::uno::XInterface
{
//---------------------------------------------------------------------
/** Method to search dictionaries for the conversion candidates.
@param aText
Text string to be converted.
@param nStartPos
The start position in aText for the conversion
@param nLength
The length of the partion in aText for the conversion
@param aLocal
Locale the conversion is referring to.
@param nTextConversionType
One of <type>TextConversionType</type> values.
@param nTextConversionOptions
Combination of <type>TextConversionOption</type> values.
@returns
<type>TextConversionResult</type>
@throws NoSupportException
when <var>nConversionDictionaryType</var> is not known by the implementation,
or when the locale is not supported.
*/
TextConversionResult getConversions(
[in] string aText,
[in] long nStartPos,
[in] long nLength,
[in] ::com::sun::star::lang::Locale aLocale,
[in] short nTextConversionType,
[in] long nTextConversionOptions )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::NoSupportException );
//---------------------------------------------------------------------
/** Method to search dictionaries for the conversion candidate, if there
are multiple candidates, it will return first one. This is for the
conversion in non-interactive mode.
@param aText
Text string to be converted.
@param nStartPos
The start position in aText for the conversion
@param nLength
The length of the partion in aText for the conversion
@param aLocal
Locale the conversion is referring to.
@param nTextConversionType
One of <type>TextConversionType</type> values.
@param nTextConversionOptions
Combination of <type>TextConversionOption</type> values.
@returns
Converted text
@throws NoSupportException
when <var>nConversionDictionaryType</var> is not known by the implementation,
or when the locale is not supported.
*/
string getConversion(
[in] string aText,
[in] long nStartPos,
[in] long nLength,
[in] ::com::sun::star::lang::Locale aLocale,
[in] short nTextConversionType,
[in] long nTextConversionOptions )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::NoSupportException );
//---------------------------------------------------------------------
/** Method to query if the conversion type should be interactive or
non-interactive mode.
@param aLocal
Locale the conversion is referring to.
@param nTextConversionType
One of <type>TextConversionType</type> values.
@param nTextConversionOptions
Combination of <type>TextConversionOption</type> values.
@returns
<TRUE/> if the entry is a valid entry for the dictionary
<FALSE/> otherwise.
@throws NoSupportException
when <var>nConversionDictionaryType</var> is not known by the implementation,
or when the locale is not supported.
*/
boolean interactiveConversion(
[in] ::com::sun::star::lang::Locale aLocale,
[in] short nTextConversionType,
[in] long nTextConversionOptions )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::NoSupportException );
};
//=============================================================================
}; }; }; };
#endif
|
