include/livebox.h

   1 /*
   2  * Copyright 2012  Samsung Electronics Co., Ltd
   3  *
   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
   7  *
   8  * http://www.tizenopensource.org/license
   9  *
  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.
  15  */
  16
  17 #ifndef __LIVEBOX_H
  18 #define __LIVEBOX_H
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 struct livebox;
  25
  26 /*!
  27  * \note size list
  28  * 172x172
  29  * 348x172
  30  * 348x348
  31  * 700x348
  32  * 700x172
  33  * 700x700
  34  */
  35 #define DEFAULT_PERIOD -1.0f
  36
  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
  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 */
  50
  51         CONTENT_EVENT_KEY_DOWN          = 0x00100000, /*!< LB key press */
  52         CONTENT_EVENT_KEY_UP            = 0x00200000, /*!< LB key release */
  53
  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,
  59
  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,
  65
  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,
  71
  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,
  78
  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,
  85
  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,
  88
  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,
  91
  92
  93         CONTENT_EVENT_MAX       = 0xFFFFFFFF,
  94 };
  95
  96 /* Exported to user app */
  97 enum livebox_lb_type {
  98         LB_TYPE_IMAGE = 0x01, /*!< Contents of a livebox is based on the image file */
  99         LB_TYPE_BUFFER = 0x02, /*!< Contents of a livebox is based on canvas buffer(shared) */
 100         LB_TYPE_TEXT = 0x04, /*!< Contents of a livebox is based on formatted text file */
 101         LB_TYPE_PIXMAP = 0x08, /*!< Contens of a livebox is shared by the pixmap(depends on X) */
 102
 103         LB_TYPE_INVALID = 0xFF,
 104 };
 105
 106 enum livebox_pd_type {
 107         PD_TYPE_BUFFER = 0x01, /*!< Contents of a PD is based on canvas buffer(shared) */
 108         PD_TYPE_TEXT = 0x02, /*!< Contents of a PD is based on formatted text file */
 109         PD_TYPE_PIXMAP = 0x04, /*!< Contents of a livebox is shared by the pixmap(depends on X) */
 110
 111         PD_TYPE_INVALID = 0xFF,
 112 };
 113
 114 enum livebox_event_type { /*!< livebox_event_handler_set Event list */
 115         LB_EVENT_LB_UPDATED, /*!< Contents of the given livebox is updated */
 116         LB_EVENT_PD_UPDATED, /*!< Contents of the given pd is updated */
 117
 118         LB_EVENT_CREATED, /*!< A new livebox is created */
 119         LB_EVENT_DELETED, /*!< A livebox is deleted */
 120
 121         LB_EVENT_GROUP_CHANGED, /*!< Group (Cluster/Sub-cluster) information is changed */
 122         LB_EVENT_PINUP_CHANGED, /*!< PINUP status is changed */
 123         LB_EVENT_PERIOD_CHANGED, /*!< Update period is changed */
 124
 125         LB_EVENT_PD_CREATED, /*!< If a PD is created even if you didn't call the livebox_create_pd API */
 126         LB_EVENT_PD_DESTROYED, /*!< If a PD is destroyed even if you didn't call the livebox_destroy_pd API */
 127
 128         LB_EVENT_IGNORED, /*!< Request is ignored */
 129 };
 130
 131 enum livebox_fault_type {
 132         LB_FAULT_DEACTIVATED, /*!< Livebox is deactivated by its fault operation */
 133         LB_FAULT_PROVIDER_DISCONNECTED, /*!< Provider is disconnected */
 134 };
 135
 136 enum livebox_visible_state { /*!< Must be sync'd with the provider */
 137         LB_SHOW = 0x00, /*!< Livebox is showed. Default state */
 138         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 */
 139
 140         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 */
 141
 142         LB_VISIBLE_ERROR = 0xFFFFFFFF, /* To enlarge the size of this enumeration type */
 143 };
 144
 145 /*!
 146  * \note
 147  * TEXT type livebox contents handling opertators.
 148  */
 149 struct livebox_script_operators {
 150         int (*update_begin)(struct livebox *handle); /*!< Content parser is started */
 151         int (*update_end)(struct livebox *handle); /*!< Content parser is stopped */
 152
 153         /*!
 154          * \brief
 155          * Listed functions will be called when parser meets each typed component
 156          */
 157         int (*update_text)(struct livebox *handle, const char *id, const char *part, const char *data); /*!< Update text content */
 158         int (*update_image)(struct livebox *handle, const char *id, const char *part, const char *data); /*!< Update image content */
 159         int (*update_script)(struct livebox *handle, const char *id, const char *part, const char *file, const char *group); /*!< Update script content */
 160         int (*update_signal)(struct livebox *handle, const char *id, const char *emission, const char *signal); /*!< Update signal */
 161         int (*update_drag)(struct livebox *handle, const char *id, const char *part, double dx, double dy); /*!< Update drag info */
 162         int (*update_info_size)(struct livebox *handle, const char *id, int w, int h); /*!< Update content size */
 163         int (*update_info_category)(struct livebox *handle, const char *id, const char *category); /*!< Update content category info */
 164 };
 165
 166 /*!
 167  * \brief Prototype of the return callback of every async functions.
 168  * \param[in] handle
 169  * \param[in] ret
 170  * \param[in] data
 171  * \return void
 172  */
 173 typedef void (*ret_cb_t)(struct livebox *handle, int ret, void *data);
 174
 175 /*!
 176  * \brief Initialize the livebox system
 177  * \param[in] disp
 178  * \return int
 179  */
 180 extern int livebox_init(void *disp);
 181
 182 /*!
 183  * \brief Finalize the livebox system
 184  * \return int
 185  */
 186 extern int livebox_fini(void);
 187
 188 /*!
 189  * \brief Add a new livebox
 190  * \param[in] pkgname
 191  * \param[in] content
 192  * \param[in] cluster
 193  * \param[in] category
 194  * \param[in] period
 195  * \param[in] cb
 196  * \param[in] data
 197  * \return handle
 198  */
 199 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);
 200 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);
 201
 202 /*!
 203  * \brief Delete a livebox
 204  * \param[in] handle
 205  * \param[in] ret_cb_t return callback
 206  * \param[in] data user data for return callback
 207  * \return int
 208  */
 209 extern int livebox_del(struct livebox *handler, ret_cb_t cb, void *data);
 210
 211 /*!
 212  * \brief Set a livebox events callback
 213  * \param[in] cb Event handler
 214  * \param[in] data User data for the event handler
 215  * \return int
 216  * \sa livebox_unset_event_handler
 217  */
 218
 219 extern int livebox_set_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data), void *data);
 220
 221 /*!
 222  * \brief Unset the livebox event handler
 223  * \param[in] cb
 224  * \return void * pointer of 'data' which is registered from the livebox_event_handler_set
 225  * \sa livebox_set_event_handler
 226  */
 227 extern void *livebox_unset_event_handler(int (*cb)(struct livebox *handler, enum livebox_event_type event, void *data));
 228
 229 /*!
 230  * \note
 231  *   argument list
 232  *      event, pkgname, filename, funcname
 233  *
 234  * \brief Live box fault event handler registeration function
 235  * \param[in] cb
 236  * \param[in] data
 237  * \return int
 238  * \sa livebox_unset_fault_handler
 239  */
 240 extern int livebox_set_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *), void *data);
 241
 242 /*!
 243  * \brief Unset the live box fault event handler
 244  * \param[in] cb
 245  * \return pointer of 'data'
 246  * \sa livebox_set_fault_handler
 247  */
 248 extern void *livebox_unset_fault_handler(int (*cb)(enum livebox_fault_type, const char *, const char *, const char *, void *));
 249
 250 /*!
 251  * \brief Activate the faulted livebox.
 252  * \param[in] pkgname
 253  * \param[in] cb
 254  * \param[in] data
 255  * \return int
 256  */
 257 extern int livebox_activate(const char *pkgname, ret_cb_t cb, void *data);
 258
 259 /*!
 260  * \brief Resize the livebox
 261  * \param[in] handler Handler of a livebox
 262  * \param[in] type Type of a livebox size, LB_SIZE_TYPE_1x1, ...
 263  * \param[in] cb Result callback of the resize operation.
 264  * \param[in] data User data for return callback
 265  * \return int
 266  */
 267 extern int livebox_resize(struct livebox *handler, int type, ret_cb_t cb, void *data);
 268
 269 /*!
 270  * \brief Send the click event for a livebox.
 271  * \param[in] handler Handler of a livebox
 272  * \param[in] x Rational X of the content width.
 273  * \param[in] y Rational Y of the content height.
 274  * \return int
 275  */
 276 extern int livebox_click(struct livebox *handler, double x, double y);
 277
 278 /*!
 279  * \brief Change the cluster/sub-cluster name of given livebox handler
 280  * \param[in] handler Handler of a livebox
 281  * \param[in] cluster New cluster of a livebox
 282  * \param[in] category New category of a livebox
 283  * \param[in] cb Result callback for changing the cluster/category of a livebox
 284  * \param[in] data User data for the result callback
 285  * \return int
 286  */
 287 extern int livebox_set_group(struct livebox *handler, const char *cluster, const char *category, ret_cb_t cb, void *data);
 288
 289 /*!
 290  * \brief Get the cluster and category(sub-cluster) name of given livebox (It is not I18N format, only english)
 291  * \param[in] handler Handler of a livebox
 292  * \param[out] cluster Storage(memory) for containing the cluster name
 293  * \param[out] category Storage(memory) for containing the category name
 294  * \return int
 295  */
 296 extern int livebox_get_group(struct livebox *handler, char ** const cluster, char ** const category);
 297
 298 /*!
 299  * \brief Get the period of this livebox handler
 300  * \param[in] handler Handler of a livebox
 301  * \return double Current update period of a livebox
 302  */
 303 extern double livebox_period(struct livebox *handler);
 304
 305 /*!
 306  * \brief Change the update period
 307  * \param[in] handler Handler of a livebox
 308  * \param[in] period New update period of a livebox
 309  * \param[in] cb Result callback of changing the update period of this livebox
 310  * \param[in] data User data for the result callback
 311  * \return int
 312  */
 313 extern int livebox_set_period(struct livebox *handler, double period, ret_cb_t cb, void *data);
 314
 315 /*!
 316  * \brief Is this an text type livebox?
 317  * \param[in] handler
 318  * \return content_type
 319  */
 320 extern enum livebox_lb_type livebox_lb_type(struct livebox *handler);
 321
 322 /*!
 323  * \brief Is this livebox is created by a user?
 324  * \param[in] handler
 325  * \return int
 326  */
 327 extern int livebox_is_user(struct livebox *handler);
 328
 329 /*!
 330  * \brief Get the content information string of given livebox
 331  * \param[in] handler
 332  * \return content
 333  */
 334 extern const char *livebox_content(struct livebox *handler);
 335
 336 /*!
 337  * \brief Get the sub cluster title string of given livebox
 338  * \param[in] handler
 339  * \return sub cluster title
 340  */
 341 extern const char *livebox_category_title(struct livebox *handler);
 342
 343 /*!
 344  * \brief Get the filename of given livebox, if it is an IMAGE type livebox
 345  * \param[in] handler
 346  * \return filename
 347  */
 348 extern const char *livebox_filename(struct livebox *handler);
 349
 350 /*!
 351  * \brief Get the package name of given livebox handler
 352  * \param[in] handler
 353  * \return pkgname
 354  */
 355 extern const char *livebox_pkgname(struct livebox *handler);
 356
 357 /*!
 358  * \brief Get the priority of a current content.
 359  * \param[in] handler
 360  * \return priority
 361  */
 362 extern double livebox_priority(struct livebox *handler);
 363
 364 /*!
 365  * \brief Acquire the buffer of given livebox (Only for the buffer type)
 366  * \param[in] handler
 367  * \return address of a FB
 368  */
 369 extern void *livebox_acquire_fb(struct livebox *handler);
 370
 371 /*!
 372  * \brief Release the buffer of a livebox (Only for the buffer type)
 373  * \param[in] buffer
 374  * \return int
 375  */
 376 extern int livebox_release_fb(void *buffer);
 377
 378 /*!
 379  * \brief Get the reference count of Livebox buffer (Only for the buffer type)
 380  * \param[in] buffer
 381  * \return int
 382  */
 383 extern int livebox_fb_refcnt(void *buffer);
 384
 385 /*!
 386  * \brief Acquire the buffer of a PD frame (Only for the buffer type)
 387  * \param[in] handler
 388  * \return int
 389  */
 390 extern void *livebox_acquire_pdfb(struct livebox *handler);
 391
 392 /*!
 393  * \brief Release the acquired buffer of the PD Frame (Only for the buffer type)
 394  * \param[in] buffer
 395  * \return int
 396  */
 397 extern int livebox_release_pdfb(void *buffer);
 398
 399 /*!
 400  * \brief Reference count of given PD buffer (Only for the buffer type)
 401  * \param[in] buffer
 402  * \return int
 403  */
 404 extern int livebox_pdfb_refcnt(void *buffer);
 405
 406 /*!
 407  * \brief Get the size of the Livebox
 408  * \param[in] handler
 409  * \param[out] w
 410  * \param[out] h
 411  * \return int
 412  */
 413 extern int livebox_size(struct livebox *handler);
 414
 415 /*!
 416  * \brief Get the size of the Progressive Disclosure
 417  * \param[in] handler
 418  * \param[out] w
 419  * \param[out] h
 420  * \return int
 421  */
 422 extern int livebox_get_pdsize(struct livebox *handler, int *w, int *h);
 423
 424 /*!
 425  * \brief List of supported sizes of given handler
 426  * \param[in] handler
 427  * \param[out] cnt
 428  * \param[out] w
 429  * \param[out] h
 430  * \return int
 431  */
 432 extern int livebox_get_supported_sizes(struct livebox *handler, int *cnt, int *size_list);
 433
 434 /*!
 435  * \brief BUFFER SIZE of the livebox if it is a buffer type
 436  * \param[in] handler
 437  * \return int
 438  */
 439 extern int livebox_lbfb_bufsz(struct livebox *handler);
 440
 441 /*!
 442  * \brief BUFFER SIZE of the progiressive disclosure if it is a buffer type
 443  * \param[in] handler
 444  * \return int
 445  */
 446 extern int livebox_pdfb_bufsz(struct livebox *handler);
 447
 448 /*!
 449  * \brief Send the content event (for buffer type) to provider(livebox)
 450  * \param[in] handler
 451  * \param[in] type
 452  * \param[in] x
 453  * \param[in] y
 454  */
 455 extern int livebox_content_event(struct livebox *handler, enum content_event_type type, double x, double y);
 456
 457 /*!
 458  * \brief Do pin up or not.
 459  * \param[in] handler
 460  * \param[in] flag
 461  * \param[in] cb
 462  * \param[in] data
 463  * \return int
 464  */
 465 extern int livebox_set_pinup(struct livebox *handler, int flag, ret_cb_t cb, void *data);
 466
 467 /*!
 468  * \brief Check the PIN-UP status of given handler
 469  * \param[in] handler
 470  * \return int
 471  */
 472 extern int livebox_is_pinned_up(struct livebox *handler);
 473
 474 /*!
 475  * \brief Check the PINUP feature availability of the given handler
 476  * \param[in] handler
 477  * \return int
 478  */
 479 extern int livebox_has_pinup(struct livebox *handler);
 480
 481 /*!
 482  * \brief Check the PD existence of given handler
 483  * \param[in] handler
 484  * \return int
 485  */
 486 extern int livebox_has_pd(struct livebox *handler);
 487
 488 /*!
 489  * \brief Create the PD of given handler
 490  * \param[in] handler
 491  * \param[in] cb
 492  * \param[in] data
 493  * \return int
 494  */
 495 extern int livebox_create_pd(struct livebox *handler, ret_cb_t cb, void *data);
 496
 497 /*!
 498  * \brief Create the PD of given handler with the relative position from livebox
 499  * \param[in] handler
 500  * \param[in] x 0.0 ~ 1.0
 501  * \param[in] y 0.0 ~ 1.0
 502  * \param[in] cb
 503  * \param[in] data
 504  * \return int
 505  */
 506 extern int livebox_create_pd_with_position(struct livebox *handler, double x, double y, ret_cb_t cb, void *data);
 507
 508 /*!
 509  * \brief Destroy the PD of given handler if it is created.
 510  * \param[in] handler
 511  * \param[in] cb
 512  * \param[in] data
 513  * \return int
 514  */
 515 extern int livebox_destroy_pd(struct livebox *handler, ret_cb_t cb, void *data);
 516
 517 /*!
 518  * \brief Check the create status of given livebox handler
 519  * \param[in] handler
 520  * \return int
 521  */
 522 extern int livebox_pd_is_created(struct livebox *handler);
 523
 524 /*!
 525  * \brief Check the content type of the progressive disclosure of given handler
 526  * \param[in] handler
 527  * \return int
 528  */
 529 extern enum livebox_pd_type livebox_pd_type(struct livebox *handler);
 530
 531 /*!
 532  * \brief Check the existence of a livebox about given package name
 533  * \param[in] pkgname
 534  * \return int
 535  */
 536 extern int livebox_is_exists(const char *pkgname);
 537
 538 /*!
 539  * \brief Set function table for parsing the text content of a livebox
 540  * \param[in] handler
 541  * \param[in] ops
 542  * \return int
 543  */
 544 extern int livebox_set_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
 545
 546 /*!
 547  * \brief Set function table for parsing the text content of a Progressive Disclosure
 548  * \param[in] handler
 549  * \param[in] ops
 550  * \return int
 551  */
 552 extern int livebox_set_pd_text_handler(struct livebox *handler, struct livebox_script_operators *ops);
 553
 554 /*!
 555  * \brief Emit a text signal to given livebox only if it is a text type.
 556  * \param[in] handler
 557  * \param[in] emission
 558  * \param[in] source
 559  * \param[in] sx
 560  * \param[in] sy
 561  * \param[in] ex
 562  * \param[in] ey
 563  * \param[in] cb
 564  * \param[in] data
 565  */
 566 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);
 567
 568 /*!
 569  * \brief Set a private data pointer to carry it using given handler
 570  * \param[in] handler
 571  * \param[in] data
 572  * \return int
 573  */
 574 extern int livebox_set_data(struct livebox *handler, void *data);
 575
 576 /*!
 577  * \brief Get private data pointer which is carried by given handler
 578  * \param[in] handler
 579  * \return int
 580  */
 581 extern void *livebox_get_data(struct livebox *handler);
 582
 583 /*!
 584  * \brief Subscribe the event for liveboxes only in given cluster and sub-cluster
 585  * \param[in] cluster   "*" can be used for subscribe all cluster's liveboxes event.
 586  *                      If you use the "*", value in the category will be ignored.
 587  * \param[in] category  "*" can be used for subscribe liveboxes events of all category(sub-cluster) in given "cluster"
 588  * \return int Success 0, fails error code
 589  */
 590 extern int livebox_subscribe_group(const char *cluster, const char *category);
 591
 592 /*!
 593  * \brief Unsubscribe the event for the liveboxes, but you will receive already added liveboxes event.
 594  * \param[in] cluster   "*" can be used for subscribe all cluster's liveboxes event.
 595  *                      If you use the "*", value in the category will be ignored.
 596  * \param[in] category  "*" can be used for subscribe all sub-cluster's liveboxes event in given "cluster"
 597  * \return int Success 0, fails error code
 598  */
 599 extern int livebox_unsubscribe_group(const char *cluster, const char *category);
 600
 601 /*!
 602  * \brief Refresh the group(cluster/sub-cluser(aka. category))
 603  * \param[in] cluster Cluster ID
 604  * \param[in] category Sub-cluster ID
 605  * \return int Success 0 or negative value
 606  */
 607 extern int livebox_refresh_group(const char *cluster, const char *category);
 608
 609 /*!
 610  * \brief Pixmap Id of a livebox content
 611  * \param[in] handler
 612  * \return int
 613  * \sa livebox_pd_pixmap
 614  */
 615 extern int livebox_lb_pixmap(const struct livebox *handler);
 616
 617 /*!
 618  * \brief Pixmap Id of a PD content
 619  * \param[in] handler
 620  * \return int
 621  * \sa livebox_lb_pixmap
 622  */
 623 extern int livebox_pd_pixmap(const struct livebox *handler);
 624
 625 /*!
 626  * \brief
 627  * \param[in] handler
 628  * \param[in] cb
 629  * \param[in] data
 630  * \return int
 631  * \sa livebox_release_pd_pixmap
 632  * \sa livebox_acquire_lb_pixmap
 633  */
 634 extern int livebox_acquire_pd_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
 635
 636 /*!
 637  * \brief Release the acquired pixmap ID
 638  * \param[in] handler
 639  * \param[in] pixmap
 640  * \return int
 641  * \sa livebox_acquire_pd_pixmap
 642  * \sa livebox_release_lb_pixmap
 643  */
 644 extern int livebox_release_pd_pixmap(struct livebox *handler, int pixmap);
 645
 646 /*!
 647  * \brief
 648  * \param[in] handler
 649  * \param[in] cb
 650  * \param[in] data
 651  * \return int
 652  * \sa livebox_release_lb_pixmap
 653  * \sa livebox_acquire_pd_pixmap
 654  */
 655 extern int livebox_acquire_lb_pixmap(struct livebox *handler, ret_cb_t cb, void *data);
 656
 657 /*!
 658  * \brief
 659  * \param[in] handler
 660  * \param[in] pixmap
 661  * \return int
 662  * \sa livebox_acquire_lb_pixmap
 663  * \sa livebox_release_pd_pixmap
 664  */
 665 extern int livebox_release_lb_pixmap(struct livebox *handler, int pixmap);
 666
 667 /*!
 668  * \brief Update the visible state of a livebox
 669  * \param[in] handler Handler of a livebox
 670  * \param[in] state Configure the current visible state of a livebox
 671  * \return int
 672  */
 673 extern int livebox_set_visibility(struct livebox *handler, enum livebox_visible_state state);
 674
 675 /*!
 676  * \brief Current visible state of a livebox
 677  * \param[in] handler Handler of a livebox
 678  * \return enum visible state
 679  */
 680 extern enum livebox_visible_state livebox_visibility(struct livebox *handler);
 681
 682 #ifdef __cplusplus
 683 }
 684 #endif
 685
 686 #endif
 687 /* End of a file */