1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_i18n_XTextConversion_idl__
25cdf0e10cSrcweir#define __com_sun_star_i18n_XTextConversion_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_lang_Locale_idl__
32cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_i18n_TextConversionResult_idl__
36cdf0e10cSrcweir#include <com/sun/star/i18n/TextConversionResult.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
40cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
41cdf0e10cSrcweir#endif
42cdf0e10cSrcweir
43cdf0e10cSrcweir#ifndef __com_sun_star_lang_NoSupportException_idl__
44cdf0e10cSrcweir#include <com/sun/star/lang/NoSupportException.idl>
45cdf0e10cSrcweir#endif
46cdf0e10cSrcweir
47cdf0e10cSrcweir
48cdf0e10cSrcweir//=============================================================================
49cdf0e10cSrcweir
50cdf0e10cSrcweirmodule com {  module sun {  module star {  module i18n {
51cdf0e10cSrcweir
52cdf0e10cSrcweir//=============================================================================
53cdf0e10cSrcweir
54cdf0e10cSrcweir/** Method to convert text from one type to another
55cdf0e10cSrcweir
56cdf0e10cSrcweir	 @since OOo 1.1.2
57cdf0e10cSrcweir*/
58cdf0e10cSrcweirpublished interface XTextConversion : ::com::sun::star::uno::XInterface
59cdf0e10cSrcweir{
60cdf0e10cSrcweir	//---------------------------------------------------------------------
61cdf0e10cSrcweir	/** Method to search dictionaries for the conversion candidates.
62cdf0e10cSrcweir
63cdf0e10cSrcweir		@param aText
64cdf0e10cSrcweir			Text string to be converted.
65cdf0e10cSrcweir		@param nStartPos
66cdf0e10cSrcweir			The start position in aText for the conversion
67cdf0e10cSrcweir		@param nLength
68cdf0e10cSrcweir			The length of the partion in aText for the conversion
69cdf0e10cSrcweir		@param aLocal
70cdf0e10cSrcweir			Locale the conversion is referring to.
71cdf0e10cSrcweir		@param nTextConversionType
72cdf0e10cSrcweir			One of <type>TextConversionType</type> values.
73cdf0e10cSrcweir		@param nTextConversionOptions
74cdf0e10cSrcweir			Combination of <type>TextConversionOption</type> values.
75cdf0e10cSrcweir        @returns
76cdf0e10cSrcweir            <type>TextConversionResult</type>
77cdf0e10cSrcweir
78cdf0e10cSrcweir        @throws NoSupportException
79cdf0e10cSrcweir            when <var>nConversionDictionaryType</var> is not known by the implementation,
80cdf0e10cSrcweir            or when the locale is not supported.
81cdf0e10cSrcweir	*/
82cdf0e10cSrcweir	TextConversionResult getConversions(
83cdf0e10cSrcweir            [in] string aText,
84cdf0e10cSrcweir            [in] long nStartPos,
85cdf0e10cSrcweir            [in] long nLength,
86cdf0e10cSrcweir            [in] ::com::sun::star::lang::Locale aLocale,
87cdf0e10cSrcweir            [in] short nTextConversionType,
88cdf0e10cSrcweir            [in] long nTextConversionOptions )
89cdf0e10cSrcweir        raises( com::sun::star::lang::IllegalArgumentException,
90cdf0e10cSrcweir                com::sun::star::lang::NoSupportException );
91cdf0e10cSrcweir
92cdf0e10cSrcweir	//---------------------------------------------------------------------
93cdf0e10cSrcweir	/** Method to search dictionaries for the conversion candidate, if there
94cdf0e10cSrcweir        are multiple candidates, it will return first one. This is for the
95cdf0e10cSrcweir        conversion in non-interactive mode.
96cdf0e10cSrcweir
97cdf0e10cSrcweir		@param aText
98cdf0e10cSrcweir			Text string to be converted.
99cdf0e10cSrcweir		@param nStartPos
100cdf0e10cSrcweir			The start position in aText for the conversion
101cdf0e10cSrcweir		@param nLength
102cdf0e10cSrcweir			The length of the partion in aText for the conversion
103cdf0e10cSrcweir		@param aLocal
104cdf0e10cSrcweir			Locale the conversion is referring to.
105cdf0e10cSrcweir		@param nTextConversionType
106cdf0e10cSrcweir			One of <type>TextConversionType</type> values.
107cdf0e10cSrcweir		@param nTextConversionOptions
108cdf0e10cSrcweir			Combination of <type>TextConversionOption</type> values.
109cdf0e10cSrcweir        @returns
110cdf0e10cSrcweir            Converted text
111cdf0e10cSrcweir
112cdf0e10cSrcweir        @throws NoSupportException
113cdf0e10cSrcweir            when <var>nConversionDictionaryType</var> is not known by the implementation,
114cdf0e10cSrcweir            or when the locale is not supported.
115cdf0e10cSrcweir	*/
116cdf0e10cSrcweir	string getConversion(
117cdf0e10cSrcweir            [in] string aText,
118cdf0e10cSrcweir            [in] long nStartPos,
119cdf0e10cSrcweir            [in] long nLength,
120cdf0e10cSrcweir            [in] ::com::sun::star::lang::Locale aLocale,
121cdf0e10cSrcweir            [in] short nTextConversionType,
122cdf0e10cSrcweir            [in] long nTextConversionOptions )
123cdf0e10cSrcweir        raises( com::sun::star::lang::IllegalArgumentException,
124cdf0e10cSrcweir                com::sun::star::lang::NoSupportException );
125cdf0e10cSrcweir
126cdf0e10cSrcweir	//---------------------------------------------------------------------
127cdf0e10cSrcweir    /** Method to query if the conversion type should be interactive or
128cdf0e10cSrcweir        non-interactive mode.
129cdf0e10cSrcweir
130cdf0e10cSrcweir        @param aLocal
131cdf0e10cSrcweir            Locale the conversion is referring to.
132cdf0e10cSrcweir        @param nTextConversionType
133cdf0e10cSrcweir            One of <type>TextConversionType</type> values.
134cdf0e10cSrcweir        @param nTextConversionOptions
135cdf0e10cSrcweir            Combination of <type>TextConversionOption</type> values.
136cdf0e10cSrcweir        @returns
137cdf0e10cSrcweir            <TRUE/> if the entry is a valid entry for the dictionary
138cdf0e10cSrcweir            <FALSE/> otherwise.
139cdf0e10cSrcweir
140cdf0e10cSrcweir        @throws NoSupportException
141cdf0e10cSrcweir            when <var>nConversionDictionaryType</var> is not known by the implementation,
142cdf0e10cSrcweir            or when the locale is not supported.
143cdf0e10cSrcweir    */
144cdf0e10cSrcweir    boolean interactiveConversion(
145cdf0e10cSrcweir            [in] ::com::sun::star::lang::Locale aLocale,
146cdf0e10cSrcweir            [in] short nTextConversionType,
147cdf0e10cSrcweir            [in] long nTextConversionOptions )
148cdf0e10cSrcweir        raises( com::sun::star::lang::IllegalArgumentException,
149cdf0e10cSrcweir                com::sun::star::lang::NoSupportException );
150cdf0e10cSrcweir};
151cdf0e10cSrcweir
152cdf0e10cSrcweir
153cdf0e10cSrcweir//=============================================================================
154cdf0e10cSrcweir
155cdf0e10cSrcweir}; }; }; };
156cdf0e10cSrcweir
157cdf0e10cSrcweir#endif
158