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;
/**
* @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
*
* @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
* @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.
*
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
*
* @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
* @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
*
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
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
*
* @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.
* @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.
* @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.
* @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.
* @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.
* @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.
*
* @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.
*
* @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()
*
* @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()
*
* @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()
* @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.
*
*
* @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().
*
* @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()
*/
* @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()
* @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);
* @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);
* @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()
* @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()
*/
*
* @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()
* @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
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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.
*
* @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()
* @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()
* @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()
* @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.
*
* @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.
*
* @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);
* @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()
*
* @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()
*
* @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().
*
*
* @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.
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
*
* @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.
*
*
* @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);
* @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
*
*
* @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);