From 997958f3e62c10602886e70a1de1f123da48390a Mon Sep 17 00:00:00 2001 From: InHong Han Date: Thu, 20 Jun 2019 19:47:13 +0900 Subject: [PATCH] Update API description Change-Id: Ibfe65ed638623d5e69ada2056fbc6df05c7feabf --- include/inputmethod.h | 215 +++++++++++++++++++++++++------------------------- 1 file changed, 107 insertions(+), 108 deletions(-) diff --git a/include/inputmethod.h b/include/inputmethod.h index 8e94af9..60d2f39 100644 --- a/include/inputmethod.h +++ b/include/inputmethod.h @@ -48,7 +48,7 @@ typedef enum { IME_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ IME_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ IME_ERROR_NO_CALLBACK_FUNCTION = TIZEN_ERROR_IME | 0x0001, /**< Necessary callback function is not set */ - IME_ERROR_NOT_RUNNING = TIZEN_ERROR_IME | 0x0002, /**< IME main loop isn't started yet */ + IME_ERROR_NOT_RUNNING = TIZEN_ERROR_IME | 0x0002, /**< IME main loop is not started yet */ IME_ERROR_OPERATION_FAILED = TIZEN_ERROR_IME | 0x0003, /**< Operation failed */ IME_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< out of memory */ } ime_error_e; @@ -594,9 +594,8 @@ typedef bool (*ime_process_key_event_cb)(ime_key_code_e key_code, ime_key_mask_e /** * @brief Called when a key event is received from external devices or ime_send_key_event(). - * Provides the key code. * - * @details This function processes the key event with keycode before an associated text input UI control does. + * @details This function processes a key event with a keycode before an associated UI control for the text input deals with the key event. * * @since_tizen 5.5 * @@ -605,7 +604,7 @@ typedef bool (*ime_process_key_event_cb)(ime_key_code_e key_code, ime_key_mask_e * @privilege %http://tizen.org/privilege/ime * * @remarks If the key event is from the external device, @a dev_info will have its name, class and subclass information. - * @a dev_info should not be released by the application. The platform manages the handle and will release it when ime_process_key_event_with_keycode_cb() exits. + * @a dev_info should not be released by the application. The platform manages the handle, the handle is released when ime_process_key_event_with_keycode_cb() exits. * * @param[in] key_code The X11 key code to be sent * @param[in] key_sym The key symbol to be sent @@ -613,7 +612,7 @@ typedef bool (*ime_process_key_event_cb)(ime_key_code_e key_code, ime_key_mask_e * @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 was processed, otherwise the event was not processed and was forwarded to the client application. + * @return @c true if the event was processed, otherwise @c false. When @c false returns, the event was not processed and was forwarded to the client application. * * @pre The callback should be registered using ime_event_set_process_key_event_with_keycode_cb() function. * @@ -772,7 +771,7 @@ typedef void (*ime_prediction_hint_set_cb)(const char *prediction_hint, void *us typedef void (*ime_mime_type_set_request_cb)(const char *mime_type, void *user_data); /** - * @brief Called with the prediction hint key and value which can be delivered to the input panel. + * @brief Called to set key-value pairs of predicting messages to deliver to the input panel. * * @since_tizen 5.0 * @@ -781,7 +780,7 @@ typedef void (*ime_mime_type_set_request_cb)(const char *mime_type, void *user_d * @privilege %http://tizen.org/privilege/ime * * @remarks @a key and @a value is valid only in the callback. To use outside the callback, make a copy. - * This function is used by the applications to deliver the prediction hint data message to the input panel. + * This function is used by applications to deliver predicted hint messages to the input panel. * * @param[in] key The prediction hint key to be set to the input panel * @param[in] value The prediction hint value to be set to the input panel @@ -834,7 +833,7 @@ typedef struct { * @return 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_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 * @@ -942,7 +941,7 @@ int ime_run(ime_callback_s *basic_cb, void *user_data); * @return 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_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 the IME application's main loop. @@ -970,7 +969,7 @@ int ime_event_set_focus_in_cb(ime_focus_in_cb callback_func, void *user_data); * @return 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_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 the IME application's main loop. @@ -998,7 +997,7 @@ int ime_event_set_focus_out_cb(ime_focus_out_cb callback_func, void *user_data); * @return 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_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 the IME application's main loop. @@ -1026,7 +1025,7 @@ int ime_event_set_surrounding_text_updated_cb(ime_surrounding_text_updated_cb ca * @return 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_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 the IME application's main loop. @@ -1054,7 +1053,7 @@ int ime_event_set_input_context_reset_cb(ime_input_context_reset_cb callback_fun * @return 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_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 the IME application's main loop. @@ -1082,7 +1081,7 @@ int ime_event_set_cursor_position_updated_cb(ime_cursor_position_updated_cb call * @return 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_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 the IME application's main loop. @@ -1110,7 +1109,7 @@ int ime_event_set_language_requested_cb(ime_language_requested_cb callback_func, * @return 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_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 the IME application's main loop. @@ -1138,7 +1137,7 @@ int ime_event_set_language_set_cb(ime_language_set_cb callback_func, void *user_ * @return 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_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 the IME application's main loop. @@ -1167,7 +1166,7 @@ int ime_event_set_imdata_set_cb(ime_imdata_set_cb callback_func, void *user_data * @return 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_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 the IME application's main loop. @@ -1196,7 +1195,7 @@ int ime_event_set_imdata_requested_cb(ime_imdata_requested_cb callback_func, voi * @return 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_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 the IME application's main loop. @@ -1224,7 +1223,7 @@ int ime_event_set_layout_set_cb(ime_layout_set_cb callback_func, void *user_data * @return 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_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 the IME application's main loop. @@ -1252,7 +1251,7 @@ int ime_event_set_return_key_type_set_cb(ime_return_key_type_set_cb callback_fun * @return 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_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 the IME application's main loop. @@ -1280,7 +1279,7 @@ int ime_event_set_return_key_state_set_cb(ime_return_key_state_set_cb callback_f * @return 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_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 the IME application's main loop. @@ -1308,7 +1307,7 @@ int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func, * @return 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_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 the IME application's main loop. @@ -1363,7 +1362,7 @@ int ime_event_set_geometry_requested_cb(ime_geometry_requested_cb callback_func, int ime_event_set_process_key_event_cb(ime_process_key_event_cb callback_func, void *user_data); /** - * @brief Sets key event callback function for keycode. + * @brief Sets @c process_key_event_with_keycode callback function to handle the key event with a keycode. * * @since_tizen 5.5 * @@ -1380,7 +1379,7 @@ int ime_event_set_process_key_event_cb(ime_process_key_event_cb callback_func, v * @return 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_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 the IME application's main loop. @@ -1408,7 +1407,7 @@ int ime_event_set_process_key_event_with_keycode_cb(ime_process_key_event_with_k * @return 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_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 the IME application's main loop. @@ -1436,7 +1435,7 @@ int ime_event_set_display_language_changed_cb(ime_display_language_changed_cb ca * @return 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_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 the IME application's main loop. @@ -1464,7 +1463,7 @@ int ime_event_set_rotation_degree_changed_cb(ime_rotation_degree_changed_cb call * @return 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_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 the IME application's main loop. @@ -1491,7 +1490,7 @@ int ime_event_set_accessibility_state_changed_cb(ime_accessibility_state_changed * @return 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_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 the IME application's main loop. @@ -1518,7 +1517,7 @@ int ime_event_set_option_window_created_cb(ime_option_window_created_cb callback * @return 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_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 the IME application's main loop. @@ -1547,8 +1546,8 @@ int ime_event_set_option_window_destroyed_cb(ime_option_window_destroyed_cb call * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not 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. * @@ -1572,8 +1571,8 @@ int ime_send_key_event(ime_key_code_e keycode, ime_key_mask_e keymask, bool forw * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_show_preedit_string() * @see ime_hide_preedit_string() @@ -1592,8 +1591,8 @@ int ime_commit_string(const char *str); * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_commit_string() * @see ime_hide_preedit_string() @@ -1612,8 +1611,8 @@ int ime_show_preedit_string(void); * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_commit_string() * @see ime_show_preedit_string() @@ -1638,8 +1637,8 @@ int ime_hide_preedit_string(void); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post This function is supposed to be followed by the ime_show_preedit_string() function. * @@ -1698,9 +1697,9 @@ int ime_update_preedit_string(const char *str, Eina_List *attrs); * * @return 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_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_NOT_RUNNING IME main loop is not started yet * * @pre The ime_surrounding_text_updated_cb() callback function MUST be set by ime_event_set_surrounding_text_updated_cb(). * @@ -1727,8 +1726,8 @@ int ime_request_surrounding_text(int maxlen_before, int maxlen_after); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_request_surrounding_text() */ @@ -1753,8 +1752,8 @@ int ime_delete_surrounding_text(int offset, int len); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * @retval #IME_ERROR_OUT_OF_MEMORY Failed to obtain text due to out of memory * * @see ime_delete_surrounding_text() @@ -1776,8 +1775,8 @@ int ime_get_surrounding_text(int maxlen_before, int maxlen_after, char **text, i * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet */ int ime_set_selection(int start, int end); @@ -1800,8 +1799,8 @@ int ime_set_selection(int start, int end); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet */ int ime_get_selected_text(char **text); @@ -1820,8 +1819,8 @@ int ime_get_selected_text(char **text); * @return The input panel main window object on success, otherwise NULL * * @exception #IME_ERROR_NONE Successful - * @exception #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function - * @exception #IME_ERROR_NOT_RUNNING IME main loop isn't started yet + * @exception #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @exception #IME_ERROR_NOT_RUNNING IME main loop is not started yet * @exception #IME_ERROR_OPERATION_FAILED Operation failed * * @see get_last_result() @@ -1849,8 +1848,8 @@ Evas_Object* ime_get_main_window(void); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_create_cb() */ @@ -1871,9 +1870,9 @@ int ime_set_size(int portrait_width, int portrait_height, int landscape_width, i * * @return 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_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_NOT_RUNNING IME main loop is not started yet * @retval #IME_ERROR_OPERATION_FAILED Operation failed * * @pre The ime_option_window_created_cb() and ime_option_window_destroyed_cb() @@ -1907,9 +1906,9 @@ int ime_create_option_window(void); * @return 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_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_NOT_RUNNING IME main loop is not 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 @@ -1942,8 +1941,8 @@ int ime_destroy_option_window(Evas_Object *window); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -1970,8 +1969,8 @@ int ime_context_get_layout(ime_context_h context, Ecore_IMF_Input_Panel_Layout * * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -1998,8 +1997,8 @@ int ime_context_get_layout_variation(ime_context_h context, ime_layout_variation * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2026,8 +2025,8 @@ int ime_context_get_cursor_position(ime_context_h context, int *cursor_pos); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2053,8 +2052,8 @@ int ime_context_get_autocapital_type(ime_context_h context, Ecore_IMF_Autocapita * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2082,8 +2081,8 @@ int ime_context_get_return_key_type(ime_context_h context, Ecore_IMF_Input_Panel * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2111,8 +2110,8 @@ int ime_context_get_return_key_state(ime_context_h context, bool *return_key_sta * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2141,8 +2140,8 @@ int ime_context_get_prediction_mode(ime_context_h context, bool *prediction_mode * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2171,8 +2170,8 @@ int ime_context_get_password_mode(ime_context_h context, bool *password_mode); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2198,8 +2197,8 @@ int ime_context_get_input_hint(ime_context_h context, Ecore_IMF_Input_Hints *inp * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2225,8 +2224,8 @@ int ime_context_get_bidi_direction(ime_context_h context, Ecore_IMF_BiDi_Directi * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @post Input panel UI should be drawn or operated by this information accordingly. * @@ -2251,8 +2250,8 @@ int ime_context_get_language(ime_context_h context, Ecore_IMF_Input_Panel_Lang * * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_process_key_event_cb() * @see ime_device_info_get_class() @@ -2275,8 +2274,8 @@ int ime_device_info_get_name(ime_device_info_h dev_info, char **dev_name); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_process_key_event_cb() * @see ime_device_info_get_name() @@ -2298,8 +2297,8 @@ int ime_device_info_get_class(ime_device_info_h dev_info, Ecore_IMF_Device_Class * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_process_key_event_cb() * @see ime_device_info_get_name() @@ -2325,7 +2324,7 @@ int ime_device_info_get_subclass(ime_device_info_h dev_info, Ecore_IMF_Device_Su * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. * * @post The ime_run() function should be called to start the IME application's main loop. * @@ -2352,7 +2351,7 @@ int ime_event_set_prediction_hint_set_cb(ime_prediction_hint_set_cb callback_fun * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. * * @post The ime_run() function should be called to start the IME application's main loop. * @@ -2378,8 +2377,8 @@ int ime_event_set_mime_type_set_request_cb(ime_mime_type_set_request_cb callback * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet */ int ime_send_private_command(const char *command); @@ -2399,8 +2398,8 @@ int ime_send_private_command(const char *command); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_mime_type_set_request_cb() * @see ime_event_set_mime_type_set_request_cb() @@ -2420,8 +2419,8 @@ int ime_commit_content(const char *content, const char *description, const char * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_set_floating_drag_start() * @see ime_set_floating_drag_end() @@ -2441,8 +2440,8 @@ int ime_set_floating_mode(bool floating_mode); * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @pre The floating mode was turned on with ime_set_floating_mode(). * @@ -2466,8 +2465,8 @@ int ime_set_floating_drag_start(void); * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @pre The floating mode was turned on with ime_set_floating_mode(). * @pre ime_set_floating_drag_start() was called before. @@ -2478,7 +2477,7 @@ int ime_set_floating_drag_start(void); int ime_set_floating_drag_end(void); /** - * @brief Sets prediction hint data event callback function. + * @brief Sets a callback function to give a hint about predicted words. * * @since_tizen 5.0 * @@ -2489,13 +2488,13 @@ int ime_set_floating_drag_end(void); * @remarks The ime_prediction_hint_data_set_cb() callback function is called to provide the prediction * hint key and value which can be delivered to the input panel. * - * @param[in] callback_func The prediction hint event callback function + * @param[in] callback_func The callback function to give hints * @param[in] user_data User data to be passed to the callback function * * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. * * @post The ime_run() function should be called to start the IME application's main loop. * @@ -2515,8 +2514,8 @@ int ime_event_set_prediction_hint_data_set_cb(ime_prediction_hint_data_set_cb ca * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet */ int ime_request_hide(void); @@ -2535,15 +2534,15 @@ int ime_request_hide(void); * @return 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_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet * * @see ime_event_type_e */ int ime_update_input_panel_event(ime_event_type_e type, unsigned int value); /** - * @brief Sets the candidate visibility state. + * @brief Enables whether candidate strings show or not. * * @since_tizen 5.5 * @@ -2551,12 +2550,12 @@ int ime_update_input_panel_event(ime_event_type_e type, unsigned int value); * * @privilege %http://tizen.org/privilege/ime * - * @param[in] visible @c true - show candidate string, @c false - hide candidate string + * @param[in] visible @c true if candidate strings show, @c false otherwise. * * @return 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 + * @retval #IME_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function. + * @retval #IME_ERROR_NOT_RUNNING IME main loop is not started yet */ int ime_set_candidate_visibility_state(bool visible); -- 2.7.4