The Input Method Manager API provides the functions for launching input method editor (IME) list and selector settings. A user can manage the installed IMEs in the system.
Required Header
#include <inputmethod_manager.h>
Overview
Input method editor (IME) is an input panel that lets users provide input and the platform receive the text data entered. Input method 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; then guide to select the installed IME.
Enumeration Type Documentation
Enumeration for input method manager function error.
- Since :
- 2.4
- Enumerator:
IME_MANAGER_ERROR_NONE |
Successful
|
IME_MANAGER_ERROR_INVALID_PARAMETER |
Invalid parameter
|
IME_MANAGER_ERROR_PERMISSION_DENIED |
Permission denied
|
IME_MANAGER_ERROR_OPERATION_FAILED |
Operation failed
|
Function Documentation
Checks which IME is the current activated (selected) IME.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Parameters:
-
[out] | app_id | The application ID of the active IME |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- ime_manager_show_ime_selector()
Gets the number of IMEs which are enabled (usable).
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Returns:
- The number of enabled IMEs on success, otherwise
0
- Exceptions:
-
IME_MANAGER_ERROR_NONE | Successful |
IME_MANAGER_ERROR_PERMISSION_DENIED | The application does not have the privilege to call this function |
IME_MANAGER_ERROR_OPERATION_FAILED | Operation failed |
- See also:
- ime_manager_is_ime_enabled()
-
ime_manager_show_ime_selector()
Checks if the specific IME is enabled or disabled in the system keyboard setting.
The IME developers can use this function to check their IME is enabled or not.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Parameters:
-
[in] | app_id | The application ID of the IME |
[out] | enabled | The On (enabled) and Off (disabled) state of the IME |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- ime_manager_show_ime_list()
Requests to pre-launch the IME.
The developers can use this function to launch IME in On-demand mode.
- Since :
- 5.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Requests to open the installed IME list menu.
This function provides the installed IME list menu for the IME developers who might want to open it to enable their IME.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- ime_manager_show_ime_selector()
Requests to open the IME selector menu.
This function provides the IME selector menu for the IME or other application developers who might want to change the default IME.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/imemanager
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- ime_manager_show_ime_list()