/**
- * @brief Destroy type of widget instance.
+ * @brief Enumeration for destroy type of widget instance.
* @since_tizen 2.3.1
*/
typedef enum widget_app_destroy_type {
WIDGET_APP_DESTROY_TYPE_PERMANENT = 0x00, /**< User deleted this widget from the viewer */
WIDGET_APP_DESTROY_TYPE_TEMPORARY = 0x01, /**< Widget is deleted because of other reasons (e.g. widget process is terminated temporarily by the system) */
-} widget_app_destroy_type_e; /**< Delete type */
+} widget_app_destroy_type_e;
/**
/**
* @brief Called when the widget instance starts.
- * @since_tizen 2.3.1
* @details The callback function is called after widget instance is created.
* In this callback, you can initialize resources for this instance.
+ * @since_tizen 2.3.1
* @param[in] context The context of widget instance
* @param[in] content The data set for the previous status
* @param[in] w The pixel value for widget width
/**
* @brief Called before the widget instance is destroyed.
- * @since_tizen 2.3.1
* @details The callback function is called before widget instance is destroyed.
* In this callback, you can finalize resources for this instance.
* If reason is not #WIDGET_APP_DESTROY_TYPE_TEMPORARY, it should store the current status by using incoming bundle.
+ * @since_tizen 2.3.1
* @remark Note that the parameter 'content' is used to save the status of the widget instance.
* As a input parameter, content contains the saved status of the widget instance.
* You can fill the content parameter with the current status in this callback,
/**
* @brief Called when the widget is invisible.
- * @since_tizen 2.3.1
* @details The callback function is called when the widget is invisible.
* The paused instance may be destroyed by framework.
+ * @since_tizen 2.3.1
* @param[in] context The context of widget instance
* @param[in] user_data The user data passed from widget_app_class_create function
* @return #WIDGET_ERROR_NONE on success,
/**
* @brief Called when the widget is visible.
- * @since_tizen 2.3.1
* @details The callback function is called when the widget is visible.
+ * @since_tizen 2.3.1
* @param[in] context The context of widget instance
* @param[in] user_data The user data passed from widget_app_class_create function
* @return #WIDGET_ERROR_NONE on success,
/**
* @brief Called before the widget size is changed.
- * @since_tizen 2.3.1
* @details The callback function is called before the widget size is changed.
+ * @since_tizen 2.3.1
* @param[in] context The context of widget instance
* @param[in] w The pixel value for widget width
* @param[in] h The pixel value for widget height
/**
* @brief Called when the event for updating widget is received.
- * @since_tizen 2.3.1
* @details The callback function is called when the event for updating widget is received.
+ * @since_tizen 2.3.1
* @param[in] context The context of widget instance
* @param[in] content The data set for updating this widget. It will be provided by requester.
* Requester can use widget_service_trigger_update()
/**
- * @brief The structure for lifecycle of a widget instance.
+ * @brief The structure type containing the set of callback functions for lifecycle of a widget instance.
* @since_tizen 2.3.1
*/
typedef struct {
/**
* @brief Called when the application starts.
- * @since_tizen 2.3.1
* @details The callback function is called before the main loop of the application starts.
* In this callback, you can initialize resources which can be shared among widget instances.
* This function should return the handle for widget class so that it will be used for making instances of widget.
+ * @since_tizen 2.3.1
* @param[in] user_data The user data passed from the callback registration function
* @return The object of widget class
* @see widget_app_main()
/**
* @brief Called for each widget context.
- * @since_tizen 2.3.1
* @details This function will be called in the function of widget_app_foreach_context repeatedly.
+ * @since_tizen 2.3.1
* @param[in] context The context for widget instance
* @param[in] data The data for caller
* @return @c true to continue with the next iteration of the loop,
* @brief Removes registered event handler.
* @since_tizen 2.3.1
* @param[in] event_handler The event handler
- * @return #WIDGET_ERROR_NONE on success
+ * @return #WIDGET_ERROR_NONE on success,
* otherwise an error code (see WIDGET_ERROR_XXX) on failure
* @retval #WIDGET_ERROR_NONE Successful
* @retval #WIDGET_ERROR_INVALID_PARAMETER Invalid parameter
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] callback The set of lifecycle callbacks
* @param[in] user_data The user data to be passed to the callback functions
- * @return The new widget class object. NULL on error
+ * @return The new widget class object,
+ * NULL on error
* @exception #WIDGET_ERROR_NONE Successfully added
* @exception #WIDGET_ERROR_INVALID_PARAMETER Not supported
* @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported
* @param[in] class_id The class id of provider
* @param[in] callback The set of lifecycle callbacks
* @param[in] user_data The user data to be passed to the callback functions
- * @return The new widget class object. NULL on error
+ * @return The new widget class object,
+ * NULL on error
* @exception #WIDGET_ERROR_NONE Successfully added
* @exception #WIDGET_ERROR_INVALID_PARAMETER Not supported
* @exception #WIDGET_ERROR_NOT_SUPPORTED Not supported