This module provides functionalities about ui_menu.

Functions
int	ui_menu_set_content (ui_menu menu, Elm_Ctxpopup content)
	Replaces or sets a content of an ui_menu.
Elm_Ctxpopup *	ui_menu_get_content (const ui_menu *menu)
	Returns an ui_menu content.
Elm_Ctxpopup *	ui_menu_unset_content (ui_menu *menu)
	Unsets an ui_menu content.
int	ui_menu_activate (ui_menu *menu)
	Activates an ui_menu.
int	ui_menu_deactivate (ui_menu *menu)
	Deactivates an ui_menu.
bool	ui_menu_get_activated (const ui_menu *menu)
	Returns the active status of ui_menu.
Eo *	ui_menu_get_base (const ui_menu *menu)
	Gets a base object of an ui_menu.
int	ui_menu_get_degree (const ui_menu *menu)
	Gets a current ui_menu's degree.
ui_view *	ui_menu_get_view (const ui_menu *menu)
	Returns a view which is matched with this ui_menu.

Function Documentation

int ui_menu_activate ( ui_menu * menu )

Activates an ui_menu.

It makes ui_menu state as show.

Since :: 3.0

Parameters:

[in] menu An ui_menu instance

Returns:: 0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE	Successful
UI_VIEWMGR_ERROR_NOT_PERMITTED	menu instance is not set up yet
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: ui_menu_deactivate()

int ui_menu_deactivate ( ui_menu * menu )

Deactivates an ui_menu.

It makes ui_menu state as hide.

Since :: 3.0

Parameters:

[in] menu An ui_menu instance

Returns:: 0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE	Successful
UI_VIEWMGR_ERROR_NOT_PERMITTED	menu instance is not set up yet
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: ui_menu_activate()

bool ui_menu_get_activated ( const ui_menu * menu )

Returns the active status of ui_menu.

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] menu An ui_menu instance

Returns:: true if menu is activated, false otherwise

Exceptions:

UI_VIEWMGR_ERROR_NONE	Successfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: ui_menu_activate(); ui_menu_deactivate(); get_last_result()

Eo* ui_menu_get_base ( const ui_menu * menu )

Gets a base object of an ui_menu.

Normally, A base object can be used for a parent of ui_menu 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] menu An ui_menu instance

Returns:: Base object of ui_menu

Exceptions:

UI_VIEWMGR_ERROR_NONE	Successfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: get_last_result()

Elm_Ctxpopup* ui_menu_get_content ( const ui_menu * menu )

Returns an ui_menu 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] menu An ui_menu instance

Returns:: A content of ui_menu

Exceptions:

UI_VIEWMGR_ERROR_NONE	Successfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: ui_menu_set_content(); ui_menu_unset_content(); get_last_result()

int ui_menu_get_degree ( const ui_menu * menu )

Gets a current ui_menu'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] menu An ui_menu 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	menu is invalid

See also:: get_last_result()

ui_view* ui_menu_get_view ( const ui_menu * menu )

Returns a view which is matched with this ui_menu.

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] menu An ui_menu instance

Returns:: The view which is matched with ui_menu

Exceptions:

UI_VIEWMGR_ERROR_NONE	Successfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: get_last_result()

int ui_menu_set_content	(	ui_menu *	menu,
		Elm_Ctxpopup *	content
	)

Replaces or sets a content of an ui_menu.

Since :: 3.0

Parameters:

[in]	menu	An ui_menu object
[in]	content	ctxpopup object. It allows `NULL` for cancelling the previous content

Returns:: 0 on success, otherwise a negative error value

Return values:

UI_VIEWMGR_ERROR_NONE	Successful
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid or content is not a type of Elm_Ctxpopup

See also:: ui_menu_get_content(); ui_menu_unset_content()

Elm_Ctxpopup* ui_menu_unset_content ( ui_menu * menu )

Unsets an ui_menu 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] menu An ui_menu instance

Returns:: A previous content. If it wasn't, return NULL

Exceptions:

UI_VIEWMGR_ERROR_NONE	Successfully added
UI_VIEWMGR_ERROR_INVALID_PARAMETER	menu is invalid

See also:: ui_menu_set_content(); ui_menu_get_content(); get_last_result()

Functions

Function Documentation