Tizen Native API
5.0
|
API for widget viewer (widget screen, home screen, ...).
Required Header
#include <widget_viewer_evas.h>
Overview
Tizen Platform supports development of Widget Viewer Application. Many kinds of widgets can be installed on 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 existing and how to use them. First of all, the Tizen Platform uses the EFL as a core UIFW. So this API set is also based on the EFL.
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) |
Resumes 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) |
Checks 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) |
Gets 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 deleting a widget, set the deletion mode. | |
const char * | widget_viewer_evas_get_widget_instance_id (Evas_Object *widget) |
Gets the widget object's instance ID. | |
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 |
Enumeration for configuration keys. | |
Defines | |
#define | WIDGET_VIEWER_EVAS_DEFAULT_PERIOD -1.0f |
Definition for default refresh interval of widgets. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" |
Event names for smart callback of widget events. You can listen some events from widget by calling evas_object_smart_callback_add. | |
#define | WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" |
#define | WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" |
#define | WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" |
#define | WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" |
#define | WIDGET_SMART_SIGNAL_UPDATED "updated" |
#define | WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" |
#define | WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" |
#define | WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" |
#define | WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" |
#define | WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" |
Define Documentation
#define WIDGET_SMART_SIGNAL_CONTROL_SCROLLER "control,scroller" |
Control Scroller
#define WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED "info,updated" |
Widget extra info is updated
#define WIDGET_SMART_SIGNAL_PERIOD_CHANGED "widget,period,changed" |
Period is changed
#define WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED "provider,disconnected" |
Provider is disconnected
#define WIDGET_SMART_SIGNAL_UPDATED "updated" |
Widget content is updated
#define WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED "widget,create,aborted" |
Event names for smart callback of widget events. You can listen some events from widget by calling evas_object_smart_callback_add.
- Since :
- 2.3.1
- See also:
- widget_evas_event_info_s
- evas_object_smart_callback_add Widget creation is aborted
#define WIDGET_SMART_SIGNAL_WIDGET_CREATED "widget,created" |
Widget is created
#define WIDGET_SMART_SIGNAL_WIDGET_DELETED "widget,deleted" |
Widget is deleted
#define WIDGET_SMART_SIGNAL_WIDGET_FAULTED "widget,faulted" |
Widget has faulted
#define WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED "widget,resize,aborted" |
Resizing widget is aborted
#define WIDGET_SMART_SIGNAL_WIDGET_RESIZED "widget,resized" |
Widget is resized
#define WIDGET_VIEWER_EVAS_DEFAULT_PERIOD -1.0f |
Definition for default refresh interval of widgets.
- Since :
- 2.3.1
Typedef Documentation
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.
- Since :
- 2.3.1
- See also:
- WIDGET_SMART_SIGNAL_WIDGET_CREATE_ABORTED
- WIDGET_SMART_SIGNAL_WIDGET_CREATED
- WIDGET_SMART_SIGNAL_WIDGET_RESIZE_ABORTED
- WIDGET_SMART_SIGNAL_WIDGET_RESIZED
- WIDGET_SMART_SIGNAL_WIDGET_FAULTED
- WIDGET_SMART_SIGNAL_UPDATED
- WIDGET_SMART_SIGNAL_EXTRA_INFO_UPDATED
- WIDGET_SMART_SIGNAL_PROVIDER_DISCONNECTED
- WIDGET_SMART_SIGNAL_CONTROL_SCROLLER
- WIDGET_SMART_SIGNAL_WIDGET_DELETED
- WIDGET_SMART_SIGNAL_PERIOD_CHANGED
typedef enum widget_visibility_status widget_visibility_status_e |
Enumerations for setting visibility status of a widget.
- Since :
- 2.3.1
- See also:
- widget_viewer_evas_freeze_visibility
Enumeration Type Documentation
enum widget_evas_conf |
Enumeration for configuration keys.
- Since :
- 2.3.1
- See also:
- widget_viewer_evas_set_option
- Enumerator:
enum widget_fault_type |
Enumerations for setting visibility status of a widget.
- Since :
- 2.3.1
- See also:
- widget_viewer_evas_freeze_visibility
Function Documentation
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object faulted
- Exceptions:
-
WIDGET_ERROR_NONE Successfully activate faulted widget WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] parent Evas Object of parent [in] widget_id Widget id [in] content_info Contents that will be given to the widget instance. This value is result of bundle_encode. [in] period Update period ( WIDGET_VIEWER_EVAS_DEFAULT_PERIOD
can be used for this; this argument will be used to specify the period of updating contents of a widget)
- Returns:
- Widget Object. NULL on error
- Exceptions:
-
WIDGET_ERROR_NONE Successfully added WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Failed to create instance WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_MAX_EXCEEDED Maximum number of instances exceeded
void widget_viewer_evas_cancel_click_event | ( | Evas_Object * | widget | ) |
Cancels click event procedure.
If you call this function after feeding 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.
- Since :
- 2.3.1
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget A widget object
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get period WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- This function should be called right after creating the widget object before resizing it.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Exceptions:
-
WIDGET_ERROR_NONE Successfully disabled loading text WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- This function should be called right after creating the widget object before resizing it.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Exceptions:
-
WIDGET_ERROR_NONE Successfully disabled overlay text WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
void widget_viewer_evas_disable_preview | ( | Evas_Object * | widget | ) |
Hides the preview of the widget.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- This function should be called right after creating the widget object before resizing it.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Exceptions:
-
WIDGET_ERROR_NONE Successfully disabled preview WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget a widget object
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE if success WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
int widget_viewer_evas_fini | ( | void | ) |
Finalizes the widget system.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_FAULT Unrecoverable error occurred WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
- See also:
- widget_viewer_evas_init
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget A widget object [in] status A visibility status of the widget
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- widget_visibility_status_e
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 rebooting a device or it can be recovered from crash(abnormal status).
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- Returned string should not be freed.
- The returned string is usable only before the widget is destroyed. If it's going to be needed after that, it should be copied.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Content string to be recognized content of the widget. This value is result of bundle_encode.
- Return values:
-
NULL if there is no specific content string
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get content string WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- Postcondition:
- Returned string should not be freed.
- See also:
- get_last_result()
double widget_viewer_evas_get_period | ( | Evas_Object * | widget | ) |
Gets the update period of the widget.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Period the update period of the widget.
- Return values:
-
The update interval of the widget
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get period WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- Returned string should not be freed.
- The returned string is usable only before the widget is destroyed. If it's going to be needed after that, it should be copied.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Title string to be used for summarizing the widget
- Return values:
-
NULL if there is no summarized text for content of given widget
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get title string WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
const char* widget_viewer_evas_get_widget_id | ( | Evas_Object * | widget | ) |
Gets the ID of the widget.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- Returned string should not be freed.
- The returned string is usable only before the widget is destroyed. If it's going to be needed after that, it should be copied.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Widget ID
- Return values:
-
NULL if an error occurred and you can get the reason of failure using get_last_result()
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get widget ID WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
const char* widget_viewer_evas_get_widget_instance_id | ( | Evas_Object * | widget | ) |
Gets the widget object's instance ID.
- Since :
- 4.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The returned instance ID should not be freed.
-
The returned widget instance ID is volatile. If the device reboots or the widget's process restarts, it will be changed.
So, you should not assume this value is a persistent one. - The returned string is usable only before the widget is destroyed. If it's going to be needed after that, it should be copied.
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- The widget's instance ID as a string, NULL in case of errors
- Exceptions:
-
WIDGET_ERROR_NONE Successfully retrieved the widget instance ID WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_FAULT Widget is not ready WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_INVALID_PARAMETER Invalid argument
- See also:
- get_last_result()
int widget_viewer_evas_init | ( | Evas_Object * | win | ) |
Initializes the widget system.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] win Window object
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_ALREADY_EXIST Already initialized WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
- See also:
- widget_viewer_evas_fini
bool widget_viewer_evas_is_faulted | ( | Evas_Object * | widget | ) |
Checks whether the widget is faulted.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Faulted state of the widget and you can get the result state of this function by using get_last_result()
- Return values:
-
True for faulted state False for not faulted state
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get the faulted state of the widget WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
bool widget_viewer_evas_is_visibility_frozen | ( | Evas_Object * | widget | ) |
Gets the frozen state of visibility option.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Fixed state of visibility and you can get the result state of this function by using get_last_result()
- Return values:
-
True for frozen state False for not frozen state
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get the state of visibility WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
bool widget_viewer_evas_is_widget | ( | Evas_Object * | widget | ) |
Validate the object, whether it is a widget object or not.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] widget A widget object
- Returns:
- Result of validation and you can get the result state of this function by using get_last_result()
- Return values:
-
True this is a widget False this is not a widget
- Exceptions:
-
WIDGET_ERROR_NONE Successfully get result of validation WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] orientation Orientation of viewer
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_FAULT If it failed to send state (resumed) info WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_FAULT If it failed to send state (resumed) info WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_FAULT If it failed to send state (paused) info WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
int widget_viewer_evas_pause_widget | ( | Evas_Object * | widget | ) |
Pauses given widget.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget A widget object
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
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 WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_DISABLED Widget is frozen by widget_viewer_evas_freeze_visibility()
int widget_viewer_evas_resume_widget | ( | Evas_Object * | widget | ) |
Resumes given widget.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget a widget object
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
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 WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_DISABLED Widget is frozen by widget_viewer_evas_freeze_visibility()
int widget_viewer_evas_set_option | ( | widget_evas_conf_e | type, |
int | value | ||
) |
Changes the configurable values of widget system.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] type Configuration item [in] value Its value
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_PERMISSION_DENIED Permission denied WIDGET_ERROR_NOT_SUPPORTED Not supported
- See also:
- widget_evas_conf
void widget_viewer_evas_set_permanent_delete | ( | Evas_Object * | widget, |
int | flag | ||
) |
Before deleting a widget, set the deletion mode.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[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
- Exceptions:
-
WIDGET_ERROR_NONE Successfully set the flag WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied
- See also:
- get_last_result()
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.
- Since :
- 2.3.1
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/widget.viewer
- Parameters:
-
[in] widget A widget object
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
WIDGET_ERROR_NONE If success WIDGET_ERROR_INVALID_PARAMETER Invalid argument WIDGET_ERROR_FAULT Not initialized WIDGET_ERROR_NOT_SUPPORTED Not supported WIDGET_ERROR_PERMISSION_DENIED Permission denied