*
* @section CAPI_UIX_INPUTMETHOD_MODULE_PRIVILEGE Required Privileges
* 1. To use the Input Method API, the application has to request permission by adding the following privilege to the `tizen-manifest.xml` file:
-
- ```
- <privileges>
- <privilege>http://tizen.org/privilege/ime</privilege>
- </privileges>
- ```
+ *
+ * @code
+ * <privileges>
+ * <privilege>http://tizen.org/privilege/ime</privilege>
+ * </privileges>
+ * @endcode
*
* @section CAPI_UIX_INPUTMETHOD_MODULE_OVERVIEW Overview
* Input method editor (IME) is an input panel that lets users provide input and the platform receive the text data entered.<br>
*
* @section CAPI_UIX_INPUTMETHOD_MODULE_LIFECYCLE IME Application Life cycle
* The IME application runs as follows:
-
- 1. Once the IME application is started, the `create()` callback function is called.
- 2. When a text input UI control gets the focus, the `show()` callback function is called.<br>
- The IME application can call Input Method APIs to interact with the UI control.<br>
- The event callback functions are called when the UI control state changes.<br>
- When the text input UI control loses the focus, the `hide()` callback function is called.
- 3. When the IME application is finished, the `terminate()` callback function is called.
+ *
+ * 1. Once the IME application is started, the @b create() callback function is called.
+ * 2. When a text input UI control gets the focus, the @b show() callback function is called.<br>
+ * The IME application can call Input Method APIs to interact with the UI control.<br>
+ * The event callback functions are called when the UI control state changes.<br>
+ * When the text input UI control loses the focus, the @b hide() callback function is called.
+ * 3. When the IME application is finished, the @b terminate() callback function is called.
*
* @section CAPI_UIX_INPUTMETHOD_MODULE_EVENT_CALLBACK Managing the main loop and event callback functions
- The IME application must implement the `ime_app_main()` function. It is the main entry point, in which you can and call the `ime_run()` function to start the main loop.
-
- During its life-cycle, the IME application can receive a number of events from the Tizen Input Service framework through the callback functions.<br>
- You must register the mandatory `create()`, `terminate()`, `show()`, and `hide()` callbacks.<br>
- Other callbacks can be registered as required by the specific IME application.
+ * The IME application must implement the @b ime_app_main() function. It is the main entry point, in which you can and call the @b ime_run() function to start the main loop.
+ *
+ * During its life-cycle, the IME application can receive a number of events from the Tizen Input Service framework through the callback functions.<br>
+ * You must register the mandatory @b create(), @b terminate(), @b show(), and @b hide() callbacks.<br>
+ * Other callbacks can be registered as required by the specific IME application.
*
* @section CAPI_UIX_INPUTMETHOD_MODULE_SHOW_AND_HIDE Showing and hiding the keyboard
-
- When an associated text input UI control has the focus, the active keyboard is requested to be shown. When the text input UI control loses the focus, the keyboard is requested to be hidden.
-
- The `show()` and `hide()` callback functions are used to manage the keyboard visibility, and the IME application must register both of them when starting the IME main loop.
-
- The client application can set various configurations for each text input UI control, such as the cursor position, key layout type, return key type, and flags of predictive text.<br>
- The configurations are delivered to the IME application though the `show()` callback function, to allow the keyboard to show the correct look to the user.
+ *
+ * When an associated text input UI control has the focus, the active keyboard is requested to be shown. When the text input UI control loses the focus, the keyboard is requested to be hidden.
+ *
+ * The @b show() and @b hide() callback functions are used to manage the keyboard visibility, and the IME application must register both of them when starting the IME main loop.
+ *
+ * The client application can set various configurations for each text input UI control, such as the cursor position, key layout type, return key type, and flags of predictive text.<br>
+ * The configurations are delivered to the IME application though the @b show() callback function, to allow the keyboard to show the correct look to the user.
*/
#endif /* __TIZEN_UIX_INPUTMETHOD_DOC_H__ */