Tizen Native API  4.0

This module provides functionalities about ui_popup.

Functions

ui_popup * ui_popup_create (ui_view *view)
 Creates an ui_popup.
int ui_popup_destroy (ui_popup *popup)
 Destroys an ui_popup.
int ui_popup_set_content (ui_popup *popup, Elm_Popup *content)
 Replaces or set a content of an ui_popup.
Elm_Popup * ui_popup_get_content (const ui_popup *popup)
 Returns a content object of ui_popup.
Elm_Popup * ui_popup_unset_content (ui_popup *popup)
 Unsets an ui_popup content.
int ui_popup_activate (ui_popup *popup)
 Activates an ui_popup.
int ui_popup_deactivate (ui_popup *popup)
 Deactivates an ui_popup.
bool ui_popup_get_activated (const ui_popup *popup)
 Returns the active status of ui_popup.
Eo * ui_popup_get_base (const ui_popup *popup)
 Gets a base object of an ui_popup.
int ui_popup_get_degree (const ui_popup *popup)
 Gets current ui_popup's degree.
ui_view * ui_popup_get_view (const ui_popup *popup)
 Returns a view which is matched with the ui_popup.

Function Documentation

int ui_popup_activate ( ui_popup *  popup)

Activates an ui_popup.

It makes ui_popup state as show.

Since :
3.0
Parameters:
[in]popupAn ui_popup instance
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_NOT_PERMITTEDpopup instance is not set up yet
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_deactivate()
ui_popup_get_activated()
ui_popup* ui_popup_create ( ui_view *  view)

Creates an ui_popup.

Since :
3.0
Remarks:
The instance of ui_popup is subordinated to the given ui_view. If the given ui_view is hidden or deactivated, this ui_popup will be also do same followed to its ui_view behaviors. The instance of ui_popup will be destroyed automatically when the ui_view is destroyed. The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
Parameters:
[in]viewAn instance of ui_view
Returns:
An ui_popup instance
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_OUT_OF_MEMORYFail to create new instance
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_destroy()
int ui_popup_deactivate ( ui_popup *  popup)

Deactivates an ui_popup.

It makes ui_popup state as hide.

Since :
3.0
Parameters:
[in]popupAn ui_popup instance
Returns:
0 on success, otherwise a negative error value.
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_NOT_PERMITTEDpopup instance is not set up yet
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_activate()
ui_popup_get_activated()
int ui_popup_destroy ( ui_popup *  popup)

Destroys an ui_popup.

Destroy an given ui_popup instance.

Since :
3.0
Parameters:
[in]popupAn ui_popup instance
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_create()
bool ui_popup_get_activated ( const ui_popup *  popup)

Returns the active status of ui_popup.

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]popupAn ui_popup instance
Returns:
true if ui_popup is activated, false otherwise
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_activate()
ui_popup_deactivate()
get_last_result()
Eo* ui_popup_get_base ( const ui_popup *  popup)

Gets a base object of an ui_popup.

Normally, A base object can be used for a parent of ui_popup content.

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]popupAn ui_popup instance
Returns:
Base object of popup
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
get_last_result()
Elm_Popup* ui_popup_get_content ( const ui_popup *  popup)

Returns a content object of ui_popup.

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]popupAn ui_popup instance
Returns:
A content of ui_popup
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_set_content()
ui_popup_unset_content()
get_last_result()
int ui_popup_get_degree ( const ui_popup *  popup)

Gets current ui_popup's degree.

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]popupAn ui_popup instance
Returns:
Current rotation degree, -1 if it fails to get degree information
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
get_last_result()
ui_view* ui_popup_get_view ( const ui_popup *  popup)

Returns a view which is matched with the ui_popup.

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]popupAn ui_popup instance
Returns:
The view which is matched with ui_popup
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
get_last_result()
int ui_popup_set_content ( ui_popup *  popup,
Elm_Popup *  content 
)

Replaces or set a content of an ui_popup.

Since :
3.0
Parameters:
[in]popupAn ui_popup instance
[in]contentpopup object. It allows NULL for canceling the previous content
Returns:
0 on success, otherwise a negative error value
Return values:
UI_VIEWMGR_ERROR_NONESuccessful
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid or content is not a type of Elm_Popup
See also:
ui_popup_get_content()
ui_popup_unset_content()
Elm_Popup* ui_popup_unset_content ( ui_popup *  popup)

Unsets an ui_popup content.

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]popupAn ui_popup instance
Returns:
A previous content. If it wasn't, return NULL
Exceptions:
UI_VIEWMGR_ERROR_NONESuccessfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETERpopup is invalid
See also:
ui_popup_get_content()
ui_popup_set_content()
get_last_result()