diff options
author | mk5004.lee <mk5004.lee@samsung.com> | 2019-10-18 12:59:00 +0900 |
---|---|---|
committer | Junghoon Park <jh9216.park@samsung.com> | 2020-03-05 05:47:23 +0000 |
commit | b3b0ebd665a3a5f966ca2bb282d9da18192d5e22 (patch) | |
tree | 3627d251a33f6947e4c9fc00d384f7d5765bb8d5 | |
parent | 21f3502ce6cfa94aafeba82841437aa848641b39 (diff) | |
download | widget-service-b3b0ebd665a3a5f966ca2bb282d9da18192d5e22.tar.gz widget-service-b3b0ebd665a3a5f966ca2bb282d9da18192d5e22.tar.bz2 widget-service-b3b0ebd665a3a5f966ca2bb282d9da18192d5e22.zip |
Update doxygen
Change-Id: Ia24bf0ab4e77795f052e0206d57f225a9b414280
Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>
-rw-r--r-- | include/widget_service.h | 314 |
1 files changed, 193 insertions, 121 deletions
diff --git a/include/widget_service.h b/include/widget_service.h index 4c9314a..e1421e2 100644 --- a/include/widget_service.h +++ b/include/widget_service.h @@ -65,7 +65,7 @@ typedef enum widget_size_type { */ typedef enum widget_event_type { WIDGET_EVENT_WIDGET_UPDATED = 0, /**< Contents of the given widget is updated */ - WIDGET_EVENT_WIDGET_EXTRA_UPDATED = 1, + WIDGET_EVENT_WIDGET_EXTRA_UPDATED = 1, /**< widget extra is updated */ WIDGET_EVENT_CREATED = 4, /**< A new widget is created */ WIDGET_EVENT_DELETED = 5, /**< A widget is deleted */ WIDGET_EVENT_PERIOD_CHANGED = 8, /**< Update period is changed */ @@ -98,10 +98,12 @@ typedef enum widget_event_type { * @return @c 0 on success, * otherwise a negative error value * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter * @see widget_size_type() * @see widget_service_get_size_type() */ -extern int widget_service_get_size(widget_size_type_e type, int *width, int *height); +int widget_service_get_size(widget_size_type_e type, int *width, int *height); /** @@ -128,11 +130,13 @@ extern int widget_service_get_size(widget_size_type_e type, int *width, int *hei * @param[out] size_type Widget size type\n * @return @c 0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter was given * @see widget_size_type() * @see widget_service_get_size() */ -extern int widget_service_get_size_type(int width, int height, widget_size_type_e *size_type); +int widget_service_get_size_type(int width, int height, widget_size_type_e *size_type); /** @@ -149,18 +153,21 @@ extern int widget_service_get_size_type(int width, int height, widget_size_type_ * @param[out] need_of_mouse_event The need of mouse event * @return 0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter was given * @retval #WIDGET_ERROR_IO_ERROR Some error occurs on opening DB file * @see widget_size_type_e * @see widget_service_get_need_of_touch_effect() * @see widget_service_get_need_of_frame() */ -extern int widget_service_get_need_of_mouse_event(const char *widget_id, widget_size_type_e size_type, bool *need_of_mouse_event); +int widget_service_get_need_of_mouse_event(const char *widget_id, widget_size_type_e size_type, bool *need_of_mouse_event); /** * @brief Gets the need of touch effect for the given widget. - * @details This API gets the need of touch effect for the given widget from database.\n + * @details This function gets the need of touch effect for the given widget from database.\n * The value of the need of touch effect means: \n * true : A viewer is required to make the touch effect when a user clicks the widget, but it is just a recommendation.\n * false : A viewer is not required to make the touch effect, the box will make the touch effect itself. @@ -172,18 +179,21 @@ extern int widget_service_get_need_of_mouse_event(const char *widget_id, widget_ * @param[out] need_of_touch_event the need of touch effect * @return @c 0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter was given * @retval #WIDGET_ERROR_IO_ERROR Some error occurs on opening DB file * @see widget_size_type_e * @see widget_service_get_need_of_mouse_event() * @see widget_service_get_need_of_frame() */ -extern int widget_service_get_need_of_touch_effect(const char *widget_id, widget_size_type_e size_type, bool *need_of_touch_event); +int widget_service_get_need_of_touch_effect(const char *widget_id, widget_size_type_e size_type, bool *need_of_touch_event); /** * @brief Gets the need of decoration frame for the given widget. - * @details This API gets the need of decoration frame for the given widget from database.\n + * @details This function gets the need of decoration frame for the given widget from database.\n * The value of the need of touch effect means: \n * true : The viewer should make decoration frame outside of the widget. * false : No need to make decoration frame. @@ -195,12 +205,15 @@ extern int widget_service_get_need_of_touch_effect(const char *widget_id, widget * @param[out] need_of_frame the need of decoration frame * @return @c 0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter was given * @retval #WIDGET_ERROR_IO_ERROR Some error occurs on opening DB file * @see widget_service_get_need_of_mouse_event() * @see widget_service_get_need_of_touch_effect() */ -extern int widget_service_get_need_of_frame(const char *widget_id, widget_size_type_e size_type, bool *need_of_frame); +int widget_service_get_need_of_frame(const char *widget_id, widget_size_type_e size_type, bool *need_of_frame); /** @@ -212,15 +225,16 @@ extern int widget_service_get_need_of_frame(const char *widget_id, widget_size_t * @param[in] force 1 If you want to update your widget even if the provider is paused or 0. 0 is default * @return @c 0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_CANCELED Provider is paused, so this update request is canceled.(ignored), if you want to make update forcely, use force=1 * @retval #WIDGET_ERROR_OUT_OF_MEMORY Memory is not enough to make request * @retval #WIDGET_ERROR_FAULT Failed to create a request packet - * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIDGET_ERROR_NONE Successfully requested - * @see widget_service_trigger_update() + * @retval #WIDGET_ERROR_NOT_EXIST Not exists */ -extern int widget_service_trigger_update(const char *widget_id, const char *instance_id, bundle *b, int force); +int widget_service_trigger_update(const char *widget_id, const char *instance_id, bundle *b, int force); /** @@ -232,46 +246,47 @@ extern int widget_service_trigger_update(const char *widget_id, const char *inst * @return @c 0 on success, * otherwise a negative error value * @retval #WIDGET_ERROR_NONE Successfully changed(requested) + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_FAULT Failed to create a request packet - * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIDGET_ERROR_OUT_OF_MEMORY Not enough memory + * @retval #WIDGET_ERROR_NOT_EXIST Not exists */ -extern int widget_service_change_period(const char *widget_id, const char *instance_id, double period); +int widget_service_change_period(const char *widget_id, const char *instance_id, double period); /** - * @brief Callback function for getting result of widget_service_get_widget_list. + * @brief Callback function for getting result of widget_service_get_widget_list(). * @since_tizen 2.3.1 * @param[in] pkgid package id * @param[in] widget_id appid of widget application * @param[in] is_prime will be sent as 1 if the widget is a default widget - * @param[in] data user Data - * @privlevel public - * @privilege %http://tizen.org/privilege/widget.viewer - * @return WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop - * @see #widget_service_get_widget_list + * @param[in] user_data user Data + * @return #WIDGET_ERROR_NONE to continue with the next iteration of the loop, + * other error values to break out of the loop + * @see widget_service_get_widget_list() */ -typedef int (*widget_list_cb)(const char *pkgid, const char *widget_id, int is_prime, void *data); +typedef int (*widget_list_cb)(const char *pkgid, const char *widget_id, int is_prime, void *user_data); /** * @brief Gets a list of all widgets. * @since_tizen 2.3.1 - * @param[in] cb Callback function - * @param[in] data user Data for callback function * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer + * @param[in] cb Callback function + * @param[in] data user Data for callback function * @return @c 0 on success, * otherwise a negative error value - * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_NOT_EXIST Not exists * @retval count Count of widget packages - * @see #widget_service_get_widget_list_by_pkgid - * @see #widget_list_cb + * @see widget_service_get_widget_list_by_pkgid() + * @see widget_list_cb() */ -extern int widget_service_get_widget_list(widget_list_cb cb, void *data); +int widget_service_get_widget_list(widget_list_cb cb, void *data); /** @@ -281,46 +296,52 @@ extern int widget_service_get_widget_list(widget_list_cb cb, void *data); * @privilege %http://tizen.org/privilege/widget.viewer * @remarks Result string should be freed by free(). * @param[in] widget_id appid of widget application - * @return char * type - * @retval @c NULL if it fails to get main application Id (UI-APPID), get_last_result() will returns reason of failure - * @retval appid Main application Id - * @see #get_last_result + * @return Main application Id on success, + * @c NULL if it fails to get main application Id (UI-APPID), get_last_result() will returns reason of failure + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists + * @see get_last_result() */ -extern char *widget_service_get_main_app_id(const char *widget_id); +char *widget_service_get_main_app_id(const char *widget_id); /** - * @brief Callback function for getting result of widget_service_get_widget_list_by_pkgid. + * @brief Callback function for getting result of widget_service_get_widget_list_by_pkgid(). * @since_tizen 2.3.1 - * @param[in] widget_id appid of widget application - * @param[in] is_prime will be sent as 1 if the widget is a default widget - * @param[in] data user Data * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @return WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop - * @see #widget_service_get_widget_list_by_pkgid + * @param[in] widget_id appid of widget application + * @param[in] is_prime will be sent as 1 if the widget is a default widget + * @param[in] user_data user Data + * @return #WIDGET_ERROR_NONE to continue with the next iteration of the loop, + * other error values to break out of the loop + * @see widget_service_get_widget_list_by_pkgid() */ -typedef int (*widget_list_by_pkgid_cb)(const char *widget_id, int is_prime, void *data); +typedef int (*widget_list_by_pkgid_cb)(const char *widget_id, int is_prime, void *user_data); /** * @brief Gets a list of widgets included in the given package ID. * @since_tizen 2.3.1 + * @privlevel public + * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] pkgid Package ID (Not the UI App ID) * @param[in] cb Callback function * @param[in] data Callback data - * @privlevel public - * @privilege %http://tizen.org/privilege/widget.viewer - * @return @c 0 on success, + * @return Count of widget packages on success, * otherwise a negative error value - * @retval int Count of widget packages - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied - * @see #widget_service_get_widget_list - * @see #widget_list_by_pkgid_cb + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @see widget_service_get_widget_list() + * @see widget_list_by_pkgid_cb() */ -extern int widget_service_get_widget_list_by_pkgid(const char *pkgid, widget_list_by_pkgid_cb cb, void *data); +int widget_service_get_widget_list_by_pkgid(const char *pkgid, widget_list_by_pkgid_cb cb, void *data); /** @@ -331,13 +352,19 @@ extern int widget_service_get_widget_list_by_pkgid(const char *pkgid, widget_lis * @privilege %http://tizen.org/privilege/widget.viewer * @remarks Result string should be freed by free(). * @param[in] id Package Id or UI App Id - * @return char * type - * @retval @c NULL Failed to get primary widget id, get_last_result() will returns reason of failure - * @retval widget_id Primary widget Id. + * @return Primary widget Id on success, + * @c NULL Failed to get primary widget id, get_last_result() will returns reason of failure + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @pre Must release returned string manually. * @see widget_service_package_id() */ -extern char *widget_service_get_widget_id(const char *id); +char *widget_service_get_widget_id(const char *id); /** @@ -350,13 +377,19 @@ extern char *widget_service_get_widget_id(const char *id); * @privilege %http://tizen.org/privilege/widget.viewer * @remarks Result string should be freed by free() * @param[in] widget_id appid of widget application - * @return char * type - * @retval @c NULL There is no setup application or error occurred, you can check it using get_last_result() - * @retval appid AppId if exists or @c NULL + * @return AppId on success, + * @c NULL There is no setup application or error occurred, you can check it using get_last_result() + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @post Returned string must be freed manually. * @see get_last_result() */ -extern char *widget_service_get_app_id_of_setup_app(const char *widget_id); +char *widget_service_get_app_id_of_setup_app(const char *widget_id); /** @@ -366,13 +399,19 @@ extern char *widget_service_get_app_id_of_setup_app(const char *widget_id); * @privilege %http://tizen.org/privilege/widget.viewer * @remarks Result string should be freed by free() * @param[in] widget_id appid of widget application - * @return char * type - * @retval appid String which is allocated in the heap - * @retval @c NULL Invalid appid, get_last_result() will return reasons of failure if it fails + * @return appid on success, + * @c NULL Invalid appid, get_last_result() will return reasons of failure if it fails + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @post Returned string must be free'd manually. * @see widget_service_widget_id() */ -extern char *widget_service_get_package_id(const char *widget_id); +char *widget_service_get_package_id(const char *widget_id); /** @@ -383,14 +422,21 @@ extern char *widget_service_get_package_id(const char *widget_id); * @remarks Result string should be freed by free() * @param[in] widget_id appid of widget application * @param[in] lang Locale(en-us, ko-kr, ...), if it is @c NULL, function will use the system locale automatically - * @return char * type - * @retval name If it fails to get name - * @retval @c NULL Allocated heap address, get_last_result() will return reasons of failure if it fails. + * @return name on success, + * @c NULL Allocated heap address, get_last_result() will return reasons of failure if it fails. + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @post Returned string must be freed manually. * @see widget_service_i18n_icon() * @see widget_service_preview() */ -extern char *widget_service_get_name(const char *widget_id, const char *lang); +char *widget_service_get_name(const char *widget_id, const char *lang); /** @@ -402,14 +448,21 @@ extern char *widget_service_get_name(const char *widget_id, const char *lang); * @remarks Result string should be freed by free(). * @param[in] widget_id appid of widget application * @param[in] size_type Widget size type - * @return char * type - * @retval path Preview image path - * @retval @c NULL There is no preview image file, get_last_result() will returns reason of failure if it fails. + * @return Preview image path on success, + * @c NULL There is no preview image file, get_last_result() will returns reason of failure if it fails. + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_OUT_OF_MEMORY Out of memory + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @post Returned string must be freed manually. - * @see #widget_service_get_icon - * @see #widget_service_get_name + * @see widget_service_get_icon() + * @see widget_service_get_name() */ -extern char *widget_service_get_preview_image_path(const char *widget_id, widget_size_type_e size_type); +char *widget_service_get_preview_image_path(const char *widget_id, widget_size_type_e size_type); /** @@ -421,28 +474,41 @@ extern char *widget_service_get_preview_image_path(const char *widget_id, widget * @remarks Result string should be freed by free(). * @param[in] pkgid Package ID of widget application * @param[in] lang Locale(en-us, ko-kr, ...), if it is @c NULL, function will use the system locale automatically - * @return char * type - * @retval name Allocated heap address - * @retval @c NULL Fails to get path of an icon, get_last_result() will return reasons of failure if it fails + * @return icon path on success, + * @c NULL Fails to get path of an icon, get_last_result() will return reasons of failure if it fails + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @post Returned string must be freed manually. - * @see #widget_service_get_name - * @see #widget_service_get_preview_image_path + * @see widget_service_get_name() + * @see widget_service_get_preview_image_path() */ -extern char *widget_service_get_icon(const char *pkgid, const char *lang); +char *widget_service_get_icon(const char *pkgid, const char *lang); /** * @brief Gets the "nodisplay" value. * @since_tizen 2.3.1 + * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] widget_id appid of widget application - * @privlevel public * @return The "nodisplay" value of given widget - * @retval 1 The box should not be listed by the widget list app - * @retval 0 Box should be listed, get_last_result() will return reasons of failure if it fails + * @c 1 The box should not be listed by the widget list app + * @c 0 Box should be listed, get_last_result() will return reasons of failure if it fails + * @exception #WIDGET_ERROR_NONE Successful + * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @exception #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @exception #WIDGET_ERROR_IO_ERROR Failed to access DB + * @exception #WIDGET_ERROR_FAULT Fault + * @exception #WIDGET_ERROR_NOT_EXIST Not exists * @pre Widget tag includes "nodisplay" attribute */ -extern int widget_service_get_nodisplay(const char *widget_id); +int widget_service_get_nodisplay(const char *widget_id); /** @@ -457,44 +523,44 @@ extern int widget_service_get_nodisplay(const char *widget_id); * @return @c 0 on success, * otherwise a negative error value * @retval #WIDGET_ERROR_NONE If succeed to get supported size list - * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB * @see widget_service_get_supported_size_types() */ -extern int widget_service_get_supported_sizes(const char *widget_id, int *cnt, int **w, int **h); +int widget_service_get_supported_sizes(const char *widget_id, int *cnt, int **w, int **h); /** * @brief Gets the supported size list of given widget ID. * @since_tizen 2.3.1 + * @privlevel public + * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] widgetid appid of widget application * @param[in] cnt Size of types array - * @param[in,out] cnt Result count of types array * @param[out] types Array of types - * @privlevel public - * @privilege %http://tizen.org/privilege/widget.viewer * @return @c 0 on success, * otherwise a negative error value - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB * @retval #WIDGET_ERROR_NONE Successfully done * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB * @see widget_service_get_supported_sizes() */ -extern int widget_service_get_supported_size_types(const char *widgetid, int *cnt, int **types); +int widget_service_get_supported_size_types(const char *widgetid, int *cnt, int **types); /** - * @brief Callback function for getting result of widget_service_get_widget_instance_list. + * @brief Callback function for getting result of widget_service_get_widget_instance_list(). * @since_tizen 2.3.1 * @param[in] widget_id Widget appid - * @param[in] widget_instance_id widget instance ID - * @param[in] data user Data - * @return WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop - * @see #widget_service_get_widget_instance_list + * @param[in] instance_id widget instance ID + * @param[in] user_data user Data + * @return #WIDGET_ERROR_NONE to continue with the next iteration of the loop, + * other error values to break out of the loop + * @see widget_service_get_widget_instance_list() */ -typedef int (*widget_instance_list_cb)(const char *widget_id, const char *instance_id, void *data); +typedef int (*widget_instance_list_cb)(const char *widget_id, const char *instance_id, void *user_data); /** @@ -503,21 +569,21 @@ typedef int (*widget_instance_list_cb)(const char *widget_id, const char *instan * @param[in] widget_id appid of widget application * @param[in] cb Callback function * @param[in] data user Data for callback function - * @return @c 0 on success, + * @return Size of widget instance list on success, * otherwise a negative error value - * @retval #WIDGET_ERROR_NOT_EXIST Instance is not exist - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported - * @see #widget_instance_list_cb + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_NOT_EXIST Instance is not exist + * @see widget_instance_list_cb() */ -extern int widget_service_get_widget_instance_list(const char *widget_id, widget_instance_list_cb cb, void *data); +int widget_service_get_widget_instance_list(const char *widget_id, widget_instance_list_cb cb, void *data); /** * @brief Enumeration for life cycle event of widgets. * @since_tizen 2.3.1 - * @see widget_lifecycle_event_cb + * @see widget_lifecycle_event_cb() */ typedef enum widget_lifecycle_event { WIDGET_LIFE_CYCLE_EVENT_APP_DEAD = 0, @@ -535,59 +601,65 @@ typedef enum widget_lifecycle_event { * @param[in] widget_id appid of widget application * @param[in] lifecycle_event Type of event * @param[in] widget_instance_id Widget instance ID - * @param[in] data user data + * @param[in] user_data user data * @return @c 0 on success, * otherwise a negative error value - * @see #widget_service_set_lifecycle_event_cb + * @see widget_service_set_lifecycle_event_cb() */ -typedef int (*widget_lifecycle_event_cb)(const char *widget_id, widget_lifecycle_event_e lifecycle_event, const char *widget_instance_id, void *data); +typedef int (*widget_lifecycle_event_cb)(const char *widget_id, widget_lifecycle_event_e lifecycle_event, const char *widget_instance_id, void *user_data); /** - * @brief Registers event handler callback function for life cycle events of widgets. + * @brief Sets event handler callback function for life cycle events of widgets. * @since_tizen 2.3.1 - * @privlevel public * @param[in] widget_id appid of widget application * @param[in] cb Callback function * @param[in] data user Data * @return @0 on success, * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied - * @see #widget_lifecycle_event_cb - * @see #widget_service_unset_lifecycle_event_cb + * @retval #WIDGET_ERROR_OUT_OF_MEMORY Out of memory + * @see widget_lifecycle_event_cb() + * @see widget_service_unset_lifecycle_event_cb() */ -extern int widget_service_set_lifecycle_event_cb(const char *widget_id, widget_lifecycle_event_cb cb, void *data); +int widget_service_set_lifecycle_event_cb(const char *widget_id, widget_lifecycle_event_cb cb, void *data); /** - * @brief Unregisters event handler callback function for life cycle events of widgets. + * @brief Unsets event handler callback function for life cycle events of widgets. * @since_tizen 2.3.1 * @param[in] widget_id appid of widget application * @param[out] user_data User callback data * @return @c 0 on success, * otherwise a negative error value - * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_NOT_EXIST Event handler callback function does not exist - * @see #widget_service_set_lifecycle_event_cb + * @see widget_service_set_lifecycle_event_cb() */ -extern int widget_service_unset_lifecycle_event_cb(const char *widget_id, void **user_data); +int widget_service_unset_lifecycle_event_cb(const char *widget_id, void **user_data); /** - * @brief Gets content of the widget instance + * @brief Gets content of the widget instance. * @since_tizen 2.3.1 * @param[in] widget_id appid of widget application * @param[in] widget_instance_id Widget instance ID * @param[out] b Bundle(content) data of the given widget instance, it should be released by caller. * @return @c 0 on success, * otherwise a negative error value - * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB + * @retval #WIDGET_ERROR_NONE Successfully done + * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported + * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument + * @retval #WIDGET_ERROR_IO_ERROR Failed to access DB + * @retval #WIDGET_ERROR_FAULT Failed to create a request packet + * @retval #WIDGET_ERROR_NOT_EXIST Not exists * @post Caller should have to release the bundle. */ -extern int widget_service_get_content_of_widget_instance(const char *widget_id, const char *widget_instance_id, bundle **b); +int widget_service_get_content_of_widget_instance(const char *widget_id, const char *widget_instance_id, bundle **b); /** |