Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Uix.InputMethodManager.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Uix.InputMethodManager</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Interop">\r
8             <summary>\r
9             Partial interop class.\r
10             </summary>\r
11             <summary>\r
12             Partial interop class.\r
13             </summary>\r
14         </member>\r
15         <member name="T:Interop.InputMethodManager">\r
16             <summary>\r
17             InputMethodManager interop class.\r
18             </summary>\r
19         </member>\r
20         <!-- "F:Interop.InputMethodManager.ErrorCode.InvalidParameter" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
21         <!-- "F:Interop.InputMethodManager.ErrorCode.PermissionDenied" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
22         <!-- "F:Interop.InputMethodManager.ErrorCode.OperationFailed" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
23         <member name="T:Interop.Libraries">\r
24             <summary>\r
25             Partial libraries class.\r
26             </summary>\r
27         </member>\r
28         <member name="T:Tizen.Uix.InputMethodManager.Manager">\r
29             <summary>\r
30             This class provides the function for launching the input method editor (IME) list and selector settings. A user can manage the installed IMEs in the system.\r
31             The input method editor (IME) is an input panel that lets users provide an input and the platform to receive the text data entered.\r
32             The manager is a module for managing the installed IMEs.\r
33             IME developers can use this module to open the installed IME list or the selector menu after their IME installation, and then guide to select the installed IME.\r
34             </summary>\r
35         </member>\r
36         <member name="M:Tizen.Uix.InputMethodManager.Manager.ShowIMEList">\r
37             <summary>\r
38             Requests to open the installed IME list menu.\r
39             This API provides the installed IME list menu for IME developers who might want to open it to enable their IME.\r
40             </summary>\r
41             <privilege>\r
42             http://tizen.org/privilege/imemanager\r
43             </privilege>\r
44             <exception cref="!:InvalidOperationException">\r
45             This exception can occur if:\r
46             1) The application does not have the privilege to call this function.\r
47             2) Operation failed.\r
48             </exception>\r
49         </member>\r
50         <member name="M:Tizen.Uix.InputMethodManager.Manager.ShowIMESelector">\r
51             <summary>\r
52             Requests to open the IME selector menu.\r
53             This API provides the IME selector menu for the IME or other application developers who might want to change the default IME.\r
54             </summary>\r
55             <privilege>\r
56             http://tizen.org/privilege/imemanager\r
57             </privilege>\r
58             <exception cref="!:InvalidOperationException">\r
59             This exception can occur if:\r
60             1) The application does not have the privilege to call this function.\r
61             2) Operation failed.\r
62             </exception>\r
63         </member>\r
64         <member name="M:Tizen.Uix.InputMethodManager.Manager.IsIMEEnabled(System.String)">\r
65             <summary>\r
66             Checks if the specific IME is enabled or disabled in the system keyboard setting.\r
67             The IME developers can use this property to check if their IME is enabled or not.\r
68             </summary>\r
69             <privilege>\r
70             http://tizen.org/privilege/imemanager\r
71             </privilege>\r
72             <param name="appId">The application ID of the IME.</param>\r
73             <returns>The On (enabled) and Off (disabled) state of the IME.</returns>\r
74             <exception cref="!:ArgumentException">\r
75             This exception can occur if an invalid parameter is provided.\r
76             </exception>\r
77             <exception cref="!:InvalidOperationException">\r
78             This exception can occur if:\r
79             1) The application does not have the privilege to call this function.\r
80             2) Operation failed.\r
81             </exception>\r
82         </member>\r
83         <member name="M:Tizen.Uix.InputMethodManager.Manager.GetActiveIME">\r
84             <summary>\r
85             Checks which IME is the current activated (selected) IME.\r
86             </summary>\r
87             <privilege>\r
88             http://tizen.org/privilege/imemanager\r
89             </privilege>\r
90             <returns>\r
91             The current activated (selected) IME.\r
92             </returns>\r
93             <exception cref="!:InvalidOperationException">\r
94             This exception can occur if:\r
95             1) The application does not have the privilege to call this function.\r
96             2) Operation failed.\r
97             </exception>\r
98         </member>\r
99         <member name="M:Tizen.Uix.InputMethodManager.Manager.GetEnabledIMECount">\r
100             <summary>\r
101             Gets the number of IMEs that are enabled (usable).\r
102             </summary>\r
103             <privilege>\r
104             http://tizen.org/privilege/imemanager\r
105             </privilege>\r
106             <returns>\r
107             The number of enabled IMEs.\r
108             </returns>\r
109             <exception cref="!:InvalidOperationException">\r
110             This exception can occur if:\r
111             1) The application does not have the privilege to call this function.\r
112             2) Operation failed.\r
113             </exception>\r
114         </member>\r
115     </members>\r
116 </doc>\r