Tizen Native API
7.0
|
This module provides functionalities about ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
Functions | |
ui_view * | ui_view_create (const char *name) TIZEN_DEPRECATED_API |
Creates an ui_view. | |
int | ui_view_set_content (ui_view *view, Eo *content) TIZEN_DEPRECATED_API |
Replaces or sets a content of ui_view. | |
Eo * | ui_view_get_content (const ui_view *view) TIZEN_DEPRECATED_API |
Returns a content of this view. | |
Eo * | ui_view_unset_content (ui_view *view) TIZEN_DEPRECATED_API |
Unsets a ui_view content. | |
int | ui_view_set_event_cb (ui_view *view, ui_view_event_type_e event_type, ui_view_event_cb event_cb, void *user_data) TIZEN_DEPRECATED_API |
Sets callback functions for handling view events. | |
Eo * | ui_view_get_base (const ui_view *view) TIZEN_DEPRECATED_API |
Gets a base object of ui_view. | |
int | ui_view_set_indicator (ui_view *view, ui_view_indicator indicator) TIZEN_DEPRECATED_API |
Sets the indicator mode of a ui_view. | |
ui_view_indicator | ui_view_get_indicator (const ui_view *view) TIZEN_DEPRECATED_API |
Returns the indicator mode of this view. | |
int | ui_view_set_available_rotations (ui_view *view, const int *rotations, unsigned int count) TIZEN_DEPRECATED_API |
Sets the array of view's available rotations. | |
const int * | ui_view_get_available_rotations (const ui_view *view, unsigned int *count) TIZEN_DEPRECATED_API |
Gets the array of view's available rotations. | |
int | ui_view_set_removable_content (ui_view *view, bool removable) TIZEN_DEPRECATED_API |
Sets content removable. | |
bool | ui_view_get_removable_content (const ui_view *view) TIZEN_DEPRECATED_API |
Returns a state of removable content. | |
int | ui_view_get_degree (const ui_view *view) TIZEN_DEPRECATED_API |
Gets the current view's degree. | |
ui_view_orientation_mode | ui_view_get_orientation_mode (const ui_view *view) TIZEN_DEPRECATED_API |
Gets current view's orientation mode. | |
int | ui_view_set_transition_style (ui_view *view, const char *style) TIZEN_DEPRECATED_API |
Sets transition style of a view. | |
const char * | ui_view_get_transition_style (const ui_view *view) TIZEN_DEPRECATED_API |
Returns a style name of this view. | |
ui_menu * | ui_view_get_menu (const ui_view *view) TIZEN_DEPRECATED_API |
Gets a ui_menu instance. | |
const char * | ui_view_get_name (const ui_view *view) TIZEN_DEPRECATED_API |
Returns a name of this view. | |
ui_view_state | ui_view_get_state (const ui_view *view) TIZEN_DEPRECATED_API |
Returns a state of this view. | |
int | ui_view_destroy (ui_view *view) TIZEN_DEPRECATED_API |
Destroys an ui_view. | |
Typedefs | |
typedef bool(* | ui_view_event_cb )(ui_view *view, void *user_data) |
The ui_view event callback function signature. |
Typedef Documentation
typedef bool(* ui_view_event_cb)(ui_view *view, void *user_data) |
The ui_view event callback function signature.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Parameters:
-
[in] view An ui_view instance [in] degree Current view's degree [in] data The user data to be passed to the given event_callback functions
- Returns:
- This is reserved
- See also:
- ui_view_event_type_e
- ui_view_set_event_cb
Enumeration Type Documentation
enum ui_view_event_type_e |
Enumeration for ui_view event type.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Enumerator:
Function Documentation
ui_view* ui_view_create | ( | const char * | name | ) |
Creates an ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- If you don't set a view name, you could not look up the view with it's name. The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] name View name
- Returns:
- The ui_view instance.
NULL
if failed
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_OUT_OF_MEMORY Fail to create new instance
int ui_view_destroy | ( | ui_view * | view | ) |
Destroys an ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Parameters:
-
[in] view An ui_view instance
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
const int* ui_view_get_available_rotations | ( | const ui_view * | view, |
unsigned int * | count | ||
) |
Gets the array of view's available rotations.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
NULL
will be returned if view or count is invalid. The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance [out] count The number of arrays of rotations
- Returns:
- The array of rotation values
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
Eo* ui_view_get_base | ( | const ui_view * | view | ) |
Gets a base object of ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- Normally, this base object can be used for a parent of a view content. The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- The base object of ui_view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- get_last_result()
Eo* ui_view_get_content | ( | const ui_view * | view | ) |
Returns a content of this view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- content of view. If no contents set yet,
NULL
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
int ui_view_get_degree | ( | const ui_view * | view | ) |
Gets the current view's degree.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- Current rotation degree,
-1
if it fails to get degree information
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- get_last_result()
ui_view_indicator ui_view_get_indicator | ( | const ui_view * | view | ) |
Returns the indicator mode of this view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
view An ui_view instance
- Returns:
- Indicator state of the given view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- ui_view_get_indicator()
- get_last_result()
ui_menu* ui_view_get_menu | ( | const ui_view * | view | ) |
Gets a ui_menu instance.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- The ui_menu that connected with given view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- get_last_result()
const char* ui_view_get_name | ( | const ui_view * | view | ) |
Returns a name of this view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- Name of view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- get_last_result()
ui_view_orientation_mode ui_view_get_orientation_mode | ( | const ui_view * | view | ) |
Gets current view's orientation mode.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- Current orientation mode, one of ui_view_orientation_mode
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
bool ui_view_get_removable_content | ( | const ui_view * | view | ) |
Returns a state of removable content.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
true
if the view's content is removable, otherwisefalse
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
ui_view_state ui_view_get_state | ( | const ui_view * | view | ) |
Returns a state of this view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- current state of view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
- See also:
- ui_view_state
- get_last_result()
const char* ui_view_get_transition_style | ( | const ui_view * | view | ) |
Returns a style name of this view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- Style name of view
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid
int ui_view_set_available_rotations | ( | ui_view * | view, |
const int * | rotations, | ||
unsigned int | count | ||
) |
Sets the array of view's available rotations.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- Set an array of rotation values. For instance, {0, 90, 180, 270}. These rotation values depends on the system support.
- Parameters:
-
[in] view An ui_view instance [in] rotations The array of rotation values [in] count The number of arrays of rotations
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER If view is invalid or count is less than 1 or rotations is invalid pointer UI_VIEWMGR_ERROR_OUT_OF_MEMORY Out of Memory UI_VIEWMGR_ERROR_NOT_PERMITTED Current view manager system is not set up
- See also:
- ui_view_get_available_rotations()
int ui_view_set_content | ( | ui_view * | view, |
Eo * | content | ||
) |
Replaces or sets a content of ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Parameters:
-
[in] view An ui_view instance [in] content A new content. It allows NULL
for canceling the previous content
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER if view is invalid
int ui_view_set_event_cb | ( | ui_view * | view, |
ui_view_event_type_e | event_type, | ||
ui_view_event_cb | event_cb, | ||
void * | user_data | ||
) |
Sets callback functions for handling view events.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- To unset the events, you can pass
NULL
to event_cb.
- Parameters:
-
[in] view An ui_view instance [in] event_type ui_view event type [in] event_cb The set of callback functions to handle view events [in] user_data The user data to be passed to the given event_callback functions
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER if view is invalid
- See also:
- ui_view_event_type_e
int ui_view_set_indicator | ( | ui_view * | view, |
ui_view_indicator | indicator | ||
) |
Sets the indicator mode of a ui_view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Parameters:
-
[in] view An ui_view instance [in] indicator The mode to set, one of ui_view_indicator
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER Invalid Parameters UI_VIEWMGR_ERROR_NOT_PERMITTED Current view manager system is not set up
- See also:
- ui_view_indicator
- ui_view_get_indicator()
int ui_view_set_removable_content | ( | ui_view * | view, |
bool | removable | ||
) |
Sets content removable.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Parameters:
-
[in] view An ui_view instance [in] removable If removable is true
, content of this view will be removed on unload state.false
otherwise
- Warning:
- You should not remove a view content manually on unload status if removable content is set
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER If view is invalid or count is less than 1 or rotations is invalid pointer
- See also:
- ui_view_get_removable_content()
int ui_view_set_transition_style | ( | ui_view * | view, |
const char * | style | ||
) |
Sets transition style of a view.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- style is reserved for supporting various kinds of view transition effects. The actual behaviors with this transition style is up to your frameworks. Default value of the style is NULL. and "none" represents none transition. If you don't like give any transition effects to this view, you can pass "none" as style.
- Parameters:
-
[in] view An ui_view instance [in] style A transition style name
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
UI_VIEWMGR_ERROR_NONE Successful UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid or style is not supported
- See also:
- ui_view_get_transition_style()
Eo* ui_view_unset_content | ( | ui_view * | view | ) |
Unsets a ui_view content.
- Deprecated:
- Deprecated since tizen 6.0.
- Since :
- 3.0
- Remarks:
- The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- Parameters:
-
[in] view An ui_view instance
- Returns:
- A previous content. If it wasn't, return
NULL
- Exceptions:
-
UI_VIEWMGR_ERROR_NONE Successfully added UI_VIEWMGR_ERROR_INVALID_PARAMETER view is invalid