Update privileve information
authorSung-jae Park <nicesj.park@samsung.com>
Tue, 1 Jul 2014 05:00:36 +0000 (14:00 +0900)
committerSung-jae Park <nicesj.park@samsung.com>
Tue, 1 Jul 2014 05:00:36 +0000 (14:00 +0900)
Change-Id: Id3d1248872409332f5e2389e7b1b578e5449a7f2

include/livebox.h
include/livebox_product.h

index 3986261..c710327 100644 (file)
@@ -126,6 +126,8 @@ struct livebox_desc;
  * @remarks Must be used only by Inhouse livebox.
  * @param[in] filename
  * @param[in] for_pd
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/core/dynamicbox.provider
  * @return Handle of desc instance
  * @pre Should be loaded by data-provider-slave.
  * @post Should be destroyed(flushed) using livebox_desc_close API.
@@ -138,6 +140,8 @@ extern struct livebox_desc *livebox_desc_open(const char *filename, int for_pd);
  * @details Only if this API is called, the description data will be applied to the content of livebox (or PD).
  * @remarks Must be used only by Inhouse livebox.
  * @param[in] handle Handle which is created by livebox_desc_open function
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_SUCCESS If the flushing description data is successfully done
  * @retval LB_STATUS_ERROR_INVALID If the given handle is not valid
@@ -153,6 +157,7 @@ extern int livebox_desc_close(struct livebox_desc *handle);
  * @param[in] handle Handle which is created by livebox_desc_open function
  * @param[in] id Id string of target object
  * @param[in] category Category string that will be used by layout object
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid handle
  * @retval LB_STATUS_ERROR_MEMORY Memory is not enough to add this block
@@ -169,6 +174,7 @@ extern int livebox_desc_set_category(struct livebox_desc *handle, const char *id
  * @param[in] id Id string of target object
  * @param[in] w Width in pixel
  * @param[in] h Height in pixel
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
  * @retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new block
@@ -184,6 +190,7 @@ extern int livebox_desc_set_size(struct livebox_desc *handle, const char *id, in
  * @param[in] handle Handle which is created by livebox_desc_open function
  * @param[in] idx Index of target block
  * @param[in] id Id String which will be used by other livebox_desc_XXX functions
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_SUCCESS Id is successfully updated for given idx of desc block
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -203,6 +210,7 @@ extern int livebox_desc_set_id(struct livebox_desc *handle, int idx, const char
  * @param[in] part Target part to update with given content(data)
  * @param[in] data Content for specified part
  * @param[in] option Option for the block. (script: group, image: option, ...)
+ * @privlevel N/P
  * @return Index of current description block
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
  * @retval LB_STATUS_ERROR_MEMORY Not enough memory to add a new desc block
@@ -218,6 +226,7 @@ extern int livebox_desc_add_block(struct livebox_desc *handle, const char *id, c
  * @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 livebox_desc_open function
  * @param[in] idx Index of added block, returned from livebox_desc_add_block, livebox_desc_set_size, livebox_desc_set_category, etc
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_SUCCESS Successfully deleted
  * @retval LB_STATUS_ERROR_NOT_EXIST Given index of desc block is not exists
@@ -232,10 +241,11 @@ extern int livebox_desc_del_block(struct livebox_desc *handle, int idx);
  * @details Creating a new Evas_Object using livebox frame buffer.
  * @param[in] id Instance Id
  * @param[in] is_pd 1 if this object is created for PD or 0 (for LB)
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/core/dynamicbox.provider
  * @return Evas_Object* Evas Object type
  * @retval Address Valid evas object
  * @retval NULL failed to create
- * @see livebox_set_elm_window
  */
 extern Evas_Object *livebox_get_evas_object(const char *id, int is_pd);
 
@@ -252,6 +262,7 @@ extern Evas_Object *livebox_get_evas_object(const char *id, int is_pd);
  * @param[in] title Human readable text for accessitility, summarized text for representing the content of a box.
  * @param[in] icon Path of icon image file - alternative image content
  * @param[in] name Name of a box - alternative text content
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_ERROR_MEMORY Out of memory
  * @retval LB_STATUS_ERROR_INVALID Invalid parameters
index 79c9eaf..9545eea 100644 (file)
@@ -94,6 +94,7 @@ struct event_info {
  *    This function can be used from async callback function to notify the updated content.
  * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions
  * @param[in] is_pd 1 for updating content of PD or 0(for content of LB)
+ * @privlevel N/P
  * @return int type
  * @retval LB_STATUS_ERROR_MEMORY Not enough memory
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -107,6 +108,7 @@ extern int livebox_content_is_updated(const char *id, int is_pd);
  * @brief Replaces "\n" (new line character) with &lt;br&gt; tag.
  * @details This utility function is used to replace all NEW LINE CHARACTER ("\n") with &lt;br&gt; tag.
  * @param[in] str Source string
+ * @privlevel N/P
  * @return char * type
  * @retval string Allocted in the heap
  * @retval NULL If it fails to replace string
@@ -173,6 +175,8 @@ struct buffer_event_data {
  * @param[in] height Height in pixel
  * @param[in] handler Event handling callback
  * @param[in] data User data for event handling callback
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return Buffer handle
  * @retval NULL Failed to acquire buffer
  * @retval handler Handle object
@@ -191,6 +195,8 @@ extern struct livebox_buffer *livebox_acquire_buffer(const char *id, int is_pd,
  * @param[in] pixels Size of a pixel in bytes
  * @param[in] handler Event handling callback
  * @param[in] data User data for event handling callback
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return Buffer handle
  * @retval NULL Failed to acquire buffer
  * @retval handler Handle object
@@ -205,6 +211,7 @@ extern struct livebox_buffer *livebox_acquire_buffer_NEW(const char *id, int is_
  * @details Only if the provider uses pixmap for providing render buffer.
  * @remarks Pixmap Id can be destroyed if you call the livebox_release_buffer. Then this pixmap Id is not guaranteed to use.
  * @param[in] handle Buffer handle
+ * @privlevel N/P
  * @return unsigned log type
  * @retval positive Pixmap Id
  * @retval 0 Failed to get pixmap Id
@@ -216,6 +223,8 @@ extern unsigned long livebox_pixmap_id(struct livebox_buffer *handle);
 /**
  * @brief Releases the buffer of livebox.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
  * @retval LB_STATUS_SUCCESS Successfully released
@@ -227,6 +236,8 @@ extern int livebox_release_buffer(struct livebox_buffer *handle);
 /**
  * @brief Releases the buffer of livebox.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
  * @retval LB_STATUS_SUCCESS Successfully released
@@ -239,6 +250,8 @@ extern int livebox_release_buffer_NEW(struct livebox_buffer *handle);
  * @brief Gets the address of S/W render buffer.
  * @details If you try to use this, after create_hw_buffer, you will get NULL.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return void* address of the render buffer
  * @retval NULL If it falis to get buffer address
  * @retval address If it succeed to get the buffer address
@@ -249,6 +262,8 @@ extern void *livebox_ref_buffer(struct livebox_buffer *handle);
 /**
  * @brief Releases the S/W render buffer.
  * @param[in] buffer Address of render buffer
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid handle
  * @retval LB_STATUS_SUCCESS Successfully unreference
@@ -261,6 +276,8 @@ extern int livebox_unref_buffer(void *buffer);
  * @brief Synchronizes the updated buffer.
  * @details This is only needed for non-H/W accelerated buffer.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_SUCCESS Successfully sync'd
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -271,6 +288,8 @@ extern int livebox_sync_buffer(struct livebox_buffer *handle);
 /**
  * @brief Requests to schedule the update operation to a provider.
  * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return If succes returns 0 or return less than 0
  * @retval LB_STATUS_SUCCESS Successfully triggered
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -282,6 +301,7 @@ extern int livebox_request_update(const char *id);
 /**
  * @brief Checks whether the livebox supports H/W acceleration or not.
  * @param[in] handle Buffer handle
+ * @privlevel N/P
  * @return int type
  * @retval 1 If the buffer handle support the H/W acceleration buffer
  * @retval 0 If it doesn not supported
@@ -292,6 +312,8 @@ extern int livebox_support_hw_buffer(struct livebox_buffer *handle);
 /**
  * @brief Creates the H/W accelerated buffer.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_ALREADY H/W buffer is already created
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -305,6 +327,8 @@ extern int livebox_create_hw_buffer(struct livebox_buffer *handle);
 /**
  * @brief Destroys the H/W accelerated buffer.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_SUCCESS Successfully destroyed
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -316,6 +340,8 @@ extern int livebox_destroy_hw_buffer(struct livebox_buffer *handle);
 /**
  * @brief Gets the address of the accelerated H/W buffer.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return void* type
  * @retval NULL Failed to get H/W accelerated buffer address
  * @retval addr H/W accelerated buffer address
@@ -326,6 +352,7 @@ extern void *livebox_buffer_hw_buffer(struct livebox_buffer *handle);
 /**
  * @brief Get the stride information from the buffer info
  * @param[in] handle Buffer handle
+ * @privlevel N/P
  * @return int stride size
  * @retval positive_value length of stride
  * @return LB_STATUS_ERROR_INVALID Invalid parameter
@@ -338,6 +365,8 @@ extern int livebox_buffer_stride(struct livebox_buffer *handle);
  * @brief Pre-processes for rendering content.
  * @details This is only needed for accessing H/W accelerated buffer.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid handle
  * @retval LB_STATUS_SUCCESS Successfully done
@@ -350,6 +379,8 @@ extern int livebox_buffer_pre_render(struct livebox_buffer *handle);
 /**
  * @brief Post-processes for rendering content.
  * @param[in] handle Buffer handle
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return If succes returns 0 or return less than 0
  * @retval LB_STATUS_SUCCESS If succeed
  * @retval LB_STATUS_ERROR_INVALID Invalid argument
@@ -365,6 +396,8 @@ extern int livebox_buffer_post_render(struct livebox_buffer *handle);
  * @param[in] pkgname Livebox Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions
  * @param[in] reason LB_STATUS_SUCCESS(0)
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
  * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid parameters
  * @retval LB_STATUS_ERROR_MEMORY Out of memory
@@ -381,7 +414,9 @@ extern int livebox_request_close_pd(const char *pkgname, const char *id, int rea
  * @remarks If the viewer doesn't care this request, this will has no effect.
  * @param[in] pkgname Livebox Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions
- * @return int
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
+ * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid parameters
  * @retval LB_STATUS_ERROR_MEMORY Out of memory
  * @retval LB_STATUS_ERROR_FAULT Failed to send requet
@@ -398,6 +433,9 @@ extern int livebox_freeze_scroller(const char *pkgname, const char *id);
  * @remarks If the viewer doesn't care this request, this will has no effect.
  * @param[in] pkgname Livebox Package Id
  * @param[in] id Instance Id which is passed to you via the first parameter of every livebox_XXXX interface functions
+ * @privlevel platform
+ * @privilege %http://developer.samsung.com/privilege/core/dynamicbox.provider
+ * @return int type
  * @retval LB_STATUS_ERROR_INVALID Invalid parameters
  * @retval LB_STATUS_ERROR_MEMORY Out of memory
  * @retval LB_STATUS_ERROR_FAULT Failed to send requet
@@ -412,6 +450,7 @@ extern int livebox_release_scroller(const char *pkgname, const char *id);
  *     If the system uses the premultiplied alpha for content,
  *     This function will returns 1.
  * @remarks This function only works with the inhouse provider.
+ * @privlevel N/P
  * @return status of premultiplied alpha.
  * @retval 1 Content rendered with premultiplied alpha.
  * @retval 0 Content doesn't rendered with premultiplied alpha.
@@ -423,6 +462,7 @@ extern int livebox_conf_premultiplied_alpha(void);
  * @details
  *      If the UIFW does not support the STRIDE information for rendering frame,
  *      This function will returns 1, then the livebox will automatically aligning the buffer.
+ * @privlevel N/P
  * @return status of auto alignment.
  * @retval 1 Content will be automatically aligned by livebox.
  * @retval 0 Content will be aligned by UIFW, using stride information.