Tizen Native API  5.0
UI Standard View

This module provides functionalities about ui_standard_view.

Functions

ui_standard_view * ui_standard_view_create (const char *name)
 Creates an ui_standard_view.
int ui_standard_view_set_title (ui_standard_view *view, const char *text)
 Sets a title text.
int ui_standard_view_set_sub_title (ui_standard_view *view, const char *text)
 Sets a subtitle text.
int ui_standard_view_set_title_badge (ui_standard_view *view, const char *badge_text)
 Sets a title badge text.
int ui_standard_view_set_title_right_btn (ui_standard_view *view, Elm_Button *title_right_btn)
 Sets a title_right_btn.
Elm_Button * ui_standard_view_get_title_right_btn (const ui_standard_view *view)
 Returns a title right button of the view.
Elm_Button * ui_standard_view_unset_title_right_btn (ui_standard_view *view)
 Unsets a title right button of title area.
int ui_standard_view_set_title_left_btn (ui_standard_view *view, Elm_Button *title_left_btn)
 Sets a title_left_btn.
Elm_Button * ui_standard_view_get_title_left_btn (const ui_standard_view *view)
 Returns a title left button of the view.
Elm_Button * ui_standard_view_unset_title_left_btn (ui_standard_view *view)
 Unsets a title left button of title area.
int ui_standard_view_set_toolbar (ui_standard_view *view, Elm_Toolbar *toolbar)
 Sets a toolbar below title.
Elm_Toolbar * ui_standard_view_get_toolbar (const ui_standard_view *view)
 Returns a toolbar of the view.
Elm_Toolbar * ui_standard_view_unset_toolbar (ui_standard_view *view)
 Unsets a toolbar.
int ui_standard_view_set_title_visible (ui_standard_view *view, bool visible, bool anim)
 Controls the title visible state.

Function Documentation

ui_standard_view* ui_standard_view_create ( const char *  name)

Creates an ui_standard_view.

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]nameView name
Returns:
The ui_view instance. NULL if failed
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_OUT_OF_MEMORYFail to create new instance
See also:
ui_view_destroy()
ui_viewmgr_get_view_by_name()
get_last_result()
Elm_Button* ui_standard_view_get_title_left_btn ( const ui_standard_view *  view)

Returns a title left button of the view.

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]viewAn ui_standard_view instance
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
Returns:
Title left button of the view
See also:
ui_standard_view_set_title_left_btn()
ui_standard_view_unset_title_left_btn()
get_last_result()
Elm_Button* ui_standard_view_get_title_right_btn ( const ui_standard_view *  view)

Returns a title right button of the view.

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]viewAn ui_standard_view instance
Returns:
Title right button of the view
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
See also:
ui_standard_view_set_title_right_btn()
ui_standard_view_unset_title_right_btn()
get_last_result()
Elm_Toolbar* ui_standard_view_get_toolbar ( const ui_standard_view *  view)

Returns a toolbar of the view.

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]viewAn ui_standard_view instance
Returns:
The toolbar of the given view
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
See also:
ui_standard_view_set_toolbar()
ui_standard_view_unset_toolbar()
get_last_result()
int ui_standard_view_set_sub_title ( ui_standard_view *  view,
const char *  text 
)

Sets a subtitle text.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]textThe label in the subtitle area
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_sub_title()
int ui_standard_view_set_title ( ui_standard_view *  view,
const char *  text 
)

Sets a title text.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]textThe label in the title area
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title()
int ui_standard_view_set_title_badge ( ui_standard_view *  view,
const char *  badge_text 
)

Sets a title badge text.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]badge_textThe label in the title badge area
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title_badge()
int ui_standard_view_set_title_left_btn ( ui_standard_view *  view,
Elm_Button *  title_left_btn 
)

Sets a title_left_btn.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]title_left_btnThe button in the left part of title area
Returns:
0 on success, otherwise a negative error value.
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESSif title_left_btn is same with the existing one
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title_left_btn()
ui_standard_view_unset_title_left_btn()
int ui_standard_view_set_title_right_btn ( ui_standard_view *  view,
Elm_Button *  title_right_btn 
)

Sets a title_right_btn.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]title_right_btnThe button in the right part of title area
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESSif title_right_btn is same with the existing one
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title_right_btn()
ui_standard_view_unset_title_right_btn()
int ui_standard_view_set_title_visible ( ui_standard_view *  view,
bool  visible,
bool  anim 
)

Controls the title visible state.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]visibleTitle state set as visible if the given param is true, otherwise title area set as invisible
[in]animTitle area will be shown with animation if the given param is true, otherwise title area will be shown without animation
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
int ui_standard_view_set_toolbar ( ui_standard_view *  view,
Elm_Toolbar *  toolbar 
)

Sets a toolbar below title.

Since :
3.0
Parameters:
[in]viewAn ui_standard_view instance
[in]toolbarToolbar object
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERif view is invalid
UI_VIEWMGR_ERROR_ALREADY_IN_PROGRESSif toolbar is already existing
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_toolbar()
ui_standard_view_unset_toolbar()
get_last_result()
Elm_Button* ui_standard_view_unset_title_left_btn ( ui_standard_view *  view)

Unsets a title left button of title area.

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]viewAn ui_standard_view instance
Returns:
A previous content. If it wasn't, return NULL
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title_left_btn()
ui_standard_view_set_title_left_btn()
get_last_result()
Elm_Button* ui_standard_view_unset_title_right_btn ( ui_standard_view *  view)

Unsets a title right button of title area.

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]viewAn ui_standard_view instance
Returns:
A previous content. If it wasn't, return NULL
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
UI_VIEWMGR_ERROR_RESULT_OUT_OF_RANGEInstance is corrupted. Maybe base object is broken
See also:
ui_standard_view_get_title_right_btn()
ui_standard_view_set_title_right_btn()
get_last_result()
Elm_Toolbar* ui_standard_view_unset_toolbar ( ui_standard_view *  view)

Unsets a toolbar.

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]viewAn ui_standard_view instance
Returns:
A previous content. If it wasn't, return NULL
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERview is invalid
See also:
ui_standard_view_get_toolbar()
ui_standard_view_set_toolbar()
get_last_result()