Tizen Native API
|
Functions | |
int | widget_viewer_evas_init (Evas_Object *win) |
Initializes the widget system. | |
int | widget_viewer_evas_fini (void) |
Finalizes the widget system. | |
Evas_Object * | widget_viewer_evas_add_widget (Evas_Object *parent, const char *widget_id, const char *content_info, double period) |
Creates a new widget object. | |
int | widget_viewer_evas_notify_resumed_status_of_viewer (void) |
Notifies the status of the viewer to all providers. | |
int | widget_viewer_evas_notify_paused_status_of_viewer (void) |
Notifies the status of the viewer to all providers. | |
int | widget_viewer_evas_notify_orientation_of_viewer (int orientation) |
Notifies the orientation of the viewer to all providers. | |
int | widget_viewer_evas_pause_widget (Evas_Object *widget) |
Pauses given widget. | |
int | widget_viewer_evas_resume_widget (Evas_Object *widget) |
Resume given widget. | |
int | widget_viewer_evas_set_option (widget_evas_conf_e type, int value) |
Changes the configurable values of widget system. | |
const char * | widget_viewer_evas_get_content_info (Evas_Object *widget) |
Gets content string of widget. | |
const char * | widget_viewer_evas_get_title_string (Evas_Object *widget) |
Gets summarized string of the widget content for accessibility. | |
const char * | widget_viewer_evas_get_widget_id (Evas_Object *widget) |
Gets the id of the widget. | |
double | widget_viewer_evas_get_period (Evas_Object *widget) |
Gets the update period of the widget. | |
void | widget_viewer_evas_cancel_click_event (Evas_Object *widget) |
Cancels click event procedure. | |
void | widget_viewer_evas_disable_preview (Evas_Object *widget) |
Hides the preview of the widget. | |
void | widget_viewer_evas_disable_overlay_text (Evas_Object *widget) |
Hides the help text of the widget. | |
void | widget_viewer_evas_disable_loading (Evas_Object *widget) |
Hides the loading message of the widget. | |
int | widget_viewer_evas_feed_mouse_up_event (Evas_Object *widget) |
Feeds the mouse_up event to the provider of the widget. | |
void | widget_viewer_evas_activate_faulted_widget (Evas_Object *widget) |
Activate a widget in faulted state. | |
bool | widget_viewer_evas_is_faulted (Evas_Object *widget) |
Check whether the widget is faulted. | |
int | widget_viewer_evas_freeze_visibility (Evas_Object *widget, widget_visibility_status_e status) |
Freezes visibility of the widget. | |
int | widget_viewer_evas_thaw_visibility (Evas_Object *widget) |
Thaws visibility of the widget. | |
bool | widget_viewer_evas_is_visibility_frozen (Evas_Object *widget) |
Get the frozen state of visibility option. | |
bool | widget_viewer_evas_is_widget (Evas_Object *widget) |
Validate the object, whether it is a widget object or not. | |
void | widget_viewer_evas_set_permanent_delete (Evas_Object *widget, int flag) |
Before delete a widget, set the deletion mode. | |
Typedefs | |
typedef struct widget_evas_event_info | widget_evas_event_info_s |
Data structure which will be sent as a parameter of smart callback for signals WIDGET_SMART_SIGNAL_XXX. | |
typedef enum widget_visibility_status | widget_visibility_status_e |
Enumerations for setting visibility status of a widget. | |
typedef enum widget_evas_conf | widget_evas_conf_e |
Configuration keys. | |
Defines | |
#define | WIDGET_VIEWER_EVAS_DEFAULT_PERIOD -1.0f |
Default refresh interval of widgets. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" |
Event name for smart callback of widget events: Widget creation is aborted. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" |
Event name for smart callback of widget events: Widget is created. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" |
Event name for smart callback of widget events: Resizing widget is aborted. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" |
Event name for smart callback of widget events: Widget is resized. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" |
Event name for smart callback of widget events: Widget has faulted. | |
#define | WIDGET_SMART_SIGNAL_UPDATED "updated" |
Event name for smart callback of widget events: Widget content is updated. | |
#define | WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" |
Event name for smart callback of widget events: Widget extra info is updated. | |
#define | WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" |
Event name for smart callback of widget events: Provider is disconnected. | |
#define | WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" |
Event name for smart callback of widget events: Control Scroller. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" |
Event name for smart callback of widget events: Widget is deleted. | |
#define | WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" |
Event name for smart callback of widget events: Period is changed. |
API for widget viewer (widget screen, home screen, ...)
#include <widget_viewer_evas.h>
Tizen Platform supports development of Widget Viewer Application. Many kinds of widgets can be installed to the Tizen Platform enhanced devices. Also it could be used by user via some kinds of viewer applications.
This document will show you what kinds of APIs are exist and how to use them.
First of all, the Tizen Platform uses the EFL as a core UIFW. So this API set also based on the EFL.
This API is related with the following feature:
#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" |
Event name for smart callback of widget events: Control Scroller.
#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" |
Event name for smart callback of widget events: Widget extra info is updated.
#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" |
Event name for smart callback of widget events: Period is changed.
#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" |
Event name for smart callback of widget events: Provider is disconnected.
#define WIDGET_SMART_SIGNAL_UPDATED "updated" |
Event name for smart callback of widget events: Widget content is updated.
#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" |
Event name for smart callback of widget events: Widget creation is aborted.
#define WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" |
Event name for smart callback of widget events: Widget is created.
#define WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" |
Event name for smart callback of widget events: Widget is deleted.
#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" |
Event name for smart callback of widget events: Widget has faulted.
#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" |
Event name for smart callback of widget events: Resizing widget is aborted.
#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" |
Event name for smart callback of widget events: Widget is resized.
#define WIDGET_VIEWER_EVAS_DEFAULT_PERIOD -1.0f |
Default refresh interval of widgets.
typedef enum widget_evas_conf widget_evas_conf_e |
typedef struct widget_evas_event_info widget_evas_event_info_s |
Data structure which will be sent as a parameter of smart callback for signals WIDGET_SMART_SIGNAL_XXX.
typedef enum widget_visibility_status widget_visibility_status_e |
Enumerations for setting visibility status of a widget.
enum widget_evas_conf |
Configuration keys.
Enumerations for setting visibility status of a widget.
void widget_viewer_evas_activate_faulted_widget | ( | Evas_Object * | widget | ) |
Activate a widget in faulted state.
A widget in faulted state MUST be activated before adding the widget.
[in] | widget | a widget object faulted |
Evas_Object* widget_viewer_evas_add_widget | ( | Evas_Object * | parent, |
const char * | widget_id, | ||
const char * | content_info, | ||
double | period | ||
) |
Creates a new widget object.
[in] | parent | Evas Object of parent |
[in] | widget_id | widget id |
[in] | content_info | Contents that will be given to the widget instance |
[in] | period | Update period (WIDGET_DEFAULT_PERIOD can be used for this; this argument will be used to specify the period of updating contents of a widget) |
NULL | if it fails to create a new widget object and you can get the reason of failure using get_last_result() |
void widget_viewer_evas_cancel_click_event | ( | Evas_Object * | widget | ) |
Cancels click event procedure.
If you call this function after feed the mouse_down(or mouse_set) event, the widget will get ON_HOLD events.
If a widget gets ON_HOLD event, it will not do anything even if you feed mouse_up(or mouse_unset) event.
[in] | widget | a widget object |
void widget_viewer_evas_disable_loading | ( | Evas_Object * | widget | ) |
Hides the loading message of the widget.
if you disable it, there is no preview & help text while creating a widget object
[in] | widget | a widget object |
void widget_viewer_evas_disable_overlay_text | ( | Evas_Object * | widget | ) |
Hides the help text of the widget.
While loading a box, hide the help text
[in] | widget | a widget object |
void widget_viewer_evas_disable_preview | ( | Evas_Object * | widget | ) |
Hides the preview of the widget.
[in] | widget | a widget object |
int widget_viewer_evas_feed_mouse_up_event | ( | Evas_Object * | widget | ) |
Feeds the mouse_up event to the provider of the widget.
This is very similar with widget_viewer_evas_cancel_click(), but this will sends mouse_up event explicitly.
Also feed the ON_HOLD event before feeds mouse_up event.
[in] | widget | a widget object |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
int widget_viewer_evas_fini | ( | void | ) |
Finalizes the widget system.
WIDGET_ERROR_NONE | If success |
WIDGET_ERROR_FAULT | Unrecoverable error occurred |
int widget_viewer_evas_freeze_visibility | ( | Evas_Object * | widget, |
widget_visibility_status_e | status | ||
) |
Freezes visibility of the widget.
If you don't want to change the visibility automatically, freeze it.
The visibility will not be changed even though a box disappeared(hidden)/displayed(shown) from/on the screen.
[in] | widget | a widget object |
[in] | status | a visibility status of the widget |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |
const char* widget_viewer_evas_get_content_info | ( | Evas_Object * | widget | ) |
Gets content string of widget.
This string can be used for creating contents of widget again after reboot a device or recovered from crash(abnormal status)
[in] | widget | a widget object |
NULL | if there is no specific content string. |
double widget_viewer_evas_get_period | ( | Evas_Object * | widget | ) |
Gets the update period of the widget.
[in] | widget | a widget object |
the | update interval of the widget |
const char* widget_viewer_evas_get_title_string | ( | Evas_Object * | widget | ) |
Gets summarized string of the widget content for accessibility.
If the accessibility feature is turned on, a viewer can use this text to describe the widget.
[in] | widget | a widget object |
NULL | if there is no summarized text for content of given widget. |
const char* widget_viewer_evas_get_widget_id | ( | Evas_Object * | widget | ) |
Gets the id of the widget.
[in] | widget | a widget object |
NULL | if an error occurred and you can get the reason of failure using get_last_result() |
int widget_viewer_evas_init | ( | Evas_Object * | win | ) |
Initializes the widget system.
[in] | win | Window object |
WIDGET_ERROR_NONE | If success |
WIDGET_ERROR_INVALID_PARAMETER | |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
bool widget_viewer_evas_is_faulted | ( | Evas_Object * | widget | ) |
Check whether the widget is faulted.
[in] | widget | a widget object |
true | for faulted state |
false | for not faulted state |
bool widget_viewer_evas_is_visibility_frozen | ( | Evas_Object * | widget | ) |
Get the frozen state of visibility option.
[in] | widget | a widget object |
true | for frozen state |
false | for not frozen state |
bool widget_viewer_evas_is_widget | ( | Evas_Object * | widget | ) |
Validate the object, whether it is a widget object or not.
[in] | widget | a widget object |
true | this is a widget |
false | this is not a widget |
int widget_viewer_evas_notify_orientation_of_viewer | ( | int | orientation | ) |
Notifies the orientation of the viewer to all providers.
If you call this, all providers will gets "rotated" event.
[in] | orientation | orientation of viewer |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_FAULT | if it failed to send state (resumed) info |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
int widget_viewer_evas_notify_paused_status_of_viewer | ( | void | ) |
Notifies the status of the viewer to all providers.
If you call this, all providers will gets "paused" event.
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_FAULT | if it failed to send state (resumed) info |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
int widget_viewer_evas_notify_resumed_status_of_viewer | ( | void | ) |
Notifies the status of the viewer to all providers.
If you call this, all providers will gets "resumed" event.
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_FAULT | if it failed to send state (paused) info |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
int widget_viewer_evas_pause_widget | ( | Evas_Object * | widget | ) |
Pauses given widget.
[in] | widget | a widget object |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
WIDGET_ERROR_FAULT | if it failed to send state (resumed) info |
int widget_viewer_evas_resume_widget | ( | Evas_Object * | widget | ) |
Resume given widget.
[in] | widget | a widget object |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |
WIDGET_ERROR_FAULT | if it failed to send state (resumed) info |
WIDGET_ERROR_PERMISSION_DENIED | Permission denied |
int widget_viewer_evas_set_option | ( | widget_evas_conf_e | type, |
int | value | ||
) |
Changes the configurable values of widget system.
[in] | type | Configuration item |
[in] | value | Its value |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |
void widget_viewer_evas_set_permanent_delete | ( | Evas_Object * | widget, |
int | flag | ||
) |
Before delete a widget, set the deletion mode.
[in] | widget | a widget object which will be deleted soon |
[in] | flag | Pass 1 if you delete this widget instance permanently, or pass 0 if you want to keep it and it will be re-created soon. |
int widget_viewer_evas_thaw_visibility | ( | Evas_Object * | widget | ) |
Thaws visibility of the widget.
If you want to let the visibility change automatically again, call this function.
[in] | widget | a widget object |
WIDGET_ERROR_NONE | if success |
WIDGET_ERROR_INVALID_PARAMETER | Invalid argument |