A ctxpopup is a widget that, when shown, pops up a list of items.

It automatically chooses an area inside its parent object's view (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to optimally fit into it. In the default theme, it will also point an arrow to it's top left position at the time one shows it. Ctxpopup items have a label and/or an icon. It is intended for a small number of items (hence the use of list, not genlist).

This widget inherits from the Layout one, so that all the functions acting on it also work for context popup objects (

Since (EFL) :: 1.8).

This widget emits the following signals, besides the ones sent from Layout :

"dismissed" - this is called when the outside of ctxpopup was clicked or it's parent area is changed or the language is changed. and then ctxpopup is dismissed.

Default content parts of the ctxpopup widget that you can use for are:

"default" - A content of the ctxpopup

Default content parts of the ctxpopup items that you can use for are:

"icon" - An icon in the title area

Default text parts of the ctxpopup items that you can use for are:

"default" - Title label in the title area

Supported elm_object common APIs.

Supported elm_object_item common APIs.

Functions
Evas_Object *	elm_ctxpopup_add (Evas_Object *parent)
	Add a new Ctxpopup object to the parent.
void	elm_ctxpopup_hover_parent_set (Evas_Object obj, Evas_Object parent)
	Set the Ctxpopup's parent object.
Evas_Object *	elm_ctxpopup_hover_parent_get (const Evas_Object *obj)
	Get the Ctxpopup's parent.
void	elm_ctxpopup_clear (Evas_Object *obj)
	Clear all items in the given ctxpopup object.
void	elm_ctxpopup_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
	Change the ctxpopup's orientation to horizontal or vertical.
Eina_Bool	elm_ctxpopup_horizontal_get (const Evas_Object *obj)
	Get the value of current ctxpopup object's orientation.
Elm_Object_Item *	elm_ctxpopup_item_append (Evas_Object obj, const char label, Evas_Object icon, Evas_Smart_Cb func, const void data)
	Add a new item to a ctxpopup object.
void	elm_ctxpopup_direction_priority_set (Evas_Object *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth)
	Set the direction priority of a ctxpopup.
void	elm_ctxpopup_direction_priority_get (Evas_Object obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction *fourth)
	Get the direction priority of a ctxpopup.
Elm_Ctxpopup_Direction	elm_ctxpopup_direction_get (const Evas_Object *obj)
	Get the current direction of a ctxpopup.
void	elm_ctxpopup_dismiss (Evas_Object *obj)
	Dismiss a ctxpopup object.
Eina_Bool	elm_ctxpopup_direction_available_get (Evas_Object *obj, Elm_Ctxpopup_Direction direction)
void	elm_ctxpopup_auto_hide_disabled_set (Evas_Object *obj, Eina_Bool disabled)
	Set whether ctxpopup hide automatically or not when parent of ctxpopup is resized.

Enumeration Type Documentation

enum Elm_Ctxpopup_Direction

Enumeration of ctxpopup direction type.

Enumerator:

ELM_CTXPOPUP_DIRECTION_DOWN	ctxpopup show appear below clicked area
ELM_CTXPOPUP_DIRECTION_RIGHT	ctxpopup show appear to the right of the clicked area
ELM_CTXPOPUP_DIRECTION_LEFT	ctxpopup show appear to the left of the clicked area
ELM_CTXPOPUP_DIRECTION_UP	ctxpopup show appear above the clicked area
ELM_CTXPOPUP_DIRECTION_UNKNOWN	ctxpopup does not determine it's direction yet

Function Documentation

Evas_Object* elm_ctxpopup_add ( Evas_Object * parent )

Add a new Ctxpopup object to the parent.

Since :: 2.3.1

Parameters:

[in] parent Parent object

Returns:: New object or NULL, if it cannot be created

void elm_ctxpopup_auto_hide_disabled_set	(	Evas_Object *	obj,
		Eina_Bool	disabled
	)

Set whether ctxpopup hide automatically or not when parent of ctxpopup is resized.

Since :: 2.3.1

Parameters:

[in]	obj	Ctxpopup object
[in]	disabled	`EINA_TRUE` for not hiding, `EINA_FALSE` for hiding automatically

Use this function when user wants ctxpopup not to hide automatically. In default, ctxpopup is dismissed whenever mouse clicked its background area, language is changed, and its parent geometry is updated(changed). Not to hide ctxpopup automatically, disable auto hide function by calling this API, then ctxpopup won't be dismissed in those scenarios.

Default value of disabled is EINA_FALSE.

void elm_ctxpopup_clear ( Evas_Object * obj )

Clear all items in the given ctxpopup object.

Since :: 2.3.1

Parameters:

[in] obj Ctxpopup object

Eina_Bool elm_ctxpopup_direction_available_get	(	Evas_Object *	obj,
		Elm_Ctxpopup_Direction	direction
	)

brief Get the possibility that the direction would be available

Since :: 2.3.1

Parameters:

[in]	obj	The ctxpopup object
[in]	direction	A direction user wants to check

Use this function to check whether input direction is proper for ctxpopup. If ctxpopup cannot be at the direction since there is no sufficient area it can be,

Returns:: EINA_FALSE if you cannot put it in the direction. EINA_TRUE if it's possible.

Elm_Ctxpopup_Direction elm_ctxpopup_direction_get ( const Evas_Object * obj )

Get the current direction of a ctxpopup.

Since :: 2.3.1

Parameters:

[in] obj Ctxpopup object

Returns:: current direction of a ctxpopup

Warning:: Once the ctxpopup showed up, the direction would be determined

void elm_ctxpopup_direction_priority_get	(	Evas_Object *	obj,
		Elm_Ctxpopup_Direction *	first,
		Elm_Ctxpopup_Direction *	second,
		Elm_Ctxpopup_Direction *	third,
		Elm_Ctxpopup_Direction *	fourth
	)

Get the direction priority of a ctxpopup.

Since :: 2.3.1

Parameters:

[in]	obj	Ctxpopup object
[out]	first	1st priority of direction to be returned
[out]	second	2nd priority of direction to be returned
[out]	third	3th priority of direction to be returned
[out]	fourth	4th priority of direction to be returned

See also:: elm_ctxpopup_direction_priority_set() for more information.

void elm_ctxpopup_direction_priority_set	(	Evas_Object *	obj,
		Elm_Ctxpopup_Direction	first,
		Elm_Ctxpopup_Direction	second,
		Elm_Ctxpopup_Direction	third,
		Elm_Ctxpopup_Direction	fourth
	)

Set the direction priority of a ctxpopup.

Since :: 2.3.1

Parameters:

[in]	obj	Ctxpopup object
[in]	first	1st priority of direction
[in]	second	2nd priority of direction
[in]	third	3th priority of direction
[in]	fourth	4th priority of direction

This functions gives a chance to user to set the priority of ctxpopup showing direction. This doesn't guarantee the ctxpopup will appear in the requested direction.

See also:: Elm_Ctxpopup_Direction

void elm_ctxpopup_dismiss ( Evas_Object * obj )

Dismiss a ctxpopup object.

Since :: 2.3.1

Parameters:

[in] obj The ctxpopup object Use this function to simulate clicking outside the ctxpopup to dismiss it. In this way, the ctxpopup will be hidden and the "clicked" signal will be emitted.

Eina_Bool elm_ctxpopup_horizontal_get ( const Evas_Object * obj )

Get the value of current ctxpopup object's orientation.

Since :: 2.3.1

Parameters:

[in] obj Ctxpopup object

Returns:: EINA_TRUE for horizontal mode, EINA_FALSE for vertical mode (or errors)

See also:: elm_ctxpopup_horizontal_set()

void elm_ctxpopup_horizontal_set	(	Evas_Object *	obj,
		Eina_Bool	horizontal
	)

Change the ctxpopup's orientation to horizontal or vertical.

Since :: 2.3.1

Parameters:

[in]	obj	Ctxpopup object
[in]	horizontal	`EINA_TRUE` for horizontal mode, `EINA_FALSE` for vertical

Evas_Object* elm_ctxpopup_hover_parent_get ( const Evas_Object * obj )

Get the Ctxpopup's parent.

Since :: 2.3.1

Parameters:

[in] obj The ctxpopup object

Returns:: The parent object

See also:: elm_ctxpopup_hover_parent_set() for more information

void elm_ctxpopup_hover_parent_set	(	Evas_Object *	obj,
		Evas_Object *	parent
	)

Set the Ctxpopup's parent object.

Since :: 2.3.1

Remarks:: elm_ctxpopup_add() will automatically call this function with its parent argument.

Parameters:

[in]	obj	The ctxpopup object
[in]	parent	The parent to use

See also:: elm_ctxpopup_add()

Elm_Object_Item* elm_ctxpopup_item_append	(	Evas_Object *	obj,
		const char *	label,
		Evas_Object *	icon,
		Evas_Smart_Cb	func,
		const void *	data
	)

Add a new item to a ctxpopup object.

Since :: 2.3.1

Parameters:

[in]	obj	Ctxpopup object
[in]	label	The Label of the new item
[in]	icon	Icon to be set on new item
[in]	func	Convenience function called when item selected
[in]	data	Data passed to `func`

Returns:: A handle to the item added or NULL, on errors

Warning:: Ctxpopup can't hold both an item list and a content at the same time. When an item is added, any previous content will be removed.

See also:: elm_object_content_set()

Functions

Enumeration Type Documentation

Function Documentation