2 * Copyright 2013 Samsung Electronics Co., Ltd
4 * Licensed under the Flora License, Version 1.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://floralicense.org
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
35 #define DEFAULT_PERIOD -1.0f
37 enum content_event_type {
38 CONTENT_EVENT_MOUSE_DOWN = 0x00000001, /*!< LB mouse down event for livebox */
39 CONTENT_EVENT_MOUSE_UP = 0x00000002, /*!< LB mouse up event for livebox */
40 CONTENT_EVENT_MOUSE_MOVE = 0x00000004, /*!< LB mouse move event for livebox */
41 CONTENT_EVENT_MOUSE_ENTER = 0x00000008, /*!< LB mouse enter event for livebox */
42 CONTENT_EVENT_MOUSE_LEAVE = 0x00000010, /*!< LB mouse leave event for livebox */
43 CONTENT_EVENT_MOUSE_SET = 0x00000020, /*!< LB mouse set auto event for livebox */
44 CONTENT_EVENT_MOUSE_UNSET = 0x00000040, /*!< LB mouse unset auto event for livebox */
46 CONTENT_EVENT_KEY_DOWN = 0x00100000, /*!< LB key press */
47 CONTENT_EVENT_KEY_UP = 0x00200000, /*!< LB key release */
49 CONTENT_EVENT_KEY_MASK = 0x80000000,
50 CONTENT_EVENT_MOUSE_MASK = 0x20000000,
51 CONTENT_EVENT_PD_MASK = 0x10000000,
52 CONTENT_EVENT_LB_MASK = 0x00000000,
54 LB_MOUSE_DOWN = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_DOWN,
55 LB_MOUSE_UP = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UP,
56 LB_MOUSE_MOVE = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_MOVE,
57 LB_MOUSE_ENTER = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_ENTER,
58 LB_MOUSE_LEAVE = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_LEAVE,
59 LB_MOUSE_SET = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_SET,
60 LB_MOUSE_UNSET = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UNSET,
62 PD_MOUSE_DOWN = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_DOWN,
63 PD_MOUSE_UP = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UP,
64 PD_MOUSE_MOVE = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_MOVE,
65 PD_MOUSE_ENTER = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_ENTER,
66 PD_MOUSE_LEAVE = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_LEAVE,
67 PD_MOUSE_SET = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_SET,
68 PD_MOUSE_UNSET = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UNSET,
70 LB_KEY_DOWN = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_DOWN,
71 LB_KEY_UP = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_UP,
73 PD_KEY_DOWN = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_DOWN,
74 PD_KEY_UP = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_UP,
76 CONTENT_EVENT_MAX = 0xFFFFFFFF,
79 enum access_event_type {
80 ACCESS_EVENT_PD_MASK = 0x10000000,
81 ACCESS_EVENT_LB_MASK = 0x00000000,
83 ACCESS_EVENT_HIGHLIGHT = 0x00000100, /*!< LB accessibility: Hightlight a object */
84 ACCESS_EVENT_HIGHLIGHT_NEXT = 0x00000200, /*!< LB accessibility: Set highlight to next object */
85 ACCESS_EVENT_HIGHLIGHT_PREV = 0x00000400, /*!< LB accessibility: Set highlight to prev object */
86 ACCESS_EVENT_ACTIVATE = 0x00000800, /*!< LB accessibility activate */
87 ACCESS_EVENT_VALUE_CHANGE = 0x00001000, /*!< LB accessibility value changed */
88 ACCESS_EVENT_UNHIGHLIGHT = 0x00002000, /*!< LB accessibility unhighlight */
89 ACCESS_EVENT_SCROLL_DOWN = 0x00004000, /*!< LB accessibility scroll down */
90 ACCESS_EVENT_SCROLL_MOVE = 0x00008000, /*!< LB accessibility scroll move */
91 ACCESS_EVENT_SCROLL_UP = 0x00010000, /*!< LB accessibility scroll up */
93 LB_ACCESS_HIGHLIGHT = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_HIGHLIGHT,
94 LB_ACCESS_HIGHLIGHT_NEXT = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_HIGHLIGHT_NEXT,
95 LB_ACCESS_HIGHLIGHT_PREV = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_HIGHLIGHT_PREV,
96 LB_ACCESS_ACTIVATE = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_ACTIVATE,
97 LB_ACCESS_VALUE_CHANGE = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_VALUE_CHANGE,
98 LB_ACCESS_UNHIGHLIGHT = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_UNHIGHLIGHT,
99 LB_ACCESS_SCROLL_DOWN = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_SCROLL_DOWN,
100 LB_ACCESS_SCROLL_MOVE = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_SCROLL_MOVE,
101 LB_ACCESS_SCROLL_UP = ACCESS_EVENT_LB_MASK | ACCESS_EVENT_SCROLL_UP,
103 PD_ACCESS_HIGHLIGHT = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_HIGHLIGHT,
104 PD_ACCESS_HIGHLIGHT_NEXT = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_HIGHLIGHT_NEXT,
105 PD_ACCESS_HIGHLIGHT_PREV = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_HIGHLIGHT_PREV,
106 PD_ACCESS_ACTIVATE = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_ACTIVATE,
107 PD_ACCESS_VALUE_CHANGE = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_VALUE_CHANGE,
108 PD_ACCESS_UNHIGHLIGHT = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_UNHIGHLIGHT,
109 PD_ACCESS_SCROLL_DOWN = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_SCROLL_DOWN,
110 PD_ACCESS_SCROLL_MOVE = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_SCROLL_MOVE,
111 PD_ACCESS_SCROLL_UP = ACCESS_EVENT_PD_MASK | ACCESS_EVENT_SCROLL_UP,
114 /* Exported to user app */
115 enum livebox_lb_type {
116 LB_TYPE_IMAGE = 0x01, /*!< Contents of a livebox is based on the image file */
117 LB_TYPE_BUFFER = 0x02, /*!< Contents of a livebox is based on canvas buffer(shared) */
118 LB_TYPE_TEXT = 0x04, /*!< Contents of a livebox is based on formatted text file */
119 LB_TYPE_PIXMAP = 0x08, /*!< Contens of a livebox is shared by the pixmap(depends on X) */
121 LB_TYPE_INVALID = 0xFF,
124 enum livebox_pd_type {
125 PD_TYPE_BUFFER = 0x01, /*!< Contents of a PD is based on canvas buffer(shared) */
126 PD_TYPE_TEXT = 0x02, /*!< Contents of a PD is based on formatted text file */
127 PD_TYPE_PIXMAP = 0x04, /*!< Contents of a livebox is shared by the pixmap(depends on X) */
129 PD_TYPE_INVALID = 0xFF,
132 enum livebox_event_type { /*!< livebox_event_handler_set Event list */
133 LB_EVENT_LB_UPDATED, /*!< Contents of the given livebox is updated */
134 LB_EVENT_PD_UPDATED, /*!< Contents of the given pd is updated */
136 LB_EVENT_CREATED, /*!< A new livebox is created */
137 LB_EVENT_DELETED, /*!< A livebox is deleted */
139 LB_EVENT_GROUP_CHANGED, /*!< Group (Cluster/Sub-cluster) information is changed */
140 LB_EVENT_PINUP_CHANGED, /*!< PINUP status is changed */
141 LB_EVENT_PERIOD_CHANGED, /*!< Update period is changed */
143 LB_EVENT_LB_SIZE_CHANGED, /*!< Livebox size is changed */
144 LB_EVENT_PD_SIZE_CHANGED, /*!< PD size is changed */
146 LB_EVENT_PD_CREATED, /*!< If a PD is created even if you didn't call the livebox_create_pd API */
147 LB_EVENT_PD_DESTROYED, /*!< If a PD is destroyed even if you didn't call the livebox_destroy_pd API */
149 LB_EVENT_HOLD_SCROLL, /*!< If the screen should be freezed */
150 LB_EVENT_RELEASE_SCROLL, /*!< If the screen can be scrolled */
152 LB_EVENT_LB_UPDATE_BEGIN,
153 LB_EVENT_LB_UPDATE_END,
155 LB_EVENT_PD_UPDATE_BEGIN,
156 LB_EVENT_PD_UPDATE_END,
158 LB_EVENT_UPDATE_MODE_CHANGED,
160 LB_EVENT_IGNORED, /*!< Request is ignored */
163 enum livebox_fault_type {
164 LB_FAULT_DEACTIVATED, /*!< Livebox is deactivated by its fault operation */
165 LB_FAULT_PROVIDER_DISCONNECTED, /*!< Provider is disconnected */
168 enum livebox_visible_state { /*!< Must be sync'd with the provider */
169 LB_SHOW = 0x00, /*!< Livebox is showed. Default state */
170 LB_HIDE = 0x01, /*!< Livebox is hide, Update timer is not be freezed. but you cannot receive any updates events. you should refresh(reload) the content of a livebox when you make this show again */
172 LB_HIDE_WITH_PAUSE = 0x02, /*!< Livebix is hide, it will paused the update timer, but if a livebox update its contents, update event will come to you */
174 LB_VISIBLE_ERROR = 0xFFFFFFFF, /* To enlarge the size of this enumeration type */
179 * TEXT type livebox contents handling opertators.
181 struct livebox_script_operators {
182 int (*update_begin)(struct livebox *handle); /*!< Content parser is started */
183 int (*update_end)(struct livebox *handle); /*!< Content parser is stopped */
187 * Listed functions will be called when parser meets each typed component
189 int (*update_text)(struct livebox *handle, const char *id, const char *part, const char *data); /*!< Update text content */
190 int (*update_image)(struct livebox *handle, const char *id, const char *part, const char *data, const char *option); /*!< Update image content */
191 int (*update_script)(struct livebox *handle, const char *id, const char *part, const char *file, const char *group); /*!< Update script content */
192 int (*update_signal)(struct livebox *handle, const char *id, const char *emission, const char *signal); /*!< Update signal */
193 int (*update_drag)(struct livebox *handle, const char *id, const char *part, double dx, double dy); /*!< Update drag info */
194 int (*update_info_size)(struct livebox *handle, const char *id, int w, int h); /*!< Update content size */
195 int (*update_info_category)(struct livebox *handle, const char *id, const char *category); /*!< Update content category info */
199 * \brief Prototype of the return callback of every async functions.
205 typedef void (*ret_cb_t)(struct livebox *handle, int ret, void *data);
208 * \brief Initialize the livebox system
209 * \param[in] disp If you have X Display connection object, you can re-use it. but you should care its life cycle.
210 * It must be alive before call the livebox_fini
211 * \return int 0 if success or < 0 (errno)
214 extern int livebox_init(void *disp);
217 * \brief Finalize the livebox system
218 * \return int 0 if success, -EINVAL if livebox_init is not called.
221 extern int livebox_fini(void);
224 * \brief Client is paused.
225 * \return int 0 if success, -EFAULT if it failed to send state(paused) info
226 * \sa livebox_client_resumed
228 extern int livebox_client_paused(void);
231 * \brief Client is rfesumed.
232 * \return int 0 if success, -EFAULT if it failed to send state(resumed) info
233 * \sa livebox_client_paused
235 extern int livebox_client_resumed(void);
238 * \brief Add a new livebox
239 * \param[in] pkgname Livebox Id
240 * \param[in] content Will be passed to the livebox.
242 * \param[in] category
243 * \param[in] period Update period. if you set DEFAULT_PERIOD, the provider will use the default period which is described in the manifest.
244 * \param[in] cb After send the request to the provider, its result will be passed
248 extern struct livebox *livebox_add(const char *pkgname, const char *content, const char *cluster, const char *category, double period, ret_cb_t cb, void *data);
249 extern struct livebox *livebox_add_with_size(const char *pkgname, const char *content, const char *cluster, const char *category, double period, int type, ret_cb_t cb, void *data);
252 * \brief Delete a livebox
254 * \param[in] ret_cb_t return callback
255 * \param[in] data user data for return callback
258 extern int livebox_del(struct livebox *handler, ret_cb_t cb, void *data);
261 * \brief Set a livebox events callback
262 * \param[in] cb Event handler
263 * \param[in] data User data for the event handler
265 * \sa livebox_unset_event_handler
268 extern int livebox_set_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data), void *data);
271 * \brief Unset the livebox event handler
273 * \return void * pointer of 'data' which is registered from the livebox_event_handler_set
274 * \sa livebox_set_event_handler
276 extern void *livebox_unset_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data));
281 * event, pkgname, filename, funcname
283 * \brief Live box fault event handler registeration function
287 * \sa livebox_unset_fault_handler
289 extern int livebox_set_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *), void *data);
292 * \brief Unset the live box fault event handler
294 * \return pointer of 'data'
295 * \sa livebox_set_fault_handler
297 extern void *livebox_unset_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *));
300 * \brief Activate the faulted livebox.
306 extern int livebox_activate(const char *pkgname, ret_cb_t cb, void *data);
309 * \brief Resize the livebox
310 * \param[in] handler Handler of a livebox
311 * \param[in] type Type of a livebox size, LB_SIZE_TYPE_1x1, ...
312 * \param[in] cb Result callback of the resize operation.
313 * \param[in] data User data for return callback
316 extern int livebox_resize(struct livebox *handler, int type, ret_cb_t cb, void *data);
319 * \brief Send the click event for a livebox.
320 * \param[in] handler Handler of a livebox
321 * \param[in] x Rational X of the content width.
322 * \param[in] y Rational Y of the content height.
325 extern int livebox_click(struct livebox *handler, double x, double y);
328 * \brief Change the cluster/sub-cluster name of given livebox handler
329 * \param[in] handler Handler of a livebox
330 * \param[in] cluster New cluster of a livebox
331 * \param[in] category New category of a livebox
332 * \param[in] cb Result callback for changing the cluster/category of a livebox
333 * \param[in] data User data for the result callback
336 extern int livebox_set_group(struct livebox *handler, const char *cluster, const char *category, ret_cb_t cb, void *data);
339 * \brief Get the cluster and category(sub-cluster) name of given livebox (It is not I18N format, only english)
340 * \param[in] handler Handler of a livebox
341 * \param[out] cluster Storage(memory) for containing the cluster name
342 * \param[out] category Storage(memory) for containing the category name
345 extern int livebox_get_group(struct livebox *handler, char ** const cluster, char ** const category);
348 * \brief Get the period of this livebox handler
349 * \param[in] handler Handler of a livebox
350 * \return double Current update period of a livebox
352 extern double livebox_period(struct livebox *handler);
355 * \brief Change the update period
356 * \param[in] handler Handler of a livebox
357 * \param[in] period New update period of a livebox
358 * \param[in] cb Result callback of changing the update period of this livebox
359 * \param[in] data User data for the result callback
362 extern int livebox_set_period(struct livebox *handler, double period, ret_cb_t cb, void *data);
365 * \brief Is this an text type livebox?
367 * \return content_type
369 extern enum livebox_lb_type livebox_lb_type(struct livebox *handler);
372 * \brief Is this livebox is created by a user?
376 extern int livebox_is_user(struct livebox *handler);
379 * \brief Get the content information string of given livebox
383 extern const char *livebox_content(struct livebox *handler);
386 * \brief Get the sub cluster title string of given livebox
388 * \return sub cluster title
390 extern const char *livebox_category_title(struct livebox *handler);
393 * \brief Get the filename of given livebox, if it is an IMAGE type livebox
397 extern const char *livebox_filename(struct livebox *handler);
400 * \brief Get the package name of given livebox handler
404 extern const char *livebox_pkgname(struct livebox *handler);
407 * \brief Get the priority of a current content.
411 extern double livebox_priority(struct livebox *handler);
414 * \brief Acquire the buffer of given livebox (Only for the buffer type)
416 * \return address of a FB
418 extern void *livebox_acquire_fb(struct livebox *handler);
421 * \brief Release the buffer of a livebox (Only for the buffer type)
425 extern int livebox_release_fb(void *buffer);
428 * \brief Get the reference count of Livebox buffer (Only for the buffer type)
432 extern int livebox_fb_refcnt(void *buffer);
435 * \brief Acquire the buffer of a PD frame (Only for the buffer type)
439 extern void *livebox_acquire_pdfb(struct livebox *handler);
442 * \brief Release the acquired buffer of the PD Frame (Only for the buffer type)
446 extern int livebox_release_pdfb(void *buffer);
449 * \brief Reference count of given PD buffer (Only for the buffer type)
453 extern int livebox_pdfb_refcnt(void *buffer);
456 * \brief Get the size of the Livebox
462 extern int livebox_size(struct livebox *handler);
465 * \brief Get the size of the Progressive Disclosure
471 extern int livebox_get_pdsize(struct livebox *handler, int *w, int *h);
474 * \brief List of supported sizes of given handler
481 extern int livebox_get_supported_sizes(struct livebox *handler, int *cnt, int *size_list);
484 * \brief BUFFER SIZE of the livebox if it is a buffer type
488 extern int livebox_lbfb_bufsz(struct livebox *handler);
491 * \brief BUFFER SIZE of the progiressive disclosure if it is a buffer type
495 extern int livebox_pdfb_bufsz(struct livebox *handler);
498 * \brief Send the content event (for buffer type) to provider(livebox)
505 extern int livebox_content_event(struct livebox *handler, enum content_event_type type, double x, double y);
508 * \brief Send the access event(for buffer type) to provider(livebox).
510 * \param[in] access_event_type
517 extern int livebox_access_event(struct livebox *handler, enum access_event_type type, double x, double y, ret_cb_t cb, void *data);
520 * \brief Do pin up or not.
527 extern int livebox_set_pinup(struct livebox *handler, int flag, ret_cb_t cb, void *data);
530 * \brief Check the PIN-UP status of given handler
534 extern int livebox_is_pinned_up(struct livebox *handler);
537 * \brief Check the PINUP feature availability of the given handler
541 extern int livebox_has_pinup(struct livebox *handler);
544 * \brief Check the PD existence of given handler
548 extern int livebox_has_pd(struct livebox *handler);
551 * \brief Create the PD of given handler
557 extern int livebox_create_pd(struct livebox *handler, ret_cb_t cb, void *data);
560 * \brief Create the PD of given handler with the relative position from livebox
562 * \param[in] x 0.0 ~ 1.0
563 * \param[in] y 0.0 ~ 1.0
568 extern int livebox_create_pd_with_position(struct livebox *handler, double x, double y, ret_cb_t cb, void *data);
571 * \brief PD position is updated.
573 * \param[in] x 0.0 ~ 1.0
574 * \param[in] y 0.0 ~ 1.0
575 * \return int 0 if succeed to send request for updating position of the PD.
577 extern int livebox_move_pd(struct livebox *handler, double x, double y);
580 * \brief Destroy the PD of given handler if it is created.
586 extern int livebox_destroy_pd(struct livebox *handler, ret_cb_t cb, void *data);
589 * \brief Check the create status of given livebox handler
593 extern int livebox_pd_is_created(struct livebox *handler);
596 * \brief Check the content type of the progressive disclosure of given handler
600 extern enum livebox_pd_type livebox_pd_type(struct livebox *handler);
603 * \brief Check the existence of a livebox about given package name
607 extern int livebox_is_exists(const char *pkgname);
610 * \brief Set function table for parsing the text content of a livebox
615 extern int livebox_set_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
618 * \brief Set function table for parsing the text content of a Progressive Disclosure
623 extern int livebox_set_pd_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
626 * \brief Emit a text signal to given livebox only if it is a text type.
628 * \param[in] emission
637 extern int livebox_emit_text_signal(struct livebox *handler, const char *emission, const char *source, double sx, double sy, double ex, double ey, ret_cb_t cb, void *data);
640 * \brief Set a private data pointer to carry it using given handler
645 extern int livebox_set_data(struct livebox *handler, void *data);
648 * \brief Get private data pointer which is carried by given handler
652 extern void *livebox_get_data(struct livebox *handler);
655 * \brief Subscribe the event for liveboxes only in given cluster and sub-cluster
656 * \param[in] cluster "*" can be used for subscribe all cluster's liveboxes event.
657 * If you use the "*", value in the category will be ignored.
658 * \param[in] category "*" can be used for subscribe liveboxes events of all category(sub-cluster) in given "cluster"
659 * \return int Success 0, fails error code
661 extern int livebox_subscribe_group(const char *cluster, const char *category);
664 * \brief Unsubscribe the event for the liveboxes, but you will receive already added liveboxes event.
665 * \param[in] cluster "*" can be used for subscribe all cluster's liveboxes event.
666 * If you use the "*", value in the category will be ignored.
667 * \param[in] category "*" can be used for subscribe all sub-cluster's liveboxes event in given "cluster"
668 * \return int Success 0, fails error code
670 extern int livebox_unsubscribe_group(const char *cluster, const char *category);
673 * \brief Refresh the group(cluster/sub-cluser(aka. category))
674 * \param[in] cluster Cluster ID
675 * \param[in] category Sub-cluster ID
676 * \return int Success 0 or negative value
678 extern int livebox_refresh_group(const char *cluster, const char *category);
681 * \brief Refresh a livebox
683 * \return int Success 0 or negative value
685 extern int livebox_refresh(struct livebox *handler);
688 * \brief Pixmap Id of a livebox content
691 * \sa livebox_pd_pixmap
693 extern int livebox_lb_pixmap(const struct livebox *handler);
696 * \brief Pixmap Id of a PD content
699 * \sa livebox_lb_pixmap
701 extern int livebox_pd_pixmap(const struct livebox *handler);
709 * \sa livebox_release_pd_pixmap
710 * \sa livebox_acquire_lb_pixmap
712 extern int livebox_acquire_pd_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
715 * \brief Release the acquired pixmap ID
719 * \sa livebox_acquire_pd_pixmap
720 * \sa livebox_release_lb_pixmap
722 extern int livebox_release_pd_pixmap(struct livebox *handler, int pixmap);
730 * \sa livebox_release_lb_pixmap
731 * \sa livebox_acquire_pd_pixmap
733 extern int livebox_acquire_lb_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
740 * \sa livebox_acquire_lb_pixmap
741 * \sa livebox_release_pd_pixmap
743 extern int livebox_release_lb_pixmap(struct livebox *handler, int pixmap);
746 * \brief Update the visible state of a livebox
747 * \param[in] handler Handler of a livebox
748 * \param[in] state Configure the current visible state of a livebox
751 extern int livebox_set_visibility(struct livebox *handler, enum livebox_visible_state state);
754 * \brief Current visible state of a livebox
755 * \param[in] handler Handler of a livebox
756 * \return enum visible state
758 extern enum livebox_visible_state livebox_visibility(struct livebox *handler);
761 * \brief Set the update mode of current livebox
762 * if you set 1 for active update mode, you should get buffer without updated event from provider.
763 * But is passive mode, you have to update content of a box when you get updated event.
764 * Default is Passive mode.
765 * \param[in] handler Handler of a livebox
766 * \param[in] active_update 1 means active update, 0 means passive update (default)
767 * \param[in] cb Result callback function
768 * \param[in] data Callback data
771 extern int livebox_set_update_mode(struct livebox *handler, int active_update, ret_cb_t cb, void *data);
774 * \brief Is this box in the active update mode?
775 * \param[in] handler HAndler of a livebox
776 * \return int 0 if passive mode or 1 if active mode or error code
778 extern int livebox_is_active_update(struct livebox *handler);