EFL Widget Viewer

The Widget Viewer API provides functionality that displays and manages widget applications.

The main features of the Widget Viewer API include:

  • Displaying widgets

    You can create widget objects that can display a widget application’s buffer. The buffer is updated when the widget application updates its window.

  • Managing widget life-cycle

    You can manage the instance life-cycle of a created widget application.

  • Retrieving widget information

    You can retrieve the information of a created widget application.

Prerequisites

To enable your application to use the Widget Viewer functionality:

  1. To use the Widget Viewer API (in mobile and wearable applications), the application has to request permission by adding the following privilege to the tizen-manifest.xml file:

    <privileges>
   <privilege>http://tizen.org/privilege/widget.viewer</privilege>
</privileges>

  2. To use the functions of the Widget Viewer API, include the <widget_viewer_evas.h> header file in your application:

    #include <widget_viewer_evas.h>

Display Widgets

Widget application shares its window to the Widget Viewer application. To display the widget application’s buffer you have to create a widget object. The widget application’s buffer is displayed on the widget object. You can create the widget object:

  1. Initialize Widget Viewer using widget_viewer_evas_init(). The parameter of widget_viewer_evas_init() is the window object of an application:

    Evas_Object *win = elm_win_add(NULL, "VIEWER", ELM_WIN_BASIC);
int ret = widget_viewer_evas_init(win);

  2. Create a widget object using widget_viewer_evas_add_widget(). The parameters of widget_viewer_evas_add_widget() are parent Evas_Object, widget ID, content information, and widget update period. The widget ID is the widget application’s app ID or class ID. Content information is the bundle encoded data, which contains extra information on the widget:

    const char *content_info;
bundle_raw *raw;
int len;

bundle_encode(data, &raw, &len);
Evas_Object *widget = widget_viewer_evas_add_widget(win, "widget_id", (const char *)raw, 0.0);
evas_object_resize(widget, 100, 100);
evas_object_show(widget);

  3. Finalize the Widget Viewer functionality using widget_viewer_evas_fini():

    int ret = widget_viewer_evas_fini();

Manage Widget Life-cycle

After displaying a widget, you can manage the widget application’s lifecycle:

  1. Create a widget object using widget_viewer_evas_add_widget():

    Evas_Object *widget = widget_viewer_evas_add_widget(win, "widget_id", (const char *)raw, 0.0);

  2. Resume the instance of the widget application using widget_viewer_evas_resume_widget() with the widget object as the parameter:

    int ret = widget_viewer_evas_resume_widget(widget);

  3. Pause the instance of the widget application using widget_viewer_evas_pause_widget() with the widget object as the parameter:

    int ret = widget_viewer_evas_pause_widget(widget);

  4. Resume or pause all the widget instances displayed by the Widget Viewer application using widget_viewer_evas_notify_resumed_status_of_viewer() and widget_viewer_evas_notify_paused_status_of_viewer():

    int ret = widget_viewer_evas_notify_resumed_status_of_viewer();
ret = widget_viewer_evas_notify_paused_status_of_viewer();

Retrieve Widget Information

After displaying widget, you can retrieve information about widget instances:

  1. Create a widget object using widget_viewer_evas_add_widget():

    Evas_Object *widget = widget_viewer_evas_add_widget(win, "widget_id", (const char *)raw, 0.0);

  2. Get the content information using widget_viewer_evas_get_content_info() with the widget object as the parameter:

    const char *content = widget_viewer_evas_get_content_info(widget);

  3. Get the widget ID from the widget object using widget_viewer_evas_get_widget_id() with the widget object as the parameter:

    const char *widget_id = widget_viewer_evas_get_widget_id(widget);

  4. Get the widget update period from the widget object using widget_viewer_evas_get_period() with the widget object as the parameter:

    double period = widget_viewer_evas_get_period(widget);

  5. Get the widget instance ID from the widget object using widget_viewer_evas_get_widget_instance_id() with the widget object as the parameter:

    const char *instance_id = widget_viewer_evas_get_widget_instance_id(widget);
  • Dependencies
    • Tizen 2.4 and Higher for Mobile
    • Tizen 2.3.1 and Higher for Wearable
Edit this page