From 2493d3bd63572350fffb59e59e32ab88e8424b78 Mon Sep 17 00:00:00 2001 From: "moon87.park" Date: Fri, 16 Dec 2016 16:07:36 +0900 Subject: [PATCH] [Widget-viewer] Fixed header file about english and coding standard Change-Id: Ibe09549fc7e938d34d4c8a2807b0b256f53ca8be --- widget_viewer_evas/doc/widget_viewer_evas_doc.h | 14 +- widget_viewer_evas/include/widget_viewer_evas.h | 315 +++++++++++++----------- 2 files changed, 185 insertions(+), 144 deletions(-) diff --git a/widget_viewer_evas/doc/widget_viewer_evas_doc.h b/widget_viewer_evas/doc/widget_viewer_evas_doc.h index 8fbaef5..141fd0a 100644 --- a/widget_viewer_evas/doc/widget_viewer_evas_doc.h +++ b/widget_viewer_evas/doc/widget_viewer_evas_doc.h @@ -14,19 +14,19 @@ * limitations under the License. */ + /** - * @defgroup CAPI_WIDGET_VIEWER_EVAS_MODULE Widget Viewer * @ingroup CAPI_WIDGET_FRAMEWORK - * @brief API for widget viewer (widget screen, home screen, ...) + * @defgroup CAPI_WIDGET_VIEWER_EVAS_MODULE Widget Viewer + * @brief API for widget viewer (widget screen, home screen, ...). * @section CAPI_WIDGET_VIEWER_EVAS_MODULE_HEADER Required Header * \#include + * * @section CAPI_WIDGET_VIEWER_EVAS_MODULE_OVERVIEW Overview * Tizen Platform supports development of Widget Viewer Application. - * Many kinds of widgets can be installed to the Tizen Platform enhanced devices. + * Many kinds of widgets can be installed on the Tizen Platform enhanced devices. * Also it could be used by user via some kinds of viewer applications. - * - * This document will show you what kinds of APIs are exist and how to use them. - * + * This document will show you what kinds of APIs are existing and how to use them. * First of all, the Tizen Platform uses the EFL as a core UIFW. - * So this API set also based on the EFL. + * So this API set is also based on the EFL. */ diff --git a/widget_viewer_evas/include/widget_viewer_evas.h b/widget_viewer_evas/include/widget_viewer_evas.h index f810deb..b51f2e8 100644 --- a/widget_viewer_evas/include/widget_viewer_evas.h +++ b/widget_viewer_evas/include/widget_viewer_evas.h @@ -38,35 +38,38 @@ extern "C" { * @{ */ + /** + * @brief Definition for default refresh interval of widgets. * @since_tizen 2.3.1 - * @brief Default refresh interval of widgets. * @see #widget_viewer_evas_add_widget * @see #widget_viewer_evas_get_period */ #define WIDGET_VIEWER_EVAS_DEFAULT_PERIOD -1.0f + /** - * @since_tizen 2.3.1 * @brief Event names for smart callback of widget events. You can listen some events from widget by calling evas_object_smart_callback_add. + * @since_tizen 2.3.1 * @see #widget_evas_event_info_s * @see evas_object_smart_callback_add */ -#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" /**< Widget creation is aborted */ -#define WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" /**< Widget is created */ -#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" /**< Resizing widget is aborted */ -#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" /**< Widget is resized */ -#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" /**< Widget has faulted */ -#define WIDGET_SMART_SIGNAL_UPDATED "updated" /**< Widget content is updated */ -#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" /**< Widget extra info is updated */ -#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" /**< Provider is disconnected */ -#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" /**< Control Scroller */ -#define WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" /**< Widget is deleted */ -#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" /**< Period is changed */ +#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" /**< Widget creation is aborted */ +#define WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" /**< Widget is created */ +#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" /**< Resizing widget is aborted */ +#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" /**< Widget is resized */ +#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" /**< Widget has faulted */ +#define WIDGET_SMART_SIGNAL_UPDATED "updated" /**< Widget content is updated */ +#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" /**< Widget extra info is updated */ +#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" /**< Provider is disconnected */ +#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" /**< Control Scroller */ +#define WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" /**< Widget is deleted */ +#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" /**< Period is changed */ + /** + * @brief Data structure which will be sent as a parameter of smart callback for signals WIDGET_SMART_SIGNAL_XXX. * @since_tizen 2.3.1 - * @brief Data structure which will be sent as a parameter of smart callback for signals WIDGET_SMART_SIGNAL_XXX * @see #WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED * @see #WIDGET_SMART_SIGNAL_WIDGET_CREATED * @see #WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED @@ -80,49 +83,53 @@ extern "C" { * @see #WIDGET_SMART_SIGNAL_PERIOD_CHANGED */ typedef struct widget_evas_event_info { - const char *widget_app_id; /**< Widget application id */ + const char *widget_app_id; /**< Widget application id */ widget_event_type_e event; /**< Event type for detail event information - WIDGET_EVENT_XXX, refer the widget_serivce.h */ - int error; /**< Error type - WIDGET_ERROR_XXX, refer the widget_errno.h */ + int error; /**< Error type - WIDGET_ERROR_XXX, refer the widget_errno.h */ } widget_evas_event_info_s; + /** * @brief Enumerations for setting visibility status of a widget. * @since_tizen 2.3.1 * @see #widget_viewer_evas_freeze_visibility */ typedef enum widget_visibility_status { - WIDGET_VISIBILITY_STATUS_SHOW_FIXED = 1, /**< Visibility of the widget will be fixed as 'SHOW'*/ - WIDGET_VISIBILITY_STATUS_HIDE_FIXED = 2 /**< Visibility of the widget will be fixed as 'HIDE'*/ + WIDGET_VISIBILITY_STATUS_SHOW_FIXED = 1, /**< Visibility of the widget will be fixed as 'SHOW'*/ + WIDGET_VISIBILITY_STATUS_HIDE_FIXED = 2 /**< Visibility of the widget will be fixed as 'HIDE'*/ } widget_visibility_status_e; + /** - * @brief Configuration keys + * @brief Enumeration for configuration keys. * @since_tizen 2.3.1 * @see #widget_viewer_evas_set_option */ typedef enum widget_evas_conf { - WIDGET_VIEWER_EVAS_MANUAL_PAUSE_RESUME = 0x0001, /**< Visibility will be changed manually. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_USE_FIXED_SIZE = 0x0008, /**< Widget will be resized to specific size only. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_EASY_MODE = 0x0010, /**< Easy mode on/off. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_SCROLL_X = 0x0020, /**< Box will be scrolled from left to right vice versa. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_SCROLL_Y = 0x0040, /**< Box will be scrolled from top to bottom vice versa. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_EVENT_AUTO_FEED = 0x0080, /**< Feeds event automatically from the master provider. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_DELAYED_RESUME = 0x0100, /**< Delaying the pause/resume when it is automatically changed. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_SENSITIVE_MOVE = 0x0200, /**< Force feeds mouse up event if the box is moved. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_MANUAL_PAUSE_RESUME = 0x0001, /**< Visibility will be changed manually. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_USE_FIXED_SIZE = 0x0008, /**< Widget will be resized to specific size only. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_EASY_MODE = 0x0010, /**< Easy mode on/off. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_SCROLL_X = 0x0020, /**< Box will be scrolled from left to right vice versa. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_SCROLL_Y = 0x0040, /**< Box will be scrolled from top to bottom vice versa. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_EVENT_AUTO_FEED = 0x0080, /**< Feeds event automatically from the master provider. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_DELAYED_RESUME = 0x0100, /**< Delaying the pause/resume when it is automatically changed. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_SENSITIVE_MOVE = 0x0200, /**< Force feeds mouse up event if the box is moved. 1 : on, 0 : off */ WIDGET_VIEWER_EVAS_AUTO_RENDER_SELECTION = 0x0400, /**< Select render automatically, if a box moved, do not sync using animator, or use the animator. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_DIRECT_UPDATE = 0x0800, /**< Enable direct update path. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_USE_RENDER_ANIMATOR = 0x1000, /**< Use the render animator or not. 1 : on, 0 : off */ - WIDGET_VIEWER_EVAS_SKIP_ACQUIRE = 0x2000, /**< Even if the viewer cannot get acquired resource id, try to update using default one. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_DIRECT_UPDATE = 0x0800, /**< Enable direct update path. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_USE_RENDER_ANIMATOR = 0x1000, /**< Use the render animator or not. 1 : on, 0 : off */ + WIDGET_VIEWER_EVAS_SKIP_ACQUIRE = 0x2000, /**< Even if the viewer cannot get acquired resource id, try to update using default one. 1 : on, 0 : off */ WIDGET_VIEWER_EVAS_UNKNOWN = 0xFFFF } widget_evas_conf_e; + /** - * @brief Initializes the widget system + * @brief Initializes the widget system. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] win Window object - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER * @retval #WIDGET_ERROR_ALREADY_EXIST Already initialized @@ -132,12 +139,14 @@ typedef enum widget_evas_conf { */ extern int widget_viewer_evas_init(Evas_Object *win); + /** - * @brief Finalizes the widget system + * @brief Finalizes the widget system. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_FAULT Unrecoverable error occurred * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -146,14 +155,15 @@ extern int widget_viewer_evas_init(Evas_Object *win); */ extern int widget_viewer_evas_fini(void); + /** - * @brief Creates a new widget object + * @brief Creates a new widget object. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @param[in] parent Evas Object of parent - * @param[in] widget_id widget id + * @param[in] widget_id Widget id * @param[in] content_info Contents that will be given to the widget instance * @param[in] period Update period (@c WIDGET_DEFAULT_PERIOD can be used for this; this argument will be used to specify the period of updating contents of a widget) * @return Widget Object. NULL on error @@ -166,90 +176,102 @@ extern int widget_viewer_evas_fini(void); */ extern Evas_Object *widget_viewer_evas_add_widget(Evas_Object *parent, const char *widget_id, const char *content_info, double period); + /** - * @brief Notifies the status of the viewer to all providers + * @brief Notifies the status of the viewer to all providers. * @details If you call this, all providers will gets "resumed" event. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success - * @retval #WIDGET_ERROR_FAULT if it failed to send state (paused) info + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success + * @retval #WIDGET_ERROR_FAULT If it failed to send state (paused) info * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @see widget_viewer_evas_notify_paused_status_of_viewer() */ extern int widget_viewer_evas_notify_resumed_status_of_viewer(void); + /** - * @brief Notifies the status of the viewer to all providers + * @brief Notifies the status of the viewer to all providers. * @details If you call this, all providers will gets "paused" event. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success - * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success + * @retval #WIDGET_ERROR_FAULT If it failed to send state (resumed) info * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @see widget_viewer_evas_notify_resumed_status_of_viewer() */ extern int widget_viewer_evas_notify_paused_status_of_viewer(void); + /** - * @brief Notifies the orientation of the viewer to all providers + * @brief Notifies the orientation of the viewer to all providers. * @details If you call this, all providers will gets "rotated" event. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] orientation orientation of viewer - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success - * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info + * @param[in] orientation Orientation of viewer + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success + * @retval #WIDGET_ERROR_FAULT If it failed to send state (resumed) info * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported */ extern int widget_viewer_evas_notify_orientation_of_viewer(int orientation); + /** * @brief Pauses given widget. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success + * @param[in] widget A widget object + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied - * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info + * @retval #WIDGET_ERROR_FAULT If it failed to send state (resumed) info * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported */ extern int widget_viewer_evas_pause_widget(Evas_Object *widget); + /** - * @brief Resume given widget. + * @brief Resumes given widget. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] widget a widget object - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument - * @retval #WIDGET_ERROR_FAULT if it failed to send state (resumed) info + * @retval #WIDGET_ERROR_FAULT If it failed to send state (resumed) info * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported */ extern int widget_viewer_evas_resume_widget(Evas_Object *widget); + /** - * @brief Changes the configurable values of widget system + * @brief Changes the configurable values of widget system. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] type Configuration item * @param[in] value Its value - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported @@ -257,36 +279,38 @@ extern int widget_viewer_evas_resume_widget(Evas_Object *widget); */ extern int widget_viewer_evas_set_option(widget_evas_conf_e type, int value); + /** - * @brief Gets content string of widget - * @details This string can be used for creating contents of widget again after reboot a device or recovered from crash(abnormal status) - * @remarks Returned string should not be freed. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Gets content string of widget. + * @details This string can be used for creating contents of widget again after rebooting a device or it can be recovered from crash(abnormal status). * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return content string to be recognize content of the widget - * @retval NULL if there is no specific content string. + * @remarks Returned string should not be freed. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Content string to be recognized content of the widget + * @retval NULL if there is no specific content string * @exception #WIDGET_ERROR_NONE Successfully get content string * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied + * @post Returned string should not be freed. * @see get_last_result() - * @post Returned string should not be freed */ extern const char *widget_viewer_evas_get_content_info(Evas_Object *widget); + /** * @brief Gets summarized string of the widget content for accessibility. - * @details If the accessibility feature is turned on, a viewer can use this text to describe the widget. - * @remarks Returned string should not be freed. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @details If the accessibility feature is turned On, a viewer can use this text to describe the widget. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return title string to be used for summarizing the widget - * @retval NULL if there is no summarized text for content of given widget. + * @remarks Returned string should not be freed. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Title string to be used for summarizing the widget + * @retval NULL if there is no summarized text for content of given widget * @exception #WIDGET_ERROR_NONE Successfully get title string * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -294,32 +318,34 @@ extern const char *widget_viewer_evas_get_content_info(Evas_Object *widget); */ extern const char *widget_viewer_evas_get_title_string(Evas_Object *widget); + /** - * @brief Gets the id of the widget - * @remarks Returned string should not be freed. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Gets the ID of the widget. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return widget id + * @remarks Returned string should not be freed. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Widget ID * @retval NULL if an error occurred and you can get the reason of failure using get_last_result() - * @exception #WIDGET_ERROR_NONE Successfully get widget id + * @exception #WIDGET_ERROR_NONE Successfully get widget ID * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @see get_last_result() */ extern const char *widget_viewer_evas_get_widget_id(Evas_Object *widget); + /** * @brief Gets the update period of the widget. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return period the update period of the widget. - * @retval the update interval of the widget + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Period the update period of the widget. + * @retval The update interval of the widget * @exception #WIDGET_ERROR_NONE Successfully get period * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -327,30 +353,31 @@ extern const char *widget_viewer_evas_get_widget_id(Evas_Object *widget); */ extern double widget_viewer_evas_get_period(Evas_Object *widget); + /** * @brief Cancels click event procedure. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. - * @details If you call this function after feed the mouse_down(or mouse_set) event, the widget will get ON_HOLD events.\n + * @details If you call this function after feeding the mouse_down(or mouse_set) event, the widget will get ON_HOLD events.\n * If a widget gets ON_HOLD event, it will not do anything even if you feed mouse_up(or mouse_unset) event.\n * @since_tizen 2.3.1 + * @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/widget.viewer - * @param[in] widget a widget object + * @param[in] widget A widget object * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied * @see get_last_result() - * */ extern void widget_viewer_evas_cancel_click_event(Evas_Object *widget); + /** - * @brief Hides the preview of the widget - * @remarks This function should be called right after create the widget object before resizing it - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Hides the preview of the widget. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object + * @remarks This function should be called right after creating the widget object before resizing it. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object * @exception #WIDGET_ERROR_NONE Successfully disabled preview * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -358,15 +385,16 @@ extern void widget_viewer_evas_cancel_click_event(Evas_Object *widget); */ extern void widget_viewer_evas_disable_preview(Evas_Object *widget); + /** - * @brief Hides the help text of the widget - * @details While loading a box, hide the help text - * @remarks This function should be called right after create the widget object before resizing it - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Hides the help text of the widget. + * @details While loading a box, hide the help text. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object + * @remarks This function should be called right after creating the widget object before resizing it. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object * @exception #WIDGET_ERROR_NONE Successfully disabled overlay text * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -374,15 +402,16 @@ extern void widget_viewer_evas_disable_preview(Evas_Object *widget); */ extern void widget_viewer_evas_disable_overlay_text(Evas_Object *widget); + /** - * @brief Hides the loading message of the widget - * @details if you disable it, there is no preview & help text while creating a widget object - * @remarks This function should be called right after create the widget object before resizing it - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Hides the loading message of the widget. + * @details If you disable it, there is no preview & help text while creating a widget object. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object + * @remarks This function should be called right after creating the widget object before resizing it. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object * @exception #WIDGET_ERROR_NONE Successfully disabled loading text * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -390,6 +419,7 @@ extern void widget_viewer_evas_disable_overlay_text(Evas_Object *widget); */ extern void widget_viewer_evas_disable_loading(Evas_Object *widget); + /** * @brief Feeds the mouse_up event to the provider of the widget * @details This is very similar with widget_viewer_evas_cancel_click(), but this will sends mouse_up event explicitly.\n @@ -398,7 +428,8 @@ extern void widget_viewer_evas_disable_loading(Evas_Object *widget); * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer * @param[in] widget a widget object - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #WIDGET_ERROR_NONE if success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported @@ -406,14 +437,15 @@ extern void widget_viewer_evas_disable_loading(Evas_Object *widget); */ extern int widget_viewer_evas_feed_mouse_up_event(Evas_Object *widget); + /** * @brief Activate a widget in faulted state. * @details A widget in faulted state MUST be activated before adding the widget. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object faulted + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object faulted * @exception #WIDGET_ERROR_NONE Successfully activate faulted widget * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -421,16 +453,17 @@ extern int widget_viewer_evas_feed_mouse_up_event(Evas_Object *widget); */ extern void widget_viewer_evas_activate_faulted_widget(Evas_Object *widget); + /** - * @brief Check whether the widget is faulted. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Checks whether the widget is faulted. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return faulted state of the widget and you can get the result state of this function by using get_last_result() - * @retval true for faulted state - * @retval false for not faulted state + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Faulted state of the widget and you can get the result state of this function by using get_last_result() + * @retval True for faulted state + * @retval False for not faulted state * @exception #WIDGET_ERROR_NONE Successfully get the faulted state of the widget * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -438,17 +471,19 @@ extern void widget_viewer_evas_activate_faulted_widget(Evas_Object *widget); */ extern bool widget_viewer_evas_is_faulted(Evas_Object *widget); + /** - * @brief Freezes visibility of the widget + * @brief Freezes visibility of the widget. * @details If you don't want to change the visibility automatically, freeze it.\n - * The visibility will not be changed even though a box disappeared(hidden)/displayed(shown) from/on the screen. + * The visibility will not be changed even though a box disappeared(hidden)/displayed(shown) from/on the screen. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @param[in] status a visibility status of the widget - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success + * @param[in] widget A widget object + * @param[in] status A visibility status of the widget + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -456,31 +491,34 @@ extern bool widget_viewer_evas_is_faulted(Evas_Object *widget); */ extern int widget_viewer_evas_freeze_visibility(Evas_Object *widget, widget_visibility_status_e status); + /** - * @brief Thaws visibility of the widget + * @brief Thaws visibility of the widget. * @details If you want to let the visibility change automatically again, call this function. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return 0 on success, otherwise a negative error value - * @retval #WIDGET_ERROR_NONE if success + * @param[in] widget A widget object + * @return @c 0 on success, + * otherwise a negative error value + * @retval #WIDGET_ERROR_NONE If success * @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid argument * @retval #WIDGET_ERROR_NOT_SUPPORTED Not supported * @retval #WIDGET_ERROR_PERMISSION_DENIED Permission denied */ extern int widget_viewer_evas_thaw_visibility(Evas_Object *widget); + /** - * @brief Get the frozen state of visibility option. - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Gets the frozen state of visibility option. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return fixed state of visibility and you can get the result state of this function by using get_last_result() - * @retval true for frozen state - * @retval false for not frozen state + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Fixed state of visibility and you can get the result state of this function by using get_last_result() + * @retval True for frozen state + * @retval False for not frozen state * @exception #WIDGET_ERROR_NONE Successfully get the state of visibility * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -488,16 +526,17 @@ extern int widget_viewer_evas_thaw_visibility(Evas_Object *widget); */ extern bool widget_viewer_evas_is_visibility_frozen(Evas_Object *widget); + /** - * @brief Validate the object, whether it is a widget object or not - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Validate the object, whether it is a widget object or not. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object - * @return result of validation and you can get the result state of this function by using get_last_result() - * @retval true this is a widget - * @retval false this is not a widget + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object + * @return Result of validation and you can get the result state of this function by using get_last_result() + * @retval True this is a widget + * @retval False this is not a widget * @exception #WIDGET_ERROR_NONE Successfully get result of validation * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -505,14 +544,15 @@ extern bool widget_viewer_evas_is_visibility_frozen(Evas_Object *widget); */ extern bool widget_viewer_evas_is_widget(Evas_Object *widget); + /** - * @brief Before delete a widget, set the deletion mode - * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @brief Before deleting a widget, set the deletion mode. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/widget.viewer - * @param[in] widget a widget object which will be deleted soon - * @param[in] flag Pass 1 if you delete this widget instance permanently, or pass 0 if you want to keep it and it will be re-created soon. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @param[in] widget A widget object which will be deleted soon + * @param[in] flag Pass 1 if you delete this widget instance permanently, or pass 0 if you want to keep it and it will be re-created soon * @exception #WIDGET_ERROR_NONE Successfully set the flag * @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported * @exception #WIDGET_ERROR_PERMISSION_DENIED Permission denied @@ -520,6 +560,7 @@ extern bool widget_viewer_evas_is_widget(Evas_Object *widget); */ extern void widget_viewer_evas_set_permanent_delete(Evas_Object *widget, int flag); + /** * @} */ -- 2.7.4