*/
/**
- * @brief Enumeration for input method function error
- *
+ * @brief Enumeration for input method function error.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
typedef enum {
IME_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< out of memory */
} ime_error_e;
+
/**
- * @brief Enumeration of the option window type
- *
+ * @brief Enumeration for the option window type.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @see ime_option_window_created_cb()
*/
typedef enum {
- IME_OPTION_WINDOW_TYPE_KEYBOARD, /**< Open from Keyboard */
+ IME_OPTION_WINDOW_TYPE_KEYBOARD, /**< Open from Keyboard */
IME_OPTION_WINDOW_TYPE_SETTING_APPLICATION, /**< Open from Setting application */
} ime_option_window_type_e;
/**
- * @brief Enumeration of layout variation
- *
+ * @brief Enumeration for layout variation.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @see ime_context_get_layout_variation()
*/
typedef enum {
IME_LAYOUT_PASSWORD_VARIATION_NUMBERONLY, /**< The password layout to allow only number */
} ime_layout_variation_e;
+
/**
- * @brief Enumeration of string attribute type
- *
+ * @brief Enumeration for string attribute type.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @remarks Currently, a font style is available to use.
- *
* @see ime_preedit_attribute()
* @see ime_update_preedit_string()
*/
IME_ATTR_FONTSTYLE, /**< A font style attribute, e.g., underline, etc. */
} ime_attribute_type;
+
/**
- * @brief Value for #IME_ATTR_FONTSTYLE. Draw a line under the text.
+ * @brief Definition for value for #IME_ATTR_FONTSTYLE. Draw a line under the text.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_UNDERLINE 1
+
/**
- * @brief Value for #IME_ATTR_FONTSTYLE. Draw text in highlighted color.
+ * @brief Definition for value for #IME_ATTR_FONTSTYLE. Draw text in highlighted color.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_HIGHLIGHT 2
+
/**
- * @brief Value for #IME_ATTR_FONTSTYLE. Draw text in reversal color.
+ * @brief Definition for value for #IME_ATTR_FONTSTYLE. Draw text in reversal color.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
#define IME_ATTR_FONTSTYLE_REVERSAL 4
+
/**
* @brief The structure type to contain the attributes for preedit string.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @remarks A preedit string may have one or more different attributes. This structure describes each attribute of the string.
- *
* @see ime_update_preedit_string()
* @see ime_attribute_type
*/
unsigned int value; /**< The value of this attribute */
} ime_preedit_attribute;
+
/**
- * @brief Handle of an associated text input UI control's input context.
- *
+ * @brief An associated text input UI control's input context handle.
* @details This is one of parameters of ime_show_cb() callback function. IME application
- * should configure its input panel with this structure information.
- *
+ * should configure its input panel with this structure information.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @see ime_context_get_layout()
* @see ime_context_get_layout_variation()
* @see ime_context_get_cursor_position()
*/
typedef struct _ime_context *ime_context_h;
+
/**
- * @brief Handle of the device information of the key event.
- *
+ * @brief The key event device information handle.
* @details This is one of parameters of ime_process_key_event_cb() callback function. IME application
- * may distinguish the key event by using this if necessary.
- *
+ * may distinguish the key event by using this if necessary.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @see ime_process_key_event_cb()
* @see ime_device_info_get_name()
* @see ime_device_info_get_class()
*/
typedef struct _ime_device_info *ime_device_info_h;
+
/**
* @brief Called when the input panel is created.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks This callback function is mandatory and must be registered using ime_run(). The
- * ime_get_main_window() can be used to get the created input panel window.
- *
+ * @remarks This callback function is mandatory and must be registered using ime_run(). The ime_get_main_window() can be used to get the created input panel window.
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The ime_run() function calls this callback function.
- *
* @see ime_run()
* @see ime_set_size()
* @see ime_get_main_window()
*/
typedef void (*ime_create_cb)(void *user_data);
+
/**
* @brief Called when the input panel is terminated.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks This callback function is mandatory and must be registered using ime_run(). The
- * ime_get_main_window() can be used to get the created input panel window.
- *
+ * @remarks This callback function is mandatory and must be registered using ime_run(). The ime_get_main_window() can be used to get the created input panel window.
* @param[in] user_data User data to be passed from the callback registration function
- *
* @see ime_run()
* @see ime_get_main_window()
*/
typedef void (*ime_terminate_cb)(void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the input panel to show itself.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks This callback function is mandatory and must be registered using ime_run().
- * IME application should configure its input panel with #ime_context_h structure information.
- * The ime_get_main_window() can be used to get the created input panel window.
- *
+ * IME application should configure its input panel with #ime_context_h structure information.
+ * The ime_get_main_window() can be used to get the created input panel window.
* @param[in] context_id The input context identification value of an associated text input UI control
* @param[in] context The input context information handle
* @param[in] user_data User data to be passed from the callback registration function
- *
* @see ime_run()
* @see ime_get_main_window()
* @see ime_context_get_layout()
*/
typedef void (*ime_show_cb)(int context_id, ime_context_h context, void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the input panel to hide itself.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks This callback function is mandatory and must be registered using ime_run(). The
- * ime_get_main_window() can be used to get the created input panel window.
- *
+ * @remarks This callback function is mandatory and must be registered using ime_run(). The ime_get_main_window() can be used to get the created input panel window.
* @param[in] context_id The input context identification value of an associated text input UI control
* @param[in] user_data User data to be passed from the callback registration function
- *
* @see ime_run()
* @see ime_get_main_window()
*/
typedef void (*ime_hide_cb)(int context_id, void *user_data);
+
/**
* @brief Called when an associated text input UI control has focus.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context_id The input context identification value of an associated text input UI control
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_focus_in_cb() function.
- *
* @see ime_event_set_focus_in_cb()
*/
typedef void (*ime_focus_in_cb)(int context_id, void *user_data);
+
/**
* @brief Called when an associated text input UI control loses focus.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context_id The input context identification value of an associated text input UI control
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_focus_out_cb() function.
- *
* @see ime_event_set_focus_out_cb()
*/
typedef void (*ime_focus_out_cb)(int context_id, void *user_data);
+
/**
* @brief Called when an associated text input UI control responds to a request with the surrounding text.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The ime_request_surrounding_text() must be called to invoke this callback function, asynchronously.
- *
* @param[in] context_id The input context identification value of an associated text input UI control
* @param[in] text The UTF-8 string requested
* @param[in] cursor_pos The cursor position
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_surrounding_text_updated_cb() function.
- *
* @see ime_event_set_surrounding_text_updated_cb()
* @see ime_request_surrounding_text()
*/
typedef void (*ime_surrounding_text_updated_cb)(int context_id, const char *text, int cursor_pos, void *user_data);
+
/**
* @brief Called to reset the input context of an associated text input UI control.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_input_context_reset_cb() function.
- *
* @see ime_event_set_input_context_reset_cb()
*/
typedef void (*ime_input_context_reset_cb)(void *user_data);
+
/**
* @brief Called when the position of the cursor in an associated text input UI control changes.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] cursor_pos The cursor position
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_cursor_position_updated_cb() function.
- *
* @see ime_event_set_cursor_position_updated_cb()
*/
typedef void (*ime_cursor_position_updated_cb)(int cursor_pos, void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the language from the input panel.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The allocated @a lang_code will be released internally.
- *
* @param[in] user_data User data to be passed from the callback registration function
* @param[out] lang_code Input panel's current input language code (e.g., "en_US")
- *
* @pre The callback can be registered using ime_event_set_language_requested_cb() function.
- *
* @see ime_event_set_language_requested_cb()
*/
typedef void (*ime_language_requested_cb)(void *user_data, char **lang_code);
+
/**
* @brief Called to set the preferred language to the input panel.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks @a language information is already set to the input panel when it is shown
- * through #ime_context_h. This callback function will be only called when the client
- * application changes the edit field's language attribute after the input panel is shown.
- *
+ * @remarks @a language information is already set to the input panel when it is shown through #ime_context_h.
+ * This callback function will be only called when the client application changes the edit field's language attribute after the input panel is shown.
* @param[in] language The preferred language that the client application wants
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_language_set_cb() function.
- *
* @see ime_event_set_language_set_cb()
*/
typedef void (*ime_language_set_cb)(Ecore_IMF_Input_Panel_Lang language, void *user_data);
+
/**
* @brief Called to set the application specific data to deliver to the input panel.
- *
* @details This API is used by the applications to deliver the specific data to the input panel.
- * The data format MUST be negotiated by both application and input panel.
- *
+ * The data format MUST be negotiated by both application and input panel.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] data The specific data to be set to the input panel
* @param[in] data_length The length of data, in bytes, to send to the input panel
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_imdata_set_cb() function.
- *
* @see ime_event_set_imdata_set_cb()
*/
typedef void (*ime_imdata_set_cb)(void *data, unsigned int data_length, void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the application specific data from the input panel.
- *
* @details This API is used by the applications to request the specific data from the input panel.
- * The data format MUST be negotiated by both application and input panel.
- *
+ * The data format MUST be negotiated by both application and input panel.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The allocated @a data will be released internally.
- *
* @param[in] user_data User data to be passed from the callback registration function
* @param[out] data Input panel's data to be set to the application
* @param[out] data_length The length of data, in bytes, to send to the application
- *
* @pre The callback can be registered using ime_event_set_imdata_requested_cb() function.
- *
* @see ime_event_set_imdata_requested_cb()
*/
typedef void (*ime_imdata_requested_cb)(void *user_data, void **data, unsigned int *data_length);
+
/**
* @brief Called when an associated text input UI control requests the input panel to set its layout.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks @a layout information is already set to the input panel when it is shown
- * through #ime_context_h. This callback function will be only called when the client
- * application changes the edit field's layout attribute after the input panel is shown.
- *
+ * @remarks @a layout information is already set to the input panel when it is shown through #ime_context_h.
+ * This callback function will be only called when the client application changes the edit field's layout attribute after the input panel is shown.
* @param[in] layout The input panel layout
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_layout_set_cb() function.
- *
* @see ime_event_set_layout_set_cb()
*/
typedef void (*ime_layout_set_cb)(Ecore_IMF_Input_Panel_Layout layout, void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the input panel to set the @c Return key label.
- * The input panel can show text or image on the @c Return button according to the @c Return key action.
- *
+ * The input panel can show text or image on the @c Return button according to the @c Return key action.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks @a type information is already set to the input panel when it is shown
- * through #ime_context_h. This callback function will be only called when the client
- * application changes the edit field's @c Return key type attribute after the input panel
- * is shown.
- *
+ * @remarks @a type information is already set to the input panel when it is shown through #ime_context_h.
+ * This callback function will be only called when the client application changes the edit field's @c Return key type attribute after the input panel is shown.
* @param[in] type The type of @c Return key on the input panel
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_return_key_type_set_cb() function.
- *
* @see ime_event_set_return_key_type_set_cb()
*/
typedef void (*ime_return_key_type_set_cb)(Ecore_IMF_Input_Panel_Return_Key_Type type, void *user_data);
+
/**
- * @brief Called when an associated text input UI control requests the input panel to enable
- * or disable the @c Return key state.
- *
+ * @brief Called when an associated text input UI control requests the input panel to enable or disable the @c Return key state.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks @a disabled information is already set to the input panel when it is shown
- * through #ime_context_h. This callback function will be only called when the client
- * application changes the edit field's @c Return key disable attribute after the input panel
- * is shown.
- *
+ * @remarks @a disabled information is already set to the input panel when it is shown through #ime_context_h.
+ * This callback function will be only called when the client application changes the edit field's @c Return key disable attribute after the input panel is shown.
* @param[in] disabled The Boolean state to disable @c Return key. The @c Return key is enabled by default
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_return_key_state_set_cb() function.
- *
* @see ime_event_set_return_key_state_set_cb()
*/
typedef void (*ime_return_key_state_set_cb)(bool disabled, void *user_data);
+
/**
* @brief Called when an associated text input UI control requests the position and size from the input panel.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] user_data User data to be passed from the callback registration function
* @param[out] x The x position in screen
* @param[out] y The y position in screen
* @param[out] w The window width
* @param[out] h The window height
- *
* @pre The callback can be registered using ime_event_set_geometry_requested_cb() function.
- *
* @see ime_event_set_geometry_requested_cb()
*/
typedef void (*ime_geometry_requested_cb)(void *user_data, int *x, int *y, int *w, int *h);
+
/**
* @brief Called when the key event is received from the external devices or ime_send_key_event() function.
- *
* @details This function processes the key event before an associated text input UI control does.
- *
* @remarks If the key event is from the external device, @a dev_info will have its name, class and subclass information.
- *
* @param[in] keycode The key code to be sent
* @param[in] keymask The modifier key mask
* @param[in] dev_info The device information handle
* @param[in] user_data User data to be passed from the callback registration function
- *
- * @return @c true if the event is processed, otherwise the event is not processed and is forwarded to the client application.
- *
+ * @return @c true if the event is processed,
+ * otherwise the event is not processed and is forwarded to the client application
* @pre The callback can be registered using ime_event_set_process_key_event_cb() function.
- *
* @see ime_event_set_process_key_event_cb()
* @see ime_device_info_get_name()
* @see ime_device_info_get_class()
*/
typedef bool (*ime_process_key_event_cb)(ime_key_code_e keycode, ime_key_mask_e keymask, ime_device_info_h dev_info, void *user_data);
+
/**
* @brief Called when the system display language is changed.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] language The language code
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_display_language_changed_cb() function.
- *
* @see ime_event_set_display_language_changed_cb()
*/
typedef void (*ime_display_language_changed_cb)(const char *language, void *user_data);
+
/**
* @brief Called when the device is rotated.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] degree The rotation degree
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_rotation_degree_changed_cb() function.
- *
* @see ime_event_set_rotation_degree_changed_cb()
*/
typedef void (*ime_rotation_degree_changed_cb)(int degree, void *user_data);
+
/**
* @brief Called when Accessibility in Settings application is on or off.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] state Accessibility option state
* @param[in] user_data User data to be passed from the callback registration function
- *
* @pre The callback can be registered using ime_event_set_accessibility_state_changed_cb() function.
- *
* @see ime_event_set_accessibility_state_changed_cb()
*/
typedef void (*ime_accessibility_state_changed_cb)(bool state, void *user_data);
+
/**
* @brief Called to create the option window.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks if Input panel requests to open the option window, @a type will be #IME_OPTION_WINDOW_TYPE_KEYBOARD.
- * And if Settings application requests to open it, @a type will be #IME_OPTION_WINDOW_TYPE_SETTING_APPLICATION.
- *
+ * @remarks If Input panel requests to open the option window, @a type will be #IME_OPTION_WINDOW_TYPE_KEYBOARD.
+ * And if Settings application requests to open it, @a type will be #IME_OPTION_WINDOW_TYPE_SETTING_APPLICATION.
* @param[in] window The created window object
* @param[in] type The type of option window
* @param[in] user_data User data to be passed from the callback registration function
- *
- * @pre The callback can be registered using ime_event_set_option_window_created_cb() function. The
- * ime_create_option_window() calls this callback function or Settings application can call this callback function.
- *
+ * @pre The callback can be registered using ime_event_set_option_window_created_cb() function.
+ * The ime_create_option_window() calls this callback function or Settings application can call this callback function.
* @see ime_event_set_option_window_created_cb()
* @see ime_create_option_window()
*/
typedef void (*ime_option_window_created_cb)(Evas_Object *window, ime_option_window_type_e type, void *user_data);
+
/**
* @brief Called to destroy the option window.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] window The window object to destroy
* @param[in] user_data User data to be passed to the callback function
- *
* @pre The callback can be registered using ime_event_set_option_window_destroyed_cb() function.
- * ime_destroy_option_window() calls this callback function.
- *
+ * ime_destroy_option_window() calls this callback function.
* @see ime_event_set_option_window_destroyed_cb()
*/
typedef void (*ime_option_window_destroyed_cb)(Evas_Object *window, void *user_data);
+
/**
* @brief The structure type to contain the set of the essential callback functions for IME application lifecycle and appearance.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @remarks These four callback functions are mandatory for IME application.
- *
* @see ime_run()
*/
typedef struct {
- ime_create_cb create; /**< Called when the input panel is created */
+ ime_create_cb create; /**< Called when the input panel is created */
ime_terminate_cb terminate; /**< Called when the input panel is terminated */
- ime_show_cb show; /**< Called when the input panel is requested to show itself */
- ime_hide_cb hide; /**< Called when the input panel is requested to hide itself */
+ ime_show_cb show; /**< Called when the input panel is requested to show itself */
+ ime_hide_cb hide; /**< Called when the input panel is requested to hide itself */
} ime_callback_s;
+
/**
* @brief Runs the main loop of IME application.
- *
- * @details This function starts to run IME application's main loop. The ime_create_cb()
- * callback function is called to initialize IME application before the main loop starts up. And
- * the ime_terminate_cb() callback function is called when IME application is terminated.
- *
+ * @details This function starts to run IME application's main loop.
+ * The ime_create_cb() callback function is called to initialize IME application before the main loop starts up.
+ * And the ime_terminate_cb() callback function is called when IME application is terminated.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks IME application MUST implement ime_app_main() function which is the main
- * entry point of IME application. In ime_app_main() function, the ime_run()
- * function MUST be called with the necessary callback functions; ime_create_cb(),
- * ime_terminate_cb(), ime_show_cb(), and ime_hide_cb() callback functions
- * are mandatory for IME application.
- *
+ * entry point of IME application. In ime_app_main() function, the ime_run()
+ * function MUST be called with the necessary callback functions; ime_create_cb(),
+ * ime_terminate_cb(), ime_show_cb(), and ime_hide_cb() callback functions
+ * are mandatory for IME application.
* @param[in] basic_cb The structure pointer of the essential callback functions
* @param[in] user_data User data to be passed to the callback functions
- *
- * @return 0 if IME application ends successfully, otherwise a negative error value
+ * @return @c 0 if IME application ends successfully,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NO_CALLBACK_FUNCTION Necessary callback function is not set
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @pre The ime_event_set_***() functions can be called to set the event handling callback functions.
- *
* @see ime_callback_s()
* @see ime_event_set_focus_in_cb()
* @see ime_event_set_focus_out_cb()
* @see ime_event_set_accessibility_state_changed_cb()
* @see ime_event_set_option_window_created_cb()
* @see ime_event_set_option_window_destroyed_cb()
- *
* @code
static void inputmethod_create_cb(void *user_data);
static void inputmethod_terminate_cb(void *user_data);
*/
EXPORT_API int ime_run(ime_callback_s *basic_cb, void *user_data);
+
/**
* @brief Sets @c focus_in event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_focus_in_cb() callback function is called when an associated text input
- * UI control has focus.
- *
+ * @remarks The ime_focus_in_cb() callback function is called when an associated text input UI control has focus.
* @param[in] callback_func @c focus_in event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_focus_in_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_focus_in_cb(ime_focus_in_cb callback_func, void *user_data);
+
/**
* @brief Sets @c focus_out event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_focus_out_cb() callback function is called when an associated text input
- * UI control loses focus.
- *
+ * @remarks The ime_focus_out_cb() callback function is called when an associated text input UI control loses focus.
* @param[in] callback_func @c focus_out event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_focus_out_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_focus_out_cb(ime_focus_out_cb callback_func, void *user_data);
+
/**
* @brief Sets @c surrounding_text_updated event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_surrounding_text_updated_cb() callback function is called when an
- * associated text input UI control responds to a request with the surrounding text.
- *
+ * @remarks The ime_surrounding_text_updated_cb() callback function is called when an associated text input UI control responds to a request with the surrounding text.
* @param[in] callback_func @c surrounding_text_updated event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_surrounding_text_updated_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_surrounding_text_updated_cb(ime_surrounding_text_updated_cb callback_func, void *user_data);
+
/**
* @brief Sets @c input_context_reset event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_input_context_reset_cb() callback function is called to reset the input
- * context of an associated text input UI control.
- *
+ * @remarks The ime_input_context_reset_cb() callback function is called to reset the input context of an associated text input UI control.
* @param[in] callback_func @c input_context_reset event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_input_context_reset_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_input_context_reset_cb(ime_input_context_reset_cb callback_func, void *user_data);
+
/**
* @brief Sets @c cursor_position_updated event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_cursor_position_updated_cb() callback function is called when the position
- * of the cursor in an associated text input UI control changes.
- *
+ * @remarks The ime_cursor_position_updated_cb() callback function is called when the position of the cursor in an associated text input UI control changes.
* @param[in] callback_func @c cursor_position_updated event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_cursor_position_updated_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_cursor_position_updated_cb(ime_cursor_position_updated_cb callback_func, void *user_data);
+
/**
* @brief Sets @c language_requested event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_language_requested_cb() callback function is called when an associated
- * text input UI control requests the language from the input panel.
- *
+ * @remarks The ime_language_requested_cb() callback function is called when an associated text input UI control requests the language from the input panel.
* @param[in] callback_func @c language_requested event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_language_requested_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_language_requested_cb(ime_language_requested_cb callback_func, void *user_data);
+
/**
* @brief Sets @c language_set event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_language_set_cb() callback function is called to set the preferred
- * language to the input panel.
- *
+ * @remarks The ime_language_set_cb() callback function is called to set the preferred language to the input panel.
* @param[in] callback_func @c language_set event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_language_set_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_language_set_cb(ime_language_set_cb callback_func, void *user_data);
+
/**
* @brief Sets @c imdata_set event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_imdata_set_cb() callback function is called to set the application
- * specific data to deliver to the input panel.
- *
+ * @remarks The ime_imdata_set_cb() callback function is called to set the application specific data to deliver to the input panel.
* @param[in] callback_func @c imdata_set event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_imdata_set_cb()
* @see ime_event_set_imdata_requested_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_imdata_set_cb(ime_imdata_set_cb callback_func, void *user_data);
+
/**
* @brief Sets @c imdata_requested event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_imdata_requested_cb() callback function is called when an associated
- * text input UI control requests the application specific data from the input panel.
- *
+ * @remarks The ime_imdata_requested_cb() callback function is called when an associated text input UI control requests the application specific data from the input panel.
* @param[in] callback_func @c imdata_requested event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_imdata_requested_cb()
* @see ime_event_set_imdata_set_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_imdata_requested_cb(ime_imdata_requested_cb callback_func, void *user_data);
+
/**
* @brief Sets @c layout_set event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_layout_set_cb() callback function is called when an associated text input
- * UI control requests the input panel to set its layout.
- *
+ * @remarks The ime_layout_set_cb() callback function is called when an associated text input UI control requests the input panel to set its layout.
* @param[in] callback_func @c layout_set event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_layout_set_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_layout_set_cb(ime_layout_set_cb callback_func, void *user_data);
+
/**
* @brief Sets @c return_key_type_set event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_return_key_type_set_cb() callback function is called when an associated
- * text input UI control requests the input panel to set the @c Return key label.
- *
+ * @remarks The ime_return_key_type_set_cb() callback function is called when an associated text input UI control requests the input panel to set the @c Return key label.
* @param[in] callback_func @c return_key_type_set event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_return_key_type_set_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_return_key_type_set_cb(ime_return_key_type_set_cb callback_func, void *user_data);
+
/**
* @brief Sets @c return_key_state_set event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_return_key_state_set_cb() callback function is called when an associated
- * text input UI control requests the input panel to enable or disable the @c Return key state.
- *
+ * @remarks The ime_return_key_state_set_cb() callback function is called when an associated text input UI control requests the input panel to enable or disable the @c Return key state.
* @param[in] callback_func @c return_key_state_set event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_return_key_state_set_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_return_key_state_set_cb(ime_return_key_state_set_cb callback_func, void *user_data);
+
/**
* @brief Sets @c geometry_requested event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_geometry_requested_cb() callback function is called when an associated
- * text input UI control requests the position and size from the input panel.
- *
+ * @remarks The ime_geometry_requested_cb() callback function is called when an associated text input UI control requests the position and size from the input panel.
* @param[in] callback_func @c geometry_requested event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_geometry_requested_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func, void *user_data);
+
/**
* @brief Sets @c process_key_event event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_process_key_event_cb() callback function is called when the key event
- * is received from the external keyboard devices or ime_send_key_event() function.
- *
+ * @remarks The ime_process_key_event_cb() callback function is called when the key event is received from the external keyboard devices or ime_send_key_event() function.
* @param[in] callback_func @c process_key_event event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_process_key_event_cb()
* @see ime_run()
- *
* @code
static void inputmethod_create_cb(void *user_data);
static void inputmethod_terminate_cb(void *user_data);
*/
EXPORT_API int ime_event_set_process_key_event_cb(ime_process_key_event_cb callback_func, void *user_data);
+
/**
* @brief Sets @c display_language_changed event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_display_language_changed_cb() callback function is called when the system
- * display language is changed.
- *
+ * @remarks The ime_display_language_changed_cb() callback function is called when the system display language is changed.
* @param[in] callback_func @c display_language_changed event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_display_language_changed_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_display_language_changed_cb(ime_display_language_changed_cb callback_func, void *user_data);
+
/**
* @brief Sets @c rotation_degree_changed event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_rotation_degree_changed_cb() callback function is called when the device
- * is rotated.
- *
+ * @remarks The ime_rotation_degree_changed_cb() callback function is called when the device is rotated.
* @param[in] callback_func @c rotation_degree_changed event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_rotation_degree_changed_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_rotation_degree_changed_cb(ime_rotation_degree_changed_cb callback_func, void *user_data);
+
/**
* @brief Sets @c accessibility_state_changed event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks The ime_accessibility_state_changed_cb() callback function is called when
- * Accessibility in Settings application is on or off.
- *
+ * @remarks The ime_accessibility_state_changed_cb() callback function is called when Accessibility in Settings application is on or off.
* @param[in] callback_func @c accessibility_state_changed event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_accessibility_state_changed_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_accessibility_state_changed_cb(ime_accessibility_state_changed_cb callback_func, void *user_data);
+
/**
* @brief Sets @c option_window_created event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The ime_option_window_created_cb() callback function is called to create the option window.
- *
* @param[in] callback_func @c option_window_created event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_option_window_created_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_option_window_created_cb(ime_option_window_created_cb callback_func, void *user_data);
+
/**
* @brief Sets @c option_window_destroyed event callback function.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The ime_option_window_destroyed_cb() callback function is called to destroy the option window.
- *
* @param[in] callback_func @c option_window_destroyed event callback function
* @param[in] user_data User data to be passed to the callback function
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
* @post The ime_run() function should be called to start to run IME application's main loop.
- *
* @see ime_option_window_destroyed_cb()
* @see ime_run()
*/
EXPORT_API int ime_event_set_option_window_destroyed_cb(ime_option_window_destroyed_cb callback_func, void *user_data);
+
/**
* @brief Sends a key event to the associated text input UI control.
- *
+ * @details This function sends key down or up event with key mask to the client application.
+ * If @a forward_key is @c true, this key event goes to the edit filed directly.
+ * And if @a forward_key is @c false, the ime_process_key_event_cb() callback function receives the key event before the edit field.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @details This function sends key down or up event with key mask to the client application.
- * If @a forward_key is @c true, this key event goes to the edit filed directly. And if @a forward_key
- * is @c false, the ime_process_key_event_cb() callback function receives the key event before the edit field.
- *
* @param[in] keycode The key code to be sent
* @param[in] keymask The modifier key mask
* @param[in] forward_key The flag to send the key event directly to the edit field
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post If @a forward_key is @c false, the ime_process_key_event_cb() callback function can compose the text with the key events.
- *
* @see ime_key_code_e
* @see ime_key_mask_e
* @see ime_process_key_event_cb()
*/
EXPORT_API int ime_send_key_event(ime_key_code_e keycode, ime_key_mask_e keymask, bool forward_key);
+
/**
* @brief Sends the text to the associated text input UI control.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] str The UTF-8 string to be committed
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_show_preedit_string()
* @see ime_hide_preedit_string()
* @see ime_update_preedit_string()
*/
EXPORT_API int ime_commit_string(const char *str);
+
/**
* @brief Requests to show preedit string.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_commit_string()
* @see ime_hide_preedit_string()
* @see ime_update_preedit_string()
*/
EXPORT_API int ime_show_preedit_string(void);
+
/**
* @brief Requests to hide preedit string.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_commit_string()
* @see ime_show_preedit_string()
* @see ime_update_preedit_string()
*/
EXPORT_API int ime_hide_preedit_string(void);
+
/**
* @brief Updates a new preedit string.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] str The UTF-8 string to be updated in preedit
* @param[in] attrs The Eina_List which has #ime_preedit_attribute lists; @a str can be composed of multiple
- * string attributes: underline, highlight color and reversal color. The @a attrs will be released internally
- * on success and it can be NULL if no attributes to set
- *
- * @return 0 on success, otherwise a negative error value
+ * string attributes: underline, highlight color and reversal color. The @a attrs will be released internally
+ * on success and it can be NULL if no attributes to set
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post This function is supposed to be followed by the ime_show_preedit_string() function.
- *
* @see ime_preedit_attribute
* @see ime_commit_string()
* @see ime_show_preedit_string()
* @see ime_hide_preedit_string()
- *
* @code
{
int ret;
*/
EXPORT_API int ime_update_preedit_string(const char *str, Eina_List *attrs);
+
/**
* @brief Requests the surrounding text from the position of the cursor, asynchronously.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] maxlen_before The maximum length of string to be retrieved before the cursor; -1 means unlimited
* @param[in] maxlen_after The maximum length of string to be retrieved after the cursor; -1 means unlimited
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NO_CALLBACK_FUNCTION Necessary callback function is not set
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @pre The ime_surrounding_text_updated_cb() callback function MUST be set by ime_event_set_surrounding_text_updated_cb().
- *
* @post The requested surrounding text can be received using the ime_surrounding_text_updated_cb() callback function.
- *
* @see ime_delete_surrounding_text()
* @see ime_event_set_surrounding_text_updated_cb()
* @see ime_surrounding_text_updated_cb()
*/
EXPORT_API int ime_request_surrounding_text(int maxlen_before, int maxlen_after);
+
/**
* @brief Requests to delete surrounding text.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] offset The offset value from the cursor position
* @param[in] len The length of the text to delete
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_request_surrounding_text()
*/
EXPORT_API int ime_delete_surrounding_text(int offset, int len);
+
/**
* @brief Gets the surrounding text from the position of the cursor, synchronously.
- *
- * @remarks @a text must be released using free().
- *
* @since_tizen 3.0
- *
+ * @remarks @a text must be released using free().
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] maxlen_before The maximum length of string to be retrieved before the cursor; -1 means unlimited
* @param[in] maxlen_after The maximum length of string to be retrieved after the cursor; -1 means unlimited
* @param[out] text The surrounding text
* @param[out] cursor_pos The cursor position
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
* @retval #IME_ERROR_OUT_OF_MEMORY Failed to obtain text due to out of memory
- *
* @see ime_delete_surrounding_text()
*/
EXPORT_API int ime_get_surrounding_text(int maxlen_before, int maxlen_after, char **text, int *cursor_pos);
+
/**
* @brief Requests to set selection.
- *
* @since_tizen 3.0
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] start The start cursor position in text (in characters not bytes)
* @param[in] end The end cursor position in text (in characters not bytes)
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
*/
EXPORT_API int ime_set_selection(int start, int end);
+
/**
* @brief This API returns the pointer of input panel main window.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks The specific error code can be obtained using the get_last_result() method if this function returns NULL.
- *
- * @return The input panel main window object on success, otherwise NULL
- *
+ * @return The input panel main window object on success,
+ * otherwise NULL
* @exception #IME_ERROR_NONE Successful
- * #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
- * #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- * #IME_ERROR_OPERATION_FAILED Operation failed
- *
+ * #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
+ * #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
+ * #IME_ERROR_OPERATION_FAILED Operation failed
* @see ime_create_cb()
* @see ime_terminate_cb()
* @see ime_show_cb()
*/
EXPORT_API Evas_Object* ime_get_main_window(void);
+
/**
* @brief This API updates the input panel window's size information.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] portrait_width The width in portrait mode
* @param[in] portrait_height The height in portrait mode
* @param[in] landscape_width The width in landscape mode
* @param[in] landscape_height The height in landscape mode
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_create_cb()
*/
EXPORT_API int ime_set_size(int portrait_width, int portrait_height, int landscape_width, int landscape_height);
+
/**
* @brief Requests to create an option window from the input panel.
- *
- * @details The input panel can call this function to open the option window. This
- * function calls ime_option_window_created_cb() callback function with
- * #IME_OPTION_WINDOW_TYPE_KEYBOARD parameter.
- *
+ * @details The input panel can call this function to open the option window.
+ * This function calls ime_option_window_created_cb() callback function with #IME_OPTION_WINDOW_TYPE_KEYBOARD parameter.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NO_CALLBACK_FUNCTION Necessary callback function is not set
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
* @retval #IME_ERROR_OPERATION_FAILED Operation failed
- *
- * @pre The ime_option_window_created_cb() and ime_option_window_destroyed_cb()
- * callback functions MUST be set by ime_event_set_option_window_created_cb() and
- * ime_event_set_option_window_destroyed_cb() respectively.
- *
- * @post This function calls ime_option_window_created_cb() callback function to
- * create the option window. And ime_destroy_option_window() function can be called
- * to close the option window.
- *
+ * @pre The ime_option_window_created_cb() and ime_option_window_destroyed_cb() callback functions MUST be set by ime_event_set_option_window_created_cb() and ime_event_set_option_window_destroyed_cb() respectively.
+ * @post This function calls ime_option_window_created_cb() callback function to create the option window. And ime_destroy_option_window() function can be called to close the option window.
* @see ime_event_set_option_window_created_cb()
* @see ime_option_window_created_cb()
* @see ime_destroy_option_window()
*/
EXPORT_API int ime_create_option_window(void);
+
/**
* @brief Requests to destroy an option window.
- *
- * @details The input panel can call this function to close the option window which
- * is created from either the input panel or Settings application.
- *
+ * @details The input panel can call this function to close the option window which is created from either the input panel or Settings application.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] window The option window to destroy
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NO_CALLBACK_FUNCTION Necessary callback function is not set
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
- * @pre The ime_option_window_created_cb() and ime_option_window_destroyed_cb()
- * callback functions MUST be set by ime_event_set_option_window_created_cb() and
- * ime_event_set_option_window_destroyed_cb() respectively.
- *
- * @post This function calls ime_option_window_destroyed_cb() callback function
- * to destroy the option window.
- *
+ * @pre The ime_option_window_created_cb() and ime_option_window_destroyed_cb() callback functions MUST be set by ime_event_set_option_window_created_cb() and ime_event_set_option_window_destroyed_cb() respectively.
+ * @post This function calls ime_option_window_destroyed_cb() callback function to destroy the option window.
* @see ime_event_set_option_window_destroyed_cb()
* @see ime_option_window_destroyed_cb()
* @see ime_create_option_window()
*/
EXPORT_API int ime_destroy_option_window(Evas_Object *window);
+
/**
* @brief Gets the layout information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the layout information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the layout information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] layout Layout information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
* @see ime_layout_set_cb()
*/
EXPORT_API int ime_context_get_layout(ime_context_h context, Ecore_IMF_Input_Panel_Layout *layout);
+
/**
* @brief Gets the layout variation information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the layout variation information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the layout variation information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] layout_variation Layout variation information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
* @see ime_layout_variation_e
*/
EXPORT_API int ime_context_get_layout_variation(ime_context_h context, ime_layout_variation_e *layout_variation);
+
/**
* @brief Gets the cursor position information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the cursor position information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the cursor position information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] cursor_pos Cursor position information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
* @see ime_cursor_position_updated_cb()
*/
EXPORT_API int ime_context_get_cursor_position(ime_context_h context, int *cursor_pos);
+
/**
* @brief Gets the autocapital type information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the autocapital type information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the autocapital type information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] autocapital_type Autocapital type information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_autocapital_type(ime_context_h context, Ecore_IMF_Autocapital_Type *autocapital_type);
+
/**
* @brief Gets the @c Return key label type information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the @c Return key label type information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the @c Return key label type information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] return_key_type The @c Return key label type information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
* @see ime_return_key_type_set_cb()
*/
EXPORT_API int ime_context_get_return_key_type(ime_context_h context, Ecore_IMF_Input_Panel_Return_Key_Type *return_key_type);
+
/**
* @brief Gets the @c Return key state information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the @c Return key state information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the @c Return key state information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
- * @param[out] return_key_state The @c Return key state information \n @c true to enable @c Return key
- * button, @c false to disable @c Return key button
- *
- * @return 0 on success, otherwise a negative error value
+ * @param[out] return_key_state The @c Return key state information @c true to enable @c Return key button,
+ * @c false to disable @c Return key button
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
* @see ime_return_key_state_set_cb()
*/
EXPORT_API int ime_context_get_return_key_state(ime_context_h context, bool *return_key_state);
+
/**
* @brief Gets the prediction mode information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the prediction mode information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the prediction mode information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
- * @param[out] prediction_mode Prediction mode information \n @c true to allow the predictive
- * text feature if available, @c false to disable the predictive text feature
- *
- * @return 0 on success, otherwise a negative error value
+ * @param[out] prediction_mode Prediction mode information @c true to allow the predictive text feature if available,
+ * @c false to disable the predictive text feature
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_prediction_mode(ime_context_h context, bool *prediction_mode);
+
/**
* @brief Gets the password mode information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the password mode information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the password mode information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks If @a password_mode is @c true, the input panel is advised not to support the predictive text.
- *
* @param[in] context The input context information of an associated text input UI control
- * @param[out] password_mode Password mode information \n @c true to indicate that a password being inputted,
- * @c false to indicate non-password edit field.
- *
- * @return 0 on success, otherwise a negative error value
+ * @param[out] password_mode Password mode information @c true to indicate that a password being entered,
+ * @c false to indicate non-password edit field
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_password_mode(ime_context_h context, bool *password_mode);
+
/**
* @brief Gets the input hint information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the input hint information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the input hint information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
- * @remarks @a input_hint is a bit-wise value which recommends the input panel provide
- * an auto completion and so on if it is capable of supporting such features.
- *
+ * @remarks @a input_hint is a bit-wise value which recommends the input panel provide an auto completion and so on if it is capable of supporting such features.
* @param[in] context The input context information of an associated text input UI control
* @param[out] input_hint Input hint information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_input_hint(ime_context_h context, Ecore_IMF_Input_Hints *input_hint);
+
/**
* @brief Gets the text bidirectional information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the bidirectional information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the bidirectional information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] bidi Text bidirectional information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_bidi_direction(ime_context_h context, Ecore_IMF_BiDi_Direction *bidi);
+
/**
* @brief Gets the preferred language information from the given input context.
- *
- * @details Each edit field has various attributes for input panel. This function can be
- * called to get the preferred language information in ime_show_cb() callback function.
- *
+ * @details Each edit field has various attributes for input panel. This function can be called to get the preferred language information in ime_show_cb() callback function.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] context The input context information of an associated text input UI control
* @param[out] language Preferred language information
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @post Input panel UI should be drawn or operated by this information accordingly.
- *
* @see ime_show_cb()
*/
EXPORT_API int ime_context_get_language(ime_context_h context, Ecore_IMF_Input_Panel_Lang *language);
+
/**
* @brief Gets the device name of the key event.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @remarks @a dev_name must be released using free().
- *
* @param[in] dev_info The device information from the key event
* @param[out] dev_name The name of key input device. This can be an empty string if the device name is not available
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_process_key_event_cb()
* @see ime_device_info_get_class()
* @see ime_device_info_get_subclass()
*/
EXPORT_API int ime_device_info_get_name(ime_device_info_h dev_info, char **dev_name);
+
/**
* @brief Gets the device class of the key event.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] dev_info The device information from the key event
* @param[out] dev_class The class of key input device. This can be #ECORE_IMF_DEVICE_CLASS_NONE if the device class is not available
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_process_key_event_cb()
* @see ime_device_info_get_name()
* @see ime_device_info_get_subclass()
*/
EXPORT_API int ime_device_info_get_class(ime_device_info_h dev_info, Ecore_IMF_Device_Class *dev_class);
+
+
/**
* @brief Gets the device subclass of the key event.
- *
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
- *
* @privlevel public
- *
* @privilege %http://tizen.org/privilege/ime
- *
* @param[in] dev_info The device information from the key event
* @param[out] dev_subclass The subclass of key input device. This can be #ECORE_IMF_DEVICE_SUBCLASS_NONE if the device subclass is not available
- *
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #IME_ERROR_NONE No error
* @retval #IME_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #IME_ERROR_NOT_RUNNING IME main loop isn't started yet
- *
* @see ime_process_key_event_cb()
* @see ime_device_info_get_name()
* @see ime_device_info_get_class()
*/
EXPORT_API int ime_device_info_get_subclass(ime_device_info_h dev_info, Ecore_IMF_Device_Subclass *dev_subclass);
+
/**
* @}
*/
+
#ifdef __cplusplus
}
#endif
* limitations under the License.
*/
+
#ifndef __TIZEN_UIX_INPUTMETHOD_KEYDEF_H__
#define __TIZEN_UIX_INPUTMETHOD_KEYDEF_H__
+
/**
* @file inputmethod_keydef.h
* @brief This file contains key code and mask enumeration.
*/
+
/**
* @addtogroup CAPI_UIX_INPUTMETHOD_MODULE
* @{
*/
+
/**
- * @brief Enumeration of the key codes.
- *
- * If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.
- * The UCS value is keycode & 0x00ffffff.
- *
+ * @brief Enumeration for the key codes.
+ * If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.
+ * The UCS value is keycode & 0x00ffffff.
* @details Defines the list of keys supported by the system.
- * Note that certain keys may not be available on all devices.
- *
+ * Note that certain keys may not be available on all devices.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
typedef enum {
- IME_KEY_BackSpace = 0xFF08, /**< The backspace key */
- IME_KEY_Tab = 0xFF09, /**< The tab key */
- IME_KEY_Linefeed = 0xFF0A, /**< The linefeed key */
- IME_KEY_Clear = 0xFF0B, /**< The clear key */
- IME_KEY_Return = 0xFF0D, /**< The return key */
- IME_KEY_Pause = 0xFF13, /**< The pause key */
- IME_KEY_Scroll_Lock = 0xFF14, /**< The scroll lock key */
- IME_KEY_Sys_Req = 0xFF15, /**< The sys req key */
- IME_KEY_Escape = 0xFF1B, /**< The escape key */
- IME_KEY_Delete = 0xFFFF, /**< The delete key */
+ IME_KEY_BackSpace = 0xFF08, /**< The backspace key */
+ IME_KEY_Tab = 0xFF09, /**< The tab key */
+ IME_KEY_Linefeed = 0xFF0A, /**< The linefeed key */
+ IME_KEY_Clear = 0xFF0B, /**< The clear key */
+ IME_KEY_Return = 0xFF0D, /**< The return key */
+ IME_KEY_Pause = 0xFF13, /**< The pause key */
+ IME_KEY_Scroll_Lock = 0xFF14, /**< The scroll lock key */
+ IME_KEY_Sys_Req = 0xFF15, /**< The sys req key */
+ IME_KEY_Escape = 0xFF1B, /**< The escape key */
+ IME_KEY_Delete = 0xFFFF, /**< The delete key */
/* Cursor control & motion */
- IME_KEY_Home = 0xFF50, /**< The home key */
- IME_KEY_Left = 0xFF51, /**< The left directional key */
- IME_KEY_Up = 0xFF52, /**< The up directional key */
- IME_KEY_Right = 0xFF53, /**< The right directional key */
- IME_KEY_Down = 0xFF54, /**< The down directional key */
- IME_KEY_Prior = 0xFF55, /**< The prior, previous key */
- IME_KEY_Page_Up = 0xFF55, /**< The page up key */
- IME_KEY_Next = 0xFF56, /**< The next key */
- IME_KEY_Page_Down = 0xFF56, /**< The page down key */
- IME_KEY_End = 0xFF57, /**< The end key */
- IME_KEY_Begin = 0xFF58, /**< The begin key */
+ IME_KEY_Home = 0xFF50, /**< The home key */
+ IME_KEY_Left = 0xFF51, /**< The left directional key */
+ IME_KEY_Up = 0xFF52, /**< The up directional key */
+ IME_KEY_Right = 0xFF53, /**< The right directional key */
+ IME_KEY_Down = 0xFF54, /**< The down directional key */
+ IME_KEY_Prior = 0xFF55, /**< The prior, previous key */
+ IME_KEY_Page_Up = 0xFF55, /**< The page up key */
+ IME_KEY_Next = 0xFF56, /**< The next key */
+ IME_KEY_Page_Down = 0xFF56, /**< The page down key */
+ IME_KEY_End = 0xFF57, /**< The end key */
+ IME_KEY_Begin = 0xFF58, /**< The begin key */
/* Misc Functions */
- IME_KEY_Select = 0xFF60, /**< The select key */
- IME_KEY_Print = 0xFF61, /**< The print key */
- IME_KEY_Execute = 0xFF62, /**< The execute, run, do key */
- IME_KEY_Insert = 0xFF63, /**< The insert key */
- IME_KEY_Undo = 0xFF65, /**< The undo key */
- IME_KEY_Redo = 0xFF66, /**< The redo key */
- IME_KEY_Menu = 0xFF67, /**< The menu key */
- IME_KEY_Find = 0xFF68, /**< The find key */
- IME_KEY_Cancel = 0xFF69, /**< The cancel, stop, abort, exit key */
- IME_KEY_Help = 0xFF6A, /**< The help key */
- IME_KEY_Break = 0xFF6B, /**< The break key */
- IME_KEY_Mode_switch = 0xFF7E, /**< The character set switch key */
- IME_KEY_Num_Lock = 0xFF7F, /**< The num lock key */
+ IME_KEY_Select = 0xFF60, /**< The select key */
+ IME_KEY_Print = 0xFF61, /**< The print key */
+ IME_KEY_Execute = 0xFF62, /**< The execute, run, do key */
+ IME_KEY_Insert = 0xFF63, /**< The insert key */
+ IME_KEY_Undo = 0xFF65, /**< The undo key */
+ IME_KEY_Redo = 0xFF66, /**< The redo key */
+ IME_KEY_Menu = 0xFF67, /**< The menu key */
+ IME_KEY_Find = 0xFF68, /**< The find key */
+ IME_KEY_Cancel = 0xFF69, /**< The cancel, stop, abort, exit key */
+ IME_KEY_Help = 0xFF6A, /**< The help key */
+ IME_KEY_Break = 0xFF6B, /**< The break key */
+ IME_KEY_Mode_switch = 0xFF7E, /**< The character set switch key */
+ IME_KEY_Num_Lock = 0xFF7F, /**< The num lock key */
/* Keypad */
- IME_KEY_KP_Space = 0xFF80, /**< The Numpad space key */
- IME_KEY_KP_Tab = 0xFF89, /**< The Numpad tab key */
- IME_KEY_KP_Enter = 0xFF8D, /**< The Numpad enter key */
- IME_KEY_KP_F1 = 0xFF91, /**< The Numpad function 1 key */
- IME_KEY_KP_F2 = 0xFF92, /**< The Numpad function 2 key */
- IME_KEY_KP_F3 = 0xFF93, /**< The Numpad function 3 key */
- IME_KEY_KP_F4 = 0xFF94, /**< The Numpad function 4 key */
- IME_KEY_KP_Home = 0xFF95, /**< The Numpad home key */
- IME_KEY_KP_Left = 0xFF96, /**< The Numpad left key */
- IME_KEY_KP_Up = 0xFF97, /**< The Numpad up key */
- IME_KEY_KP_Right = 0xFF98, /**< The Numpad right key */
- IME_KEY_KP_Down = 0xFF99, /**< The Numpad down key */
- IME_KEY_KP_Prior = 0xFF9A, /**< The Numpad prior, previous key */
- IME_KEY_KP_Page_Up = 0xFF9A, /**< The Numpad page up key */
- IME_KEY_KP_Next = 0xFF9B, /**< The Numpad next key */
- IME_KEY_KP_Page_Down = 0xFF9B, /**< The Numpad page down key */
- IME_KEY_KP_End = 0xFF9C, /**< The Numpad end key */
- IME_KEY_KP_Begin = 0xFF9D, /**< The Numpad begin key */
- IME_KEY_KP_Insert = 0xFF9E, /**< The Numpad insert key */
- IME_KEY_KP_Delete = 0xFF9F, /**< The Numpad delete key */
- IME_KEY_KP_Equal = 0xFFBD, /**< The Numpad equal key */
- IME_KEY_KP_Multiply = 0xFFAA, /**< The Numpad multiply key */
- IME_KEY_KP_Add = 0xFFAB, /**< The Numpad add key */
- IME_KEY_KP_Separator = 0xFFAC, /**< The Numpad separator key */
- IME_KEY_KP_Subtract = 0xFFAD, /**< The Numpad subtract key */
- IME_KEY_KP_Decimal = 0xFFAE, /**< The Numpad decimal key */
- IME_KEY_KP_Divide = 0xFFAF, /**< The Numpad divide key */
+ IME_KEY_KP_Space = 0xFF80, /**< The Numpad space key */
+ IME_KEY_KP_Tab = 0xFF89, /**< The Numpad tab key */
+ IME_KEY_KP_Enter = 0xFF8D, /**< The Numpad enter key */
+ IME_KEY_KP_F1 = 0xFF91, /**< The Numpad function 1 key */
+ IME_KEY_KP_F2 = 0xFF92, /**< The Numpad function 2 key */
+ IME_KEY_KP_F3 = 0xFF93, /**< The Numpad function 3 key */
+ IME_KEY_KP_F4 = 0xFF94, /**< The Numpad function 4 key */
+ IME_KEY_KP_Home = 0xFF95, /**< The Numpad home key */
+ IME_KEY_KP_Left = 0xFF96, /**< The Numpad left key */
+ IME_KEY_KP_Up = 0xFF97, /**< The Numpad up key */
+ IME_KEY_KP_Right = 0xFF98, /**< The Numpad right key */
+ IME_KEY_KP_Down = 0xFF99, /**< The Numpad down key */
+ IME_KEY_KP_Prior = 0xFF9A, /**< The Numpad prior, previous key */
+ IME_KEY_KP_Page_Up = 0xFF9A, /**< The Numpad page up key */
+ IME_KEY_KP_Next = 0xFF9B, /**< The Numpad next key */
+ IME_KEY_KP_Page_Down = 0xFF9B, /**< The Numpad page down key */
+ IME_KEY_KP_End = 0xFF9C, /**< The Numpad end key */
+ IME_KEY_KP_Begin = 0xFF9D, /**< The Numpad begin key */
+ IME_KEY_KP_Insert = 0xFF9E, /**< The Numpad insert key */
+ IME_KEY_KP_Delete = 0xFF9F, /**< The Numpad delete key */
+ IME_KEY_KP_Equal = 0xFFBD, /**< The Numpad equal key */
+ IME_KEY_KP_Multiply = 0xFFAA, /**< The Numpad multiply key */
+ IME_KEY_KP_Add = 0xFFAB, /**< The Numpad add key */
+ IME_KEY_KP_Separator = 0xFFAC, /**< The Numpad separator key */
+ IME_KEY_KP_Subtract = 0xFFAD, /**< The Numpad subtract key */
+ IME_KEY_KP_Decimal = 0xFFAE, /**< The Numpad decimal key */
+ IME_KEY_KP_Divide = 0xFFAF, /**< The Numpad divide key */
- IME_KEY_KP_0 = 0xFFB0, /**< The Numpad 0 key */
- IME_KEY_KP_1 = 0xFFB1, /**< The Numpad 1 key */
- IME_KEY_KP_2 = 0xFFB2, /**< The Numpad 2 key */
- IME_KEY_KP_3 = 0xFFB3, /**< The Numpad 3 key */
- IME_KEY_KP_4 = 0xFFB4, /**< The Numpad 4 key */
- IME_KEY_KP_5 = 0xFFB5, /**< The Numpad 5 key */
- IME_KEY_KP_6 = 0xFFB6, /**< The Numpad 6 key */
- IME_KEY_KP_7 = 0xFFB7, /**< The Numpad 7 key */
- IME_KEY_KP_8 = 0xFFB8, /**< The Numpad 8 key */
- IME_KEY_KP_9 = 0xFFB9, /**< The Numpad 9 key */
+ IME_KEY_KP_0 = 0xFFB0, /**< The Numpad 0 key */
+ IME_KEY_KP_1 = 0xFFB1, /**< The Numpad 1 key */
+ IME_KEY_KP_2 = 0xFFB2, /**< The Numpad 2 key */
+ IME_KEY_KP_3 = 0xFFB3, /**< The Numpad 3 key */
+ IME_KEY_KP_4 = 0xFFB4, /**< The Numpad 4 key */
+ IME_KEY_KP_5 = 0xFFB5, /**< The Numpad 5 key */
+ IME_KEY_KP_6 = 0xFFB6, /**< The Numpad 6 key */
+ IME_KEY_KP_7 = 0xFFB7, /**< The Numpad 7 key */
+ IME_KEY_KP_8 = 0xFFB8, /**< The Numpad 8 key */
+ IME_KEY_KP_9 = 0xFFB9, /**< The Numpad 9 key */
/* Auxilliary Functions */
- IME_KEY_F1 = 0xFFBE, /**< The function 1 key */
- IME_KEY_F2 = 0xFFBF, /**< The function 2 key */
- IME_KEY_F3 = 0xFFC0, /**< The function 3 key */
- IME_KEY_F4 = 0xFFC1, /**< The function 4 key */
- IME_KEY_F5 = 0xFFC2, /**< The function 5 key */
- IME_KEY_F6 = 0xFFC3, /**< The function 6 key */
- IME_KEY_F7 = 0xFFC4, /**< The function 7 key */
- IME_KEY_F8 = 0xFFC5, /**< The function 8 key */
- IME_KEY_F9 = 0xFFC6, /**< The function 9 key */
- IME_KEY_F10 = 0xFFC7, /**< The function 10 key */
- IME_KEY_F11 = 0xFFC8, /**< The function 11 key */
- IME_KEY_F12 = 0xFFC9, /**< The function 12 key */
- IME_KEY_F13 = 0xFFCA, /**< The function 13 key */
- IME_KEY_F14 = 0xFFCB, /**< The function 14 key */
- IME_KEY_F15 = 0xFFCC, /**< The function 15 key */
- IME_KEY_F16 = 0xFFCD, /**< The function 16 key */
- IME_KEY_F17 = 0xFFCE, /**< The function 17 key */
- IME_KEY_F18 = 0xFFCF, /**< The function 18 key */
- IME_KEY_F19 = 0xFFD0, /**< The function 19 key */
- IME_KEY_F20 = 0xFFD1, /**< The function 20 key */
- IME_KEY_F21 = 0xFFD2, /**< The function 21 key */
- IME_KEY_F22 = 0xFFD3, /**< The function 22 key */
- IME_KEY_F23 = 0xFFD4, /**< The function 23 key */
- IME_KEY_F24 = 0xFFD5, /**< The function 24 key */
- IME_KEY_F25 = 0xFFD6, /**< The function 25 key */
- IME_KEY_F26 = 0xFFD7, /**< The function 26 key */
- IME_KEY_F27 = 0xFFD8, /**< The function 27 key */
- IME_KEY_F28 = 0xFFD9, /**< The function 28 key */
- IME_KEY_F29 = 0xFFDA, /**< The function 29 key */
- IME_KEY_F30 = 0xFFDB, /**< The function 30 key */
- IME_KEY_F31 = 0xFFDC, /**< The function 31 key */
- IME_KEY_F32 = 0xFFDD, /**< The function 32 key */
- IME_KEY_F33 = 0xFFDE, /**< The function 33 key */
- IME_KEY_F34 = 0xFFDF, /**< The function 34 key */
- IME_KEY_F35 = 0xFFE0, /**< The function 35 key */
+ IME_KEY_F1 = 0xFFBE, /**< The function 1 key */
+ IME_KEY_F2 = 0xFFBF, /**< The function 2 key */
+ IME_KEY_F3 = 0xFFC0, /**< The function 3 key */
+ IME_KEY_F4 = 0xFFC1, /**< The function 4 key */
+ IME_KEY_F5 = 0xFFC2, /**< The function 5 key */
+ IME_KEY_F6 = 0xFFC3, /**< The function 6 key */
+ IME_KEY_F7 = 0xFFC4, /**< The function 7 key */
+ IME_KEY_F8 = 0xFFC5, /**< The function 8 key */
+ IME_KEY_F9 = 0xFFC6, /**< The function 9 key */
+ IME_KEY_F10 = 0xFFC7, /**< The function 10 key */
+ IME_KEY_F11 = 0xFFC8, /**< The function 11 key */
+ IME_KEY_F12 = 0xFFC9, /**< The function 12 key */
+ IME_KEY_F13 = 0xFFCA, /**< The function 13 key */
+ IME_KEY_F14 = 0xFFCB, /**< The function 14 key */
+ IME_KEY_F15 = 0xFFCC, /**< The function 15 key */
+ IME_KEY_F16 = 0xFFCD, /**< The function 16 key */
+ IME_KEY_F17 = 0xFFCE, /**< The function 17 key */
+ IME_KEY_F18 = 0xFFCF, /**< The function 18 key */
+ IME_KEY_F19 = 0xFFD0, /**< The function 19 key */
+ IME_KEY_F20 = 0xFFD1, /**< The function 20 key */
+ IME_KEY_F21 = 0xFFD2, /**< The function 21 key */
+ IME_KEY_F22 = 0xFFD3, /**< The function 22 key */
+ IME_KEY_F23 = 0xFFD4, /**< The function 23 key */
+ IME_KEY_F24 = 0xFFD5, /**< The function 24 key */
+ IME_KEY_F25 = 0xFFD6, /**< The function 25 key */
+ IME_KEY_F26 = 0xFFD7, /**< The function 26 key */
+ IME_KEY_F27 = 0xFFD8, /**< The function 27 key */
+ IME_KEY_F28 = 0xFFD9, /**< The function 28 key */
+ IME_KEY_F29 = 0xFFDA, /**< The function 29 key */
+ IME_KEY_F30 = 0xFFDB, /**< The function 30 key */
+ IME_KEY_F31 = 0xFFDC, /**< The function 31 key */
+ IME_KEY_F32 = 0xFFDD, /**< The function 32 key */
+ IME_KEY_F33 = 0xFFDE, /**< The function 33 key */
+ IME_KEY_F34 = 0xFFDF, /**< The function 34 key */
+ IME_KEY_F35 = 0xFFE0, /**< The function 35 key */
/* Modifier keys */
- IME_KEY_Shift_L = 0xFFE1, /**< The left shift key */
- IME_KEY_Shift_R = 0xFFE2, /**< The right shift key */
- IME_KEY_Control_L = 0xFFE3, /**< The left control key */
- IME_KEY_Control_R = 0xFFE4, /**< The right control key */
- IME_KEY_Caps_Lock = 0xFFE5, /**< The caps lock key */
- IME_KEY_Shift_Lock = 0xFFE6, /**< The shift lock key */
+ IME_KEY_Shift_L = 0xFFE1, /**< The left shift key */
+ IME_KEY_Shift_R = 0xFFE2, /**< The right shift key */
+ IME_KEY_Control_L = 0xFFE3, /**< The left control key */
+ IME_KEY_Control_R = 0xFFE4, /**< The right control key */
+ IME_KEY_Caps_Lock = 0xFFE5, /**< The caps lock key */
+ IME_KEY_Shift_Lock = 0xFFE6, /**< The shift lock key */
- IME_KEY_Meta_L = 0xFFE7, /**< The left meta key */
- IME_KEY_Meta_R = 0xFFE8, /**< The right meta key */
- IME_KEY_Alt_L = 0xFFE9, /**< The left alt key */
- IME_KEY_Alt_R = 0xFFEA, /**< The right alt key */
- IME_KEY_Super_L = 0xFFEB, /**< The left super key */
- IME_KEY_Super_R = 0xFFEC, /**< The right super key */
- IME_KEY_Hyper_L = 0xFFED, /**< The left hyper key */
- IME_KEY_Hyper_R = 0xFFEE, /**< The right hyper key */
+ IME_KEY_Meta_L = 0xFFE7, /**< The left meta key */
+ IME_KEY_Meta_R = 0xFFE8, /**< The right meta key */
+ IME_KEY_Alt_L = 0xFFE9, /**< The left alt key */
+ IME_KEY_Alt_R = 0xFFEA, /**< The right alt key */
+ IME_KEY_Super_L = 0xFFEB, /**< The left super key */
+ IME_KEY_Super_R = 0xFFEC, /**< The right super key */
+ IME_KEY_Hyper_L = 0xFFED, /**< The left hyper key */
+ IME_KEY_Hyper_R = 0xFFEE, /**< The right hyper key */
/* Latin 1 */
- IME_KEY_space = 0x020, /**< The space key */
- IME_KEY_exclam = 0x021, /**< The exclamation key */
- IME_KEY_quotedbl = 0x022, /**< The quotedbl key */
- IME_KEY_numbersign = 0x023, /**< The number sign key */
- IME_KEY_dollar = 0x024, /**< The dollar key */
- IME_KEY_percent = 0x025, /**< The percent key */
- IME_KEY_ampersand = 0x026, /**< The ampersand key */
- IME_KEY_apostrophe = 0x027, /**< The apostrophe key */
- IME_KEY_parenleft = 0x028, /**< The parenleft key */
- IME_KEY_parenright = 0x029, /**< The parenright key */
- IME_KEY_asterisk = 0x02a, /**< The asterisk key */
- IME_KEY_plus = 0x02b, /**< The plus key */
- IME_KEY_comma = 0x02c, /**< The comma key */
- IME_KEY_minus = 0x02d, /**< The minus key */
- IME_KEY_period = 0x02e, /**< The period key */
- IME_KEY_slash = 0x02f, /**< The slash key */
- IME_KEY_0 = 0x030, /**< The 0 key */
- IME_KEY_1 = 0x031, /**< The 1 key */
- IME_KEY_2 = 0x032, /**< The 2 key */
- IME_KEY_3 = 0x033, /**< The 3 key */
- IME_KEY_4 = 0x034, /**< The 4 key */
- IME_KEY_5 = 0x035, /**< The 5 key */
- IME_KEY_6 = 0x036, /**< The 6 key */
- IME_KEY_7 = 0x037, /**< The 7 key */
- IME_KEY_8 = 0x038, /**< The 8 key */
- IME_KEY_9 = 0x039, /**< The 9 key */
- IME_KEY_colon = 0x03a, /**< The colon key */
- IME_KEY_semicolon = 0x03b, /**< The semicolon key */
- IME_KEY_less = 0x03c, /**< The less key */
- IME_KEY_equal = 0x03d, /**< The equal key */
- IME_KEY_greater = 0x03e, /**< The greater key */
- IME_KEY_question = 0x03f, /**< The question key */
- IME_KEY_at = 0x040, /**< The at key */
- IME_KEY_A = 0x041, /**< The A key */
- IME_KEY_B = 0x042, /**< The B key */
- IME_KEY_C = 0x043, /**< The C key */
- IME_KEY_D = 0x044, /**< The D key */
- IME_KEY_E = 0x045, /**< The E key */
- IME_KEY_F = 0x046, /**< The F key */
- IME_KEY_G = 0x047, /**< The G key */
- IME_KEY_H = 0x048, /**< The H key */
- IME_KEY_I = 0x049, /**< The I key */
- IME_KEY_J = 0x04a, /**< The J key */
- IME_KEY_K = 0x04b, /**< The K key */
- IME_KEY_L = 0x04c, /**< The L key */
- IME_KEY_M = 0x04d, /**< The M key */
- IME_KEY_N = 0x04e, /**< The N key */
- IME_KEY_O = 0x04f, /**< The O key */
- IME_KEY_P = 0x050, /**< The P key */
- IME_KEY_Q = 0x051, /**< The Q key */
- IME_KEY_R = 0x052, /**< The R key */
- IME_KEY_S = 0x053, /**< The S key */
- IME_KEY_T = 0x054, /**< The T key */
- IME_KEY_U = 0x055, /**< The U key */
- IME_KEY_V = 0x056, /**< The V key */
- IME_KEY_W = 0x057, /**< The W key */
- IME_KEY_X = 0x058, /**< The X key */
- IME_KEY_Y = 0x059, /**< The Y key */
- IME_KEY_Z = 0x05a, /**< The Z key */
- IME_KEY_bracketleft = 0x05b, /**< The left bracket key */
- IME_KEY_backslash = 0x05c, /**< The backslash key */
- IME_KEY_bracketright = 0x05d, /**< The right bracket key */
- IME_KEY_asciicircum = 0x05e, /**< The circumflex key */
- IME_KEY_underscore = 0x05f, /**< The underscore key */
- IME_KEY_grave = 0x060, /**< The grave key */
- IME_KEY_a = 0x061, /**< The a key */
- IME_KEY_b = 0x062, /**< The b key */
- IME_KEY_c = 0x063, /**< The c key */
- IME_KEY_d = 0x064, /**< The d key */
- IME_KEY_e = 0x065, /**< The e key */
- IME_KEY_f = 0x066, /**< The f key */
- IME_KEY_g = 0x067, /**< The g key */
- IME_KEY_h = 0x068, /**< The h key */
- IME_KEY_i = 0x069, /**< The i key */
- IME_KEY_j = 0x06a, /**< The j key */
- IME_KEY_k = 0x06b, /**< The k key */
- IME_KEY_l = 0x06c, /**< The l key */
- IME_KEY_m = 0x06d, /**< The m key */
- IME_KEY_n = 0x06e, /**< The n key */
- IME_KEY_o = 0x06f, /**< The o key */
- IME_KEY_p = 0x070, /**< The p key */
- IME_KEY_q = 0x071, /**< The q key */
- IME_KEY_r = 0x072, /**< The r key */
- IME_KEY_s = 0x073, /**< The s key */
- IME_KEY_t = 0x074, /**< The t key */
- IME_KEY_u = 0x075, /**< The u key */
- IME_KEY_v = 0x076, /**< The v key */
- IME_KEY_w = 0x077, /**< The w key */
- IME_KEY_x = 0x078, /**< The x key */
- IME_KEY_y = 0x079, /**< The y key */
- IME_KEY_z = 0x07a, /**< The z key */
- IME_KEY_braceleft = 0x07b, /**< The left brace key */
- IME_KEY_bar = 0x07c, /**< The bar key */
- IME_KEY_braceright = 0x07d, /**< The right brace key */
- IME_KEY_asciitilde = 0x07e, /**< The tilde key */
+ IME_KEY_space = 0x020, /**< The space key */
+ IME_KEY_exclam = 0x021, /**< The exclamation key */
+ IME_KEY_quotedbl = 0x022, /**< The quotedbl key */
+ IME_KEY_numbersign = 0x023, /**< The number sign key */
+ IME_KEY_dollar = 0x024, /**< The dollar key */
+ IME_KEY_percent = 0x025, /**< The percent key */
+ IME_KEY_ampersand = 0x026, /**< The ampersand key */
+ IME_KEY_apostrophe = 0x027, /**< The apostrophe key */
+ IME_KEY_parenleft = 0x028, /**< The parenleft key */
+ IME_KEY_parenright = 0x029, /**< The parenright key */
+ IME_KEY_asterisk = 0x02a, /**< The asterisk key */
+ IME_KEY_plus = 0x02b, /**< The plus key */
+ IME_KEY_comma = 0x02c, /**< The comma key */
+ IME_KEY_minus = 0x02d, /**< The minus key */
+ IME_KEY_period = 0x02e, /**< The period key */
+ IME_KEY_slash = 0x02f, /**< The slash key */
+ IME_KEY_0 = 0x030, /**< The 0 key */
+ IME_KEY_1 = 0x031, /**< The 1 key */
+ IME_KEY_2 = 0x032, /**< The 2 key */
+ IME_KEY_3 = 0x033, /**< The 3 key */
+ IME_KEY_4 = 0x034, /**< The 4 key */
+ IME_KEY_5 = 0x035, /**< The 5 key */
+ IME_KEY_6 = 0x036, /**< The 6 key */
+ IME_KEY_7 = 0x037, /**< The 7 key */
+ IME_KEY_8 = 0x038, /**< The 8 key */
+ IME_KEY_9 = 0x039, /**< The 9 key */
+ IME_KEY_colon = 0x03a, /**< The colon key */
+ IME_KEY_semicolon = 0x03b, /**< The semicolon key */
+ IME_KEY_less = 0x03c, /**< The less key */
+ IME_KEY_equal = 0x03d, /**< The equal key */
+ IME_KEY_greater = 0x03e, /**< The greater key */
+ IME_KEY_question = 0x03f, /**< The question key */
+ IME_KEY_at = 0x040, /**< The at key */
+ IME_KEY_A = 0x041, /**< The A key */
+ IME_KEY_B = 0x042, /**< The B key */
+ IME_KEY_C = 0x043, /**< The C key */
+ IME_KEY_D = 0x044, /**< The D key */
+ IME_KEY_E = 0x045, /**< The E key */
+ IME_KEY_F = 0x046, /**< The F key */
+ IME_KEY_G = 0x047, /**< The G key */
+ IME_KEY_H = 0x048, /**< The H key */
+ IME_KEY_I = 0x049, /**< The I key */
+ IME_KEY_J = 0x04a, /**< The J key */
+ IME_KEY_K = 0x04b, /**< The K key */
+ IME_KEY_L = 0x04c, /**< The L key */
+ IME_KEY_M = 0x04d, /**< The M key */
+ IME_KEY_N = 0x04e, /**< The N key */
+ IME_KEY_O = 0x04f, /**< The O key */
+ IME_KEY_P = 0x050, /**< The P key */
+ IME_KEY_Q = 0x051, /**< The Q key */
+ IME_KEY_R = 0x052, /**< The R key */
+ IME_KEY_S = 0x053, /**< The S key */
+ IME_KEY_T = 0x054, /**< The T key */
+ IME_KEY_U = 0x055, /**< The U key */
+ IME_KEY_V = 0x056, /**< The V key */
+ IME_KEY_W = 0x057, /**< The W key */
+ IME_KEY_X = 0x058, /**< The X key */
+ IME_KEY_Y = 0x059, /**< The Y key */
+ IME_KEY_Z = 0x05a, /**< The Z key */
+ IME_KEY_bracketleft = 0x05b, /**< The left bracket key */
+ IME_KEY_backslash = 0x05c, /**< The backslash key */
+ IME_KEY_bracketright = 0x05d, /**< The right bracket key */
+ IME_KEY_asciicircum = 0x05e, /**< The circumflex key */
+ IME_KEY_underscore = 0x05f, /**< The underscore key */
+ IME_KEY_grave = 0x060, /**< The grave key */
+ IME_KEY_a = 0x061, /**< The a key */
+ IME_KEY_b = 0x062, /**< The b key */
+ IME_KEY_c = 0x063, /**< The c key */
+ IME_KEY_d = 0x064, /**< The d key */
+ IME_KEY_e = 0x065, /**< The e key */
+ IME_KEY_f = 0x066, /**< The f key */
+ IME_KEY_g = 0x067, /**< The g key */
+ IME_KEY_h = 0x068, /**< The h key */
+ IME_KEY_i = 0x069, /**< The i key */
+ IME_KEY_j = 0x06a, /**< The j key */
+ IME_KEY_k = 0x06b, /**< The k key */
+ IME_KEY_l = 0x06c, /**< The l key */
+ IME_KEY_m = 0x06d, /**< The m key */
+ IME_KEY_n = 0x06e, /**< The n key */
+ IME_KEY_o = 0x06f, /**< The o key */
+ IME_KEY_p = 0x070, /**< The p key */
+ IME_KEY_q = 0x071, /**< The q key */
+ IME_KEY_r = 0x072, /**< The r key */
+ IME_KEY_s = 0x073, /**< The s key */
+ IME_KEY_t = 0x074, /**< The t key */
+ IME_KEY_u = 0x075, /**< The u key */
+ IME_KEY_v = 0x076, /**< The v key */
+ IME_KEY_w = 0x077, /**< The w key */
+ IME_KEY_x = 0x078, /**< The x key */
+ IME_KEY_y = 0x079, /**< The y key */
+ IME_KEY_z = 0x07a, /**< The z key */
+ IME_KEY_braceleft = 0x07b, /**< The left brace key */
+ IME_KEY_bar = 0x07c, /**< The bar key */
+ IME_KEY_braceright = 0x07d, /**< The right brace key */
+ IME_KEY_asciitilde = 0x07e, /**< The tilde key */
} ime_key_code_e;
+
/**
- * @brief Enumeration of the key masks.
- *
- * The key masks indicate which modifier keys is pressed down during the keyboard hit.
- * The special IME_KEY_MASK_RELEASED indicates the key release event.
- *
+ * @brief Enumeration for the key masks.
+ * The key masks indicate which modifier keys is pressed down during the keyboard hit.
+ * The special IME_KEY_MASK_RELEASED indicates the key release event.
* @since_tizen @if MOBILE 2.4 @else 3.0 @endif
*/
typedef enum {
- IME_KEY_MASK_PRESSED = 0, /**< Key press event without modifier key */
- IME_KEY_MASK_SHIFT = (1<<0), /**< The Shift key is pressed down */
+ IME_KEY_MASK_PRESSED = 0, /**< Key press event without modifier key */
+ IME_KEY_MASK_SHIFT = (1<<0), /**< The Shift key is pressed down */
IME_KEY_MASK_CAPSLOCK = (1<<1), /**< The CapsLock key is pressed down */
- IME_KEY_MASK_CONTROL = (1<<2), /**< The Control key is pressed down */
- IME_KEY_MASK_ALT = (1<<3), /**< The Alt key is pressed down */
- IME_KEY_MASK_META = (1<<4), /**< The Meta key is pressed down */
- IME_KEY_MASK_WIN = (1<<5), /**< The Win (between Control and Alt) is pressed down */
- IME_KEY_MASK_HYPER = (1<<6), /**< The Hyper key is pressed down */
- IME_KEY_MASK_NUMLOCK = (1<<7), /**< The NumLock key is pressed down */
+ IME_KEY_MASK_CONTROL = (1<<2), /**< The Control key is pressed down */
+ IME_KEY_MASK_ALT = (1<<3), /**< The Alt key is pressed down */
+ IME_KEY_MASK_META = (1<<4), /**< The Meta key is pressed down */
+ IME_KEY_MASK_WIN = (1<<5), /**< The Win (between Control and Alt) is pressed down */
+ IME_KEY_MASK_HYPER = (1<<6), /**< The Hyper key is pressed down */
+ IME_KEY_MASK_NUMLOCK = (1<<7), /**< The NumLock key is pressed down */
IME_KEY_MASK_RELEASED = (1<<15) /**< Key release event */
} ime_key_mask_e;
+
/**
* @}
*/
+
#endif /* __TIZEN_UIX_INPUTMETHOD_KEYDEF_H__ */
projects / platform / core / api / inputmethod.git / commitdiff