From 31a067a1da30e3fa89fecfafeaed9a2cbd07a83d Mon Sep 17 00:00:00 2001 From: "sungwook79.park" Date: Wed, 15 Feb 2017 14:43:05 +0900 Subject: [PATCH] Update header file written in English in include directory Change-Id: I5b13641a0aab5dacabb773ab39946bd334fffee2 Signed-off-by: sungwook79.park --- include/inputmethod_manager.h | 62 ++++++++++++----------------------- 1 file changed, 21 insertions(+), 41 deletions(-) diff --git a/include/inputmethod_manager.h b/include/inputmethod_manager.h index 26f03a1..df2f39f 100755 --- a/include/inputmethod_manager.h +++ b/include/inputmethod_manager.h @@ -17,6 +17,7 @@ #ifndef __TIZEN_UIX_INPUTMETHOD_MANAGER_H__ #define __TIZEN_UIX_INPUTMETHOD_MANAGER_H__ + /** * @file inputmethod_manager.h * @brief This file contains input method manager APIs for input method editor (IME) list and selector settings. @@ -28,14 +29,15 @@ extern "C" { #endif + /** * @addtogroup CAPI_UIX_INPUTMETHOD_MANAGER_MODULE * @{ */ + /** - * @brief Enumeration for input method manager function error - * + * @brief Enumeration for input method manager function error. * @since_tizen @if MOBILE 2.4 @else 3.0 @endif */ typedef enum { @@ -45,116 +47,94 @@ typedef enum { IME_MANAGER_ERROR_OPERATION_FAILED = TIZEN_ERROR_IME | 0x0010, /**< Operation failed */ } ime_manager_error_e; + /** * @brief Requests to open the installed IME list menu. - * * @details This function provides the installed IME list menu for the IME developers who might want to open it to enable their IME. - * * @since_tizen @if MOBILE 2.4 @else 3.0 @endif - * * @privlevel public - * * @privilege %http://tizen.org/privilege/imemanager - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #IME_MANAGER_ERROR_NONE No error * @retval #IME_MANAGER_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed - * * @see ime_manager_show_ime_selector() */ EXPORT_API int ime_manager_show_ime_list(void); + /** * @brief Requests to open the IME selector menu. - * * @details This function provides the IME selector menu for the IME or other application developers who might want to change the default IME. - * * @since_tizen @if MOBILE 2.4 @else 3.0 @endif - * * @privlevel public - * * @privilege %http://tizen.org/privilege/imemanager - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #IME_MANAGER_ERROR_NONE No error * @retval #IME_MANAGER_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed - * * @see ime_manager_show_ime_list() */ EXPORT_API int ime_manager_show_ime_selector(void); + /** * @brief Checks if the specific IME is enabled or disabled in the system keyboard setting. - * * @details The IME developers can use this function to check their IME is enabled or not. - * * @since_tizen @if MOBILE 2.4 @else 3.0 @endif - * * @privlevel public - * * @privilege %http://tizen.org/privilege/imemanager - * * @param[in] app_id The application ID of the IME * @param[out] enabled The On (enabled) and Off (disabled) state of the IME - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #IME_MANAGER_ERROR_NONE No error * @retval #IME_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IME_MANAGER_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed - * * @see ime_manager_show_ime_list() */ EXPORT_API int ime_manager_is_ime_enabled(const char *app_id, bool *enabled); + /** * @brief Checks which IME is the current activated (selected) IME. - * - * @remarks @a app_id must be released using free(). - * * @since_tizen @if MOBILE 2.4 @else 3.0 @endif - * + * @remarks @a app_id must be released using free(). * @privlevel public - * * @privilege %http://tizen.org/privilege/imemanager - * * @param[out] app_id The application ID of the active IME - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #IME_MANAGER_ERROR_NONE No error * @retval #IME_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #IME_MANAGER_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function * @retval #IME_MANAGER_ERROR_OPERATION_FAILED Operation failed - * * @see ime_manager_show_ime_selector() */ EXPORT_API int ime_manager_get_active_ime(char **app_id); + /** * @brief Gets the number of IMEs which are enabled (usable). - * * @since_tizen 3.0 - * * @remarks The specific error code can be obtained using the get_last_result() method. * Error codes are described in Exception section. - * * @privlevel public - * * @privilege %http://tizen.org/privilege/imemanager - * - * @return The @a number of enabled IMEs on success, otherwise @c 0. - * + * @return The @a number of enabled IMEs on success, + otherwise @c 0 * @exception IME_MANAGER_ERROR_NONE Successful * @exception IME_MANAGER_ERROR_PERMISSION_DENIED The application does not have the privilege to call this function * @exception IME_MANAGER_ERROR_OPERATION_FAILED Operation failed - * * @see ime_manager_is_ime_enabled() * @see ime_manager_show_ime_selector() */ EXPORT_API int ime_manager_get_enabled_ime_count(void); + /** * @} */ -- 2.34.1