Set @since_tizen tag.
authorKyuho Jo <kyuho.jo@samsung.com>
Tue, 31 Mar 2015 12:02:30 +0000 (21:02 +0900)
committerKyuho Jo <kyuho.jo@samsung.com>
Tue, 31 Mar 2015 12:02:30 +0000 (21:02 +0900)
Change-Id: I1b6451f1aeeec8d13f1787dee6b5e326a2eaab6e
Signed-off-by: Kyuho Jo <kyuho.jo@samsung.com>
include/widget.h
include/widget_internal.h

index f49ce22..d67918f 100755 (executable)
@@ -28,7 +28,7 @@ extern "C" {
 /**
  * @file widget.h
  * @brief This file declares API of libwidget library
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  */
 
 /**
@@ -39,7 +39,7 @@ extern "C" {
 /**
  * @brief Creates an Evas to draw widget contents
  * @details Creating a new Object using widget frame buffer.
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @param[in] widget_intance_id widget instance id from widget from widget_provider_event_callback_s functions
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -53,7 +53,7 @@ extern Evas *widget_get_evas(const char *widget_intance_id);
 /**
  * @brief Requests to schedule the update operation to a provider.
  * @detail Insert a update event to event queue and it will be handled by update callback function.
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @param[in] widget_intance_id A instance id of the widget to be updated
  * @feature http://tizen.org/feature/shell.appwidget
  * @return If succes returns 0 or return less than 0
index c3cf60a..8c98f58 100755 (executable)
@@ -30,7 +30,7 @@ extern "C" {
 /**
  * @file widget_internal.h
  * @brief This file declares API of libwidget library
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 
 /**
@@ -41,98 +41,98 @@ extern "C" {
 /**
  * @internal
  * @brief Definition for COLOR BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_COLOR "color"
 
 /**
  * @internal
  * @brief Definition for TEXT BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_TEXT "text"
 
 /**
  * @internal
  * @brief Definition for IMAGE BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_IMAGE "image"
 
 /**
  * @internal
  * @brief Definition for SIGNAL BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_SIGNAL "signal"
 
 /**
  * @internal
  * @brief Definition for INFO BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_INFO "info"
 
 /**
  * @internal
  * @brief Definition for DRAG BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_DRAG "drag"
 
 /**
  * @internal
  * @brief Definition for SCRIPT SCRIPT.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_SCRIPT "script"
 
 /**
  * @internal
  * @brief Definition for ACCESSIBILITY INFORMATION BLOCK.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_ACCESS "access"
 
 /**
  * @internal
  * @brief Definition for accessibility operation.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_TYPE_ACCESS_OPERATION "access,operation"
 
 /**
  * @internal
  * @brief Definition for set highlight on specified part.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_DATA_ACCESS_OPERATION_HL_SET "set,hl"
 
 /**
  * @internal
  * @brief Definition for remove highlight from specified part.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_DATA_ACCESS_OPERATION_HL_UNSET "unset,hl"
 
 /**
  * @internal
  * @brief Definition for move the highlight to next part.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_DATA_ACCESS_OPERATION_HL_NEXT "next,hl"
 
 /**
  * @internal
  * @brief Definition for move the highlight to previous part.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_DATA_ACCESS_OPERATION_HL_PREV "prev,hl"
 
 /**
  * @internal
  * @brief Definition for reset the chain of accessibility highlight list.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_DATA_ACCESS_OPERATION_RESET "reset,focus"
 
@@ -140,7 +140,7 @@ extern "C" {
  * @internal
  * @brief Definition for specify the highlight move option.
  * @details If the highlight list reaches to the last object, move back to the first object.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_OPTION_ACCESS_HL_LOOP "cycle"
 
@@ -149,14 +149,14 @@ extern "C" {
  * @brief Definition for specify the highlight move option.
  * @details If the highlight list reaches to the last object(or the first object),
  * the "prev,hl", "next,hl" will be failed.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 #define WIDGET_DESC_OPTION_ACCESS_HL_NOLOOP "no,cycle"
 
 /**
  * @internal
  * @brief Return values of widget programming interfaces for the plug-in type widgets
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @feature http://tizen.org/feature/shell.appwidget
  */
 typedef enum widget_api_result {
@@ -171,7 +171,7 @@ typedef enum widget_api_result {
 /**
  * @internal
  * @brief System event type for the plug-in type widgets
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @feature http://tizen.org/feature/shell.appwidget
  */
 typedef enum widget_system_event {
@@ -189,21 +189,21 @@ typedef enum widget_system_event {
 /**
  * @internal
  * @brief widget description data handle.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 typedef struct widget_desc *widget_desc_h;
 
 /**
  * @internal
  * @brief Flush Callback for snapshot window
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 typedef void (*widget_flush_cb)(void *snapshot_window, const char *id, int status, void *data);
 
 /**
  * @internal
  * @brief Updates a description file.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @remarks Must be used only by Inhouse widget.
  * @param[in] id widget Instance Id
  * @param[in] gbar 1 for Glance Bar or 0
@@ -222,7 +222,7 @@ extern widget_desc_h widget_desc_open(const char *id, int gbar);
  * @internal
  * @brief Completes the description file update.
  * @details Only if this API is called, the description data will be applied to the content of widget (or GBar).
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @remarks Must be used only by Inhouse widget.
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @privlevel public
@@ -243,7 +243,7 @@ extern int widget_desc_close(widget_desc_h handle);
  * @internal
  * @brief Sets the category information of current description data.
  * @details Creates a new description block for updating category information of layout object.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] id Id string of target object
  * @param[in] category Category string that will be used by layout object
@@ -261,7 +261,7 @@ extern int widget_desc_set_category(widget_desc_h handle, const char *id, const
  * @internal
  * @brief Sets the content size.
  * @details Sets the content size of layout.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] id Id string of target object
  * @param[in] w Width in pixel
@@ -280,7 +280,7 @@ extern int widget_desc_set_size(widget_desc_h handle, const char *id, int w, int
  * @internal
  * @brief Sets the target id of the given block.
  * @details Only available for the script block.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] idx Index of target block
  * @param[in] id Id String which will be used by other widget_desc_XXX functions
@@ -299,7 +299,7 @@ extern int widget_desc_set_id(widget_desc_h handle, int idx, const char *id);
 /**
  * @internal
  * @brief Adds a new block.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Handle which is created by the widget_desc_open() function
  * @param[in] id ID of source script object
  * @param[in] type Type (image|text|script|signal|.. etc)
@@ -319,7 +319,7 @@ extern int widget_desc_add_block(widget_desc_h handle, const char *id, const cha
 /**
  * @internal
  * @brief Deletes an added block.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @details If you discard the added desc block, use this API and the index of the created desc block.
  * @param[in] handle Handle which is created by widget_desc_open() function
  * @param[in] idx Index of added block, returned from widget_desc_add_block(), widget_desc_set_size(), widget_desc_set_category(), etc
@@ -336,14 +336,14 @@ extern int widget_desc_del_block(widget_desc_h handle, int idx);
 /**
  * @internal
  * @brief Structure for a widget buffer defined by a provider.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 typedef struct widget_buffer *widget_buffer_h;
 
 /**
  * @internal
  * @brief Return values of widget programming interfaces: Using network.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  */
 extern const int WIDGET_USE_NET;
 
@@ -352,7 +352,7 @@ extern const int WIDGET_USE_NET;
  * @brief Notifies the updated content to the provider.
  * @details Forcedly notifies the updated contents.
  *    This function can be used from async callback function to notify the updated content.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @param[in] gbar 1 for updating content of Glance Bar or 0(for content of widget)
  * @return #WIDGET_ERROR_NONE on success,
@@ -368,7 +368,7 @@ extern int widget_content_is_updated(const char *id, int gbar);
 /**
  * @internal
  * @brief Acquires a buffer for GBar or widget, currently only the GBar is supported.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @param[in] gbar 1 for Glance Bar or 0 for widget
  * @param[in] width Width in pixel
@@ -391,7 +391,7 @@ extern widget_buffer_h widget_create_buffer(const char *id, int gbar, int auto_a
 /**
  * @internal
  * @brief Acquire a buffer for GBar or widget.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @param[in] idx Index of a buffer, WIDGET_PRIMARY_BUFFER is used for accessing primary buffer
  * @param[in] width Width of a buffer
@@ -415,7 +415,7 @@ extern int widget_viewer_acquire_buffer(widget_buffer_h handle, int idx, int wid
  * @internal
  * @brief Acquires the Id of Resource (window system).
  * @details Only if the provider uses Resource for providing render buffer.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @remarks Pixmap Id can be destroyed if you call the widget_release_buffer(). Then this Resource Id is not guaranteed to use.
  * @param[in] handle Buffer handle
  * @param[in] idx Index of a buffer, #c WIDGET_PRIMARY_BUFFER is used for accessing the primary buffer
@@ -430,7 +430,7 @@ extern unsigned int widget_viewer_get_resource_id(widget_buffer_h handle, int id
 /**
  * @internal
  * @brief Releases the buffer of widget.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @param[in] idx Index of a buffer, #c WIDGET_PRIMARY_BUFFER is used for accessing the primary buffer
  * @privlevel public
@@ -448,7 +448,7 @@ extern int widget_viewer_release_buffer(widget_buffer_h handle, int idx);
 /**
  * @internal
  * @brief Destroy a buffer of widget
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -466,7 +466,7 @@ extern int widget_destroy_buffer(widget_buffer_h handle);
  * @brief Gets the address of buffer for S/W rendering.
  * @details If you try to use this, after widget_create_hw_buffer(), you will get @c NULL.
  *          This API only be used for primary buffer. you cannot access the extra buffer
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -481,7 +481,7 @@ extern void *widget_ref_buffer(widget_buffer_h handle);
 /**
  * @internal
  * @brief Releases the S/W render buffer.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] buffer Address of render buffer
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -501,7 +501,7 @@ extern int widget_unref_buffer(void *buffer);
  * @brief Synchronizes the updated buffer.
  * @details This is only needed for non-H/W accelerated buffer.
  *          This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -519,7 +519,7 @@ extern int widget_viewer_sync_buffer(widget_buffer_h handle);
  * @internal
  * @brief Checks whether the widget supports H/W acceleration or not.
  *        This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @return int type
  * @retval 1 If the buffer handle support the H/W acceleration buffer
@@ -532,7 +532,7 @@ extern int widget_support_hw_buffer(widget_buffer_h handle);
  * @internal
  * @brief Creates the H/W accelerated buffer.
  *        This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -553,7 +553,7 @@ extern int widget_create_hw_buffer(widget_buffer_h handle);
  * @internal
  * @brief Destroys the H/W accelerated buffer.
  *        This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -572,7 +572,7 @@ extern int widget_destroy_hw_buffer(widget_buffer_h handle);
  * @internal
  * @brief Gets the address of the accelerated H/W buffer.
  *        This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -588,7 +588,7 @@ extern void *widget_buffer_hw_buffer(widget_buffer_h handle);
  * @internal
  * @brief Get the stride information from the buffer info
  *        This API is only supported for primary buffer (#c WIDGET_PRIMARY_BUFFER)
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @return int stride size
  * @retval positive_value length of stride
@@ -602,7 +602,7 @@ extern int widget_buffer_stride(widget_buffer_h handle);
  * @internal
  * @brief Pre-processes for rendering content.
  * @details This is only needed for accessing H/W accelerated buffer.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -621,7 +621,7 @@ extern int widget_buffer_pre_render(widget_buffer_h handle);
 /**
  * @internal
  * @brief Post-processes for rendering content.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle Buffer handle
  * @privlevel public
  * @privilege %http://tizen.org/privilege/widget.provider
@@ -640,7 +640,7 @@ extern int widget_buffer_post_render(widget_buffer_h handle);
  * @internal
  * @brief Sends a request to the viewer (homescreen) to close the GBar.
  * @details Even though you call this function. the homescreen can ignore it.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] widgetid widget Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
  * @param[in] reason #WIDGET_ERROR_NONE(0)
@@ -665,7 +665,7 @@ extern int widget_request_close_glance_bar(const char *widgetid, const char *id,
  *         But it will not renders object asynchronously,
  *         So you have to render the objects immediately, the delayed rendering object will not be on the canvas
  *         After flush it to a file.
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] id
  * @param[in] size_type
  * @return void* window
@@ -678,7 +678,7 @@ extern void *widget_snapshot_window_add(const char *id, int size_type);
 /**
  * @internal
  * @brief Flush to a file for snapshot window
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] snapshot_win Snapshot window
  * @param[in] timeout After this, the image file will be created
  * @param[in] flush_cb Right after flush an image file, this callback will be called
@@ -694,7 +694,7 @@ extern int widget_snapshot_window_flush(void *snapshot_win, double timeout, widg
 /**
  * @internal
  * @brief Sending the updated event to the viewer
- * @since_tizen 2.3
+ * @since_tizen 2.3.1
  * @param[in] handle widget Buffer Handle
  * @param[in] idx Index of a buffer
  * @privlevel public
@@ -713,7 +713,7 @@ extern int widget_send_updated_by_idx(widget_buffer_h handle, int idx);
  *      such as title, icon and name, this function can set them.
  *      provider will send those information to the viewer when the
  *      content is updated.
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @privlevel N/P
  * @feature http://tizen.org/feature/shell.appwidget
  * @remarks This function only works with the buffer type inhouse provider.
@@ -738,7 +738,7 @@ extern int widget_set_extra_info(const char *id, const char *content, const char
  * @details
  *        The viewer will get this request via event callback.
  *        Then it should freeze its scroller or stop moving the widget.
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @remarks If the viewer doesn't care this request, this will has no effect.
  * @param[in] widgetid widget Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions
@@ -763,7 +763,7 @@ extern int widget_freeze_scroller(const char *widgetid, const char *id);
  * @details
  *        The viewer will get this request via event callback.
  *        Then it should release its scroller or continue moving the widget.
- * @since_tizen 2.4
+ * @since_tizen 2.3.1
  * @remarks If the viewer doesn't care this request, this will has no effect.
  * @param[in] widgetid widget Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every widget_XXXX interface functions