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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_i18n_XTextConversion_idl__
#define __com_sun_star_i18n_XTextConversion_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/i18n/TextConversionResult.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/NoSupportException.idl>
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 portion in aText for the conversion
@param Locale
Locale the conversion is referring to.
@param nTextConversionType
One of TextConversionType values.
@param nTextConversionOptions
Combination of TextConversionOption values.
@returns
TextConversionResult
@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 Locale,
[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 portion in aText for the conversion
@param Locale
Locale the conversion is referring to.
@param nTextConversionType
One of TextConversionType values.
@param nTextConversionOptions
Combination of TextConversionOption 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 Locale,
[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 Locale
Locale the conversion is referring to.
@param nTextConversionType
One of TextConversionType values.
@param nTextConversionOptions
Combination of TextConversionOption 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 Locale,
[in] short nTextConversionType,
[in] long nTextConversionOptions )
raises( com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::NoSupportException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
