blob: 05b231c414a224e1d2a86027e6d2cd0e9694a3e2 (
plain)
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
|
/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using static Interop.InputMethodManager;
namespace Tizen.Uix.InputMethodManager
{
/// <summary>
/// This class provides the functions for launching input method editor (IME) list and selector settings. A user can manage the installed IMEs in the system.
/// Input method editor (IME) is an input panel that lets users provide input and the platform receives the text data entered.
/// Manager is a module for managing the installed IMEs.
/// IME developers can use this module to open the installed IME list or selector menu after their IME installation and then guide to select the installed IME.
/// </summary>
public static class Manager
{
/// <summary>
/// Requests to open the installed IME list menu.
/// This api provides the installed IME list menu for the IME developers who might want to open it to enable their IME.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/imemanager
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This Exception can occur if:
/// 1) The application does not have the privilege to call this function
/// 2) Operation failed
/// </exception>
public static void ShowIMEList()
{
ErrorCode error = ImeManagerShowImeList();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "ShowIMEList Failed with error " + error);
throw InputMethodManagerExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Requests to open the IME selector menu.
/// This api provides the IME selector menu for the IME or other application developers who might want to change the default IME.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/imemanager
/// </privilege>
/// <exception cref="InvalidOperationException">
/// This Exception can occur if:
/// 1) The application does not have the privilege to call this function
/// 2) Operation failed
/// </exception>
public static void ShowIMESelector()
{
ErrorCode error = ImeManagerShowImeSelector();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "ShowIMESelector Failed with error " + error);
throw InputMethodManagerExceptionFactory.CreateException(error);
}
}
/// <summary>
/// Checks if the specific IME is enabled or disabled in the system keyboard setting.
/// The IME developers can use this property to check if their IME is enabled or not.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/imemanager
/// </privilege>
/// <param name="appId">The application ID of the IME</param>
/// <returns>The On (enabled) and Off (disabled) state of the IME</returns>
/// <exception cref="ArgumentException">
/// This Exception can occur if Invalid parameter is provided
/// </exception>
/// <exception cref="InvalidOperationException">
/// This Exception can occur if:
/// 1) The application does not have the privilege to call this function
/// 2) Operation failed
/// </exception>
public static bool IsIMEEnabled(string appId)
{
bool isIMEEnabled;
ErrorCode error = ImeManagerIsImeEnabled(appId, out isIMEEnabled);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "IsIMEEnabled Failed with error " + error);
throw InputMethodManagerExceptionFactory.CreateException(error);
}
return isIMEEnabled;
}
/// <summary>
/// Checks which IME is the current activated (selected) IME.
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/imemanager
/// </privilege>
/// <returns>
/// Current activated (selected) IME
/// </returns>
/// <exception cref="InvalidOperationException">
/// This Exception can occur if:
/// 1) The application does not have the privilege to call this function
/// 2) Operation failed
/// </exception>
public static string GetActiveIME()
{
string activeIME;
ErrorCode error = ImeManagerGetActiveIme(out activeIME);
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetActiveIME Failed with error " + error);
throw InputMethodManagerExceptionFactory.CreateException(error);
}
return activeIME;
}
/// <summary>
/// Gets the number of IMEs which are enabled (usable).
/// </summary>
/// <privilege>
/// http://tizen.org/privilege/imemanager
/// </privilege>
/// <returns>
/// The number of enabled IMEs
/// </returns>
/// <exception cref="InvalidOperationException">
/// This Exception can occur if:
/// 1) The application does not have the privilege to call this function
/// 2) Operation failed
/// </exception>
public static int GetEnabledIMECount()
{
int activeIME = ImeManagerGetEnabledImeCount();
ErrorCode error = (ErrorCode)Tizen.Internals.Errors.ErrorFacts.GetLastResult();
if (error != ErrorCode.None)
{
Log.Error(LogTag, "GetEnabledIMECount Failed with error " + error);
throw InputMethodManagerExceptionFactory.CreateException(error);
}
return activeIME;
}
}
}
|
