2 * Copyright 2012 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://www.tizenopensource.org/license
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 */
44 CONTENT_EVENT_ACCESS_READ = 0x00000100, /*!< LB accessibility read for livebox */
45 CONTENT_EVENT_ACCESS_READ_NEXT = 0x00000200, /*!< LB accessibility read next for livebox */
46 CONTENT_EVENT_ACCESS_READ_PREV = 0x00000400, /*!< LB accessibility read prev for livebox */
47 CONTENT_EVENT_ACCESS_ACTIVATE = 0x00000800, /*!< LB accessibility activate */
48 CONTENT_EVENT_ACCESS_UP = 0x00001000, /*!< LB accessibility up */
49 CONTENT_EVENT_ACCESS_DOWN = 0x00002000, /*!< LB accessibility down */
51 CONTENT_EVENT_KEY_DOWN = 0x00100000, /*!< LB key press */
52 CONTENT_EVENT_KEY_UP = 0x00200000, /*!< LB key release */
54 CONTENT_EVENT_KEY_MASK = 0x80000000,
55 CONTENT_EVENT_ACCESS_MASK = 0x40000000,
56 CONTENT_EVENT_MOUSE_MASK = 0x20000000,
57 CONTENT_EVENT_PD_MASK = 0x10000000,
58 CONTENT_EVENT_LB_MASK = 0x00000000,
60 LB_MOUSE_DOWN = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_DOWN,
61 LB_MOUSE_UP = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UP,
62 LB_MOUSE_MOVE = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_MOVE,
63 LB_MOUSE_ENTER = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_ENTER,
64 LB_MOUSE_LEAVE = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_LEAVE,
66 PD_MOUSE_DOWN = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_DOWN,
67 PD_MOUSE_UP = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_UP,
68 PD_MOUSE_MOVE = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_MOVE,
69 PD_MOUSE_ENTER = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_ENTER,
70 PD_MOUSE_LEAVE = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_MOUSE_MASK | CONTENT_EVENT_MOUSE_LEAVE,
72 LB_ACCESS_READ = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ,
73 LB_ACCESS_READ_NEXT = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ_NEXT,
74 LB_ACCESS_READ_PREV = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ_PREV,
75 LB_ACCESS_ACTIVATE = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_ACTIVATE,
76 LB_ACCESS_UP = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_UP,
77 LB_ACCESS_DOWN = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_DOWN,
79 PD_ACCESS_READ = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ,
80 PD_ACCESS_READ_NEXT = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ_NEXT,
81 PD_ACCESS_READ_PREV = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_READ_PREV,
82 PD_ACCESS_ACTIVATE = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_ACTIVATE,
83 PD_ACCESS_UP = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_UP,
84 PD_ACCESS_DOWN = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_ACCESS_MASK | CONTENT_EVENT_ACCESS_DOWN,
86 LB_KEY_DOWN = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_DOWN,
87 LB_KEY_UP = CONTENT_EVENT_LB_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_UP,
89 PD_KEY_DOWN = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_DOWN,
90 PD_KEY_UP = CONTENT_EVENT_PD_MASK | CONTENT_EVENT_KEY_MASK | CONTENT_EVENT_KEY_UP,
92 CONTENT_EVENT_MAX = 0xFFFFFFFF,
95 /* Exported to user app */
96 enum livebox_lb_type {
97 LB_TYPE_IMAGE = 0x01, /*!< Contents of a livebox is based on the image file */
98 LB_TYPE_BUFFER = 0x02, /*!< Contents of a livebox is based on canvas buffer(shared) */
99 LB_TYPE_TEXT = 0x04, /*!< Contents of a livebox is based on formatted text file */
100 LB_TYPE_PIXMAP = 0x08, /*!< Contens of a livebox is shared by the pixmap(depends on X) */
102 LB_TYPE_INVALID = 0xFF,
105 enum livebox_pd_type {
106 PD_TYPE_BUFFER = 0x01, /*!< Contents of a PD is based on canvas buffer(shared) */
107 PD_TYPE_TEXT = 0x02, /*!< Contents of a PD is based on formatted text file */
108 PD_TYPE_PIXMAP = 0x04, /*!< Contents of a livebox is shared by the pixmap(depends on X) */
110 PD_TYPE_INVALID = 0xFF,
113 enum livebox_event_type { /*!< livebox_event_handler_set Event list */
114 LB_EVENT_LB_UPDATED, /*!< Contents of the given livebox is updated */
115 LB_EVENT_PD_UPDATED, /*!< Contents of the given pd is updated */
117 LB_EVENT_CREATED, /*!< A new livebox is created */
118 LB_EVENT_DELETED, /*!< A livebox is deleted */
120 LB_EVENT_GROUP_CHANGED, /*!< Group (Cluster/Sub-cluster) information is changed */
121 LB_EVENT_PINUP_CHANGED, /*!< PINUP status is changed */
122 LB_EVENT_PERIOD_CHANGED, /*!< Update period is changed */
124 LB_EVENT_LB_SIZE_CHANGED, /*!< Livebox size is changed */
125 LB_EVENT_PD_SIZE_CHANGED, /*!< PD size is changed */
127 LB_EVENT_PD_CREATED, /*!< If a PD is created even if you didn't call the livebox_create_pd API */
128 LB_EVENT_PD_DESTROYED, /*!< If a PD is destroyed even if you didn't call the livebox_destroy_pd API */
130 LB_EVENT_IGNORED, /*!< Request is ignored */
133 enum livebox_fault_type {
134 LB_FAULT_DEACTIVATED, /*!< Livebox is deactivated by its fault operation */
135 LB_FAULT_PROVIDER_DISCONNECTED, /*!< Provider is disconnected */
138 enum livebox_visible_state { /*!< Must be sync'd with the provider */
139 LB_SHOW = 0x00, /*!< Livebox is showed. Default state */
140 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 */
142 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 */
144 LB_VISIBLE_ERROR = 0xFFFFFFFF, /* To enlarge the size of this enumeration type */
149 * TEXT type livebox contents handling opertators.
151 struct livebox_script_operators {
152 int (*update_begin)(struct livebox *handle); /*!< Content parser is started */
153 int (*update_end)(struct livebox *handle); /*!< Content parser is stopped */
157 * Listed functions will be called when parser meets each typed component
159 int (*update_text)(struct livebox *handle, const char *id, const char *part, const char *data); /*!< Update text content */
160 int (*update_image)(struct livebox *handle, const char *id, const char *part, const char *data); /*!< Update image content */
161 int (*update_script)(struct livebox *handle, const char *id, const char *part, const char *file, const char *group); /*!< Update script content */
162 int (*update_signal)(struct livebox *handle, const char *id, const char *emission, const char *signal); /*!< Update signal */
163 int (*update_drag)(struct livebox *handle, const char *id, const char *part, double dx, double dy); /*!< Update drag info */
164 int (*update_info_size)(struct livebox *handle, const char *id, int w, int h); /*!< Update content size */
165 int (*update_info_category)(struct livebox *handle, const char *id, const char *category); /*!< Update content category info */
169 * \brief Prototype of the return callback of every async functions.
175 typedef void (*ret_cb_t)(struct livebox *handle, int ret, void *data);
178 * \brief Initialize the livebox system
182 extern int livebox_init(void *disp);
185 * \brief Finalize the livebox system
188 extern int livebox_fini(void);
191 * \brief Client is paused.
194 extern int livebox_client_paused(void);
197 * \brief Client is rfesumed.
200 extern int livebox_client_resumed(void);
203 * \brief Add a new livebox
207 * \param[in] category
213 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);
214 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);
217 * \brief Delete a livebox
219 * \param[in] ret_cb_t return callback
220 * \param[in] data user data for return callback
223 extern int livebox_del(struct livebox *handler, ret_cb_t cb, void *data);
226 * \brief Set a livebox events callback
227 * \param[in] cb Event handler
228 * \param[in] data User data for the event handler
230 * \sa livebox_unset_event_handler
233 extern int livebox_set_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data), void *data);
236 * \brief Unset the livebox event handler
238 * \return void * pointer of 'data' which is registered from the livebox_event_handler_set
239 * \sa livebox_set_event_handler
241 extern void *livebox_unset_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data));
246 * event, pkgname, filename, funcname
248 * \brief Live box fault event handler registeration function
252 * \sa livebox_unset_fault_handler
254 extern int livebox_set_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *), void *data);
257 * \brief Unset the live box fault event handler
259 * \return pointer of 'data'
260 * \sa livebox_set_fault_handler
262 extern void *livebox_unset_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *));
265 * \brief Activate the faulted livebox.
271 extern int livebox_activate(const char *pkgname, ret_cb_t cb, void *data);
274 * \brief Resize the livebox
275 * \param[in] handler Handler of a livebox
276 * \param[in] type Type of a livebox size, LB_SIZE_TYPE_1x1, ...
277 * \param[in] cb Result callback of the resize operation.
278 * \param[in] data User data for return callback
281 extern int livebox_resize(struct livebox *handler, int type, ret_cb_t cb, void *data);
284 * \brief Send the click event for a livebox.
285 * \param[in] handler Handler of a livebox
286 * \param[in] x Rational X of the content width.
287 * \param[in] y Rational Y of the content height.
290 extern int livebox_click(struct livebox *handler, double x, double y);
293 * \brief Change the cluster/sub-cluster name of given livebox handler
294 * \param[in] handler Handler of a livebox
295 * \param[in] cluster New cluster of a livebox
296 * \param[in] category New category of a livebox
297 * \param[in] cb Result callback for changing the cluster/category of a livebox
298 * \param[in] data User data for the result callback
301 extern int livebox_set_group(struct livebox *handler, const char *cluster, const char *category, ret_cb_t cb, void *data);
304 * \brief Get the cluster and category(sub-cluster) name of given livebox (It is not I18N format, only english)
305 * \param[in] handler Handler of a livebox
306 * \param[out] cluster Storage(memory) for containing the cluster name
307 * \param[out] category Storage(memory) for containing the category name
310 extern int livebox_get_group(struct livebox *handler, char ** const cluster, char ** const category);
313 * \brief Get the period of this livebox handler
314 * \param[in] handler Handler of a livebox
315 * \return double Current update period of a livebox
317 extern double livebox_period(struct livebox *handler);
320 * \brief Change the update period
321 * \param[in] handler Handler of a livebox
322 * \param[in] period New update period of a livebox
323 * \param[in] cb Result callback of changing the update period of this livebox
324 * \param[in] data User data for the result callback
327 extern int livebox_set_period(struct livebox *handler, double period, ret_cb_t cb, void *data);
330 * \brief Is this an text type livebox?
332 * \return content_type
334 extern enum livebox_lb_type livebox_lb_type(struct livebox *handler);
337 * \brief Is this livebox is created by a user?
341 extern int livebox_is_user(struct livebox *handler);
344 * \brief Get the content information string of given livebox
348 extern const char *livebox_content(struct livebox *handler);
351 * \brief Get the sub cluster title string of given livebox
353 * \return sub cluster title
355 extern const char *livebox_category_title(struct livebox *handler);
358 * \brief Get the filename of given livebox, if it is an IMAGE type livebox
362 extern const char *livebox_filename(struct livebox *handler);
365 * \brief Get the package name of given livebox handler
369 extern const char *livebox_pkgname(struct livebox *handler);
372 * \brief Get the priority of a current content.
376 extern double livebox_priority(struct livebox *handler);
379 * \brief Acquire the buffer of given livebox (Only for the buffer type)
381 * \return address of a FB
383 extern void *livebox_acquire_fb(struct livebox *handler);
386 * \brief Release the buffer of a livebox (Only for the buffer type)
390 extern int livebox_release_fb(void *buffer);
393 * \brief Get the reference count of Livebox buffer (Only for the buffer type)
397 extern int livebox_fb_refcnt(void *buffer);
400 * \brief Acquire the buffer of a PD frame (Only for the buffer type)
404 extern void *livebox_acquire_pdfb(struct livebox *handler);
407 * \brief Release the acquired buffer of the PD Frame (Only for the buffer type)
411 extern int livebox_release_pdfb(void *buffer);
414 * \brief Reference count of given PD buffer (Only for the buffer type)
418 extern int livebox_pdfb_refcnt(void *buffer);
421 * \brief Get the size of the Livebox
427 extern int livebox_size(struct livebox *handler);
430 * \brief Get the size of the Progressive Disclosure
436 extern int livebox_get_pdsize(struct livebox *handler, int *w, int *h);
439 * \brief List of supported sizes of given handler
446 extern int livebox_get_supported_sizes(struct livebox *handler, int *cnt, int *size_list);
449 * \brief BUFFER SIZE of the livebox if it is a buffer type
453 extern int livebox_lbfb_bufsz(struct livebox *handler);
456 * \brief BUFFER SIZE of the progiressive disclosure if it is a buffer type
460 extern int livebox_pdfb_bufsz(struct livebox *handler);
463 * \brief Send the content event (for buffer type) to provider(livebox)
469 extern int livebox_content_event(struct livebox *handler, enum content_event_type type, double x, double y);
472 * \brief Do pin up or not.
479 extern int livebox_set_pinup(struct livebox *handler, int flag, ret_cb_t cb, void *data);
482 * \brief Check the PIN-UP status of given handler
486 extern int livebox_is_pinned_up(struct livebox *handler);
489 * \brief Check the PINUP feature availability of the given handler
493 extern int livebox_has_pinup(struct livebox *handler);
496 * \brief Check the PD existence of given handler
500 extern int livebox_has_pd(struct livebox *handler);
503 * \brief Create the PD of given handler
509 extern int livebox_create_pd(struct livebox *handler, ret_cb_t cb, void *data);
512 * \brief Create the PD of given handler with the relative position from livebox
514 * \param[in] x 0.0 ~ 1.0
515 * \param[in] y 0.0 ~ 1.0
520 extern int livebox_create_pd_with_position(struct livebox *handler, double x, double y, ret_cb_t cb, void *data);
523 * \brief Destroy the PD of given handler if it is created.
529 extern int livebox_destroy_pd(struct livebox *handler, ret_cb_t cb, void *data);
532 * \brief Check the create status of given livebox handler
536 extern int livebox_pd_is_created(struct livebox *handler);
539 * \brief Check the content type of the progressive disclosure of given handler
543 extern enum livebox_pd_type livebox_pd_type(struct livebox *handler);
546 * \brief Check the existence of a livebox about given package name
550 extern int livebox_is_exists(const char *pkgname);
553 * \brief Set function table for parsing the text content of a livebox
558 extern int livebox_set_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
561 * \brief Set function table for parsing the text content of a Progressive Disclosure
566 extern int livebox_set_pd_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
569 * \brief Emit a text signal to given livebox only if it is a text type.
571 * \param[in] emission
580 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);
583 * \brief Set a private data pointer to carry it using given handler
588 extern int livebox_set_data(struct livebox *handler, void *data);
591 * \brief Get private data pointer which is carried by given handler
595 extern void *livebox_get_data(struct livebox *handler);
598 * \brief Subscribe the event for liveboxes only in given cluster and sub-cluster
599 * \param[in] cluster "*" can be used for subscribe all cluster's liveboxes event.
600 * If you use the "*", value in the category will be ignored.
601 * \param[in] category "*" can be used for subscribe liveboxes events of all category(sub-cluster) in given "cluster"
602 * \return int Success 0, fails error code
604 extern int livebox_subscribe_group(const char *cluster, const char *category);
607 * \brief Unsubscribe the event for the liveboxes, but you will receive already added liveboxes event.
608 * \param[in] cluster "*" can be used for subscribe all cluster's liveboxes event.
609 * If you use the "*", value in the category will be ignored.
610 * \param[in] category "*" can be used for subscribe all sub-cluster's liveboxes event in given "cluster"
611 * \return int Success 0, fails error code
613 extern int livebox_unsubscribe_group(const char *cluster, const char *category);
616 * \brief Refresh the group(cluster/sub-cluser(aka. category))
617 * \param[in] cluster Cluster ID
618 * \param[in] category Sub-cluster ID
619 * \return int Success 0 or negative value
621 extern int livebox_refresh_group(const char *cluster, const char *category);
624 * \brief Refresh a livebox
626 * \return int Success 0 or negative value
628 extern int livebox_refresh(struct livebox *handler);
631 * \brief Pixmap Id of a livebox content
634 * \sa livebox_pd_pixmap
636 extern int livebox_lb_pixmap(const struct livebox *handler);
639 * \brief Pixmap Id of a PD content
642 * \sa livebox_lb_pixmap
644 extern int livebox_pd_pixmap(const struct livebox *handler);
652 * \sa livebox_release_pd_pixmap
653 * \sa livebox_acquire_lb_pixmap
655 extern int livebox_acquire_pd_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
658 * \brief Release the acquired pixmap ID
662 * \sa livebox_acquire_pd_pixmap
663 * \sa livebox_release_lb_pixmap
665 extern int livebox_release_pd_pixmap(struct livebox *handler, int pixmap);
673 * \sa livebox_release_lb_pixmap
674 * \sa livebox_acquire_pd_pixmap
676 extern int livebox_acquire_lb_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
683 * \sa livebox_acquire_lb_pixmap
684 * \sa livebox_release_pd_pixmap
686 extern int livebox_release_lb_pixmap(struct livebox *handler, int pixmap);
689 * \brief Update the visible state of a livebox
690 * \param[in] handler Handler of a livebox
691 * \param[in] state Configure the current visible state of a livebox
694 extern int livebox_set_visibility(struct livebox *handler, enum livebox_visible_state state);
697 * \brief Current visible state of a livebox
698 * \param[in] handler Handler of a livebox
699 * \return enum visible state
701 extern enum livebox_visible_state livebox_visibility(struct livebox *handler);