Hoversel

Macros
#define	ELM_HOVERSEL_CLASS   elm_hoversel_class_get()
	Elementary hoversel class.
#define	ELM_HOVERSEL_EVENT_DISMISSED   (&(_ELM_HOVERSEL_EVENT_DISMISSED))
	Called when hoversel is dismissed.
#define	ELM_HOVERSEL_EVENT_EXPANDED   (&(_ELM_HOVERSEL_EVENT_EXPANDED))
	Called when hoversel is expanded.
#define	ELM_HOVERSEL_EVENT_ITEM_FOCUSED   (&(_ELM_HOVERSEL_EVENT_ITEM_FOCUSED))
	Called when hoversel item got focus. More...
#define	ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED   (&(_ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED))
	Called when hoversel item lost focus. More...

Functions
Evas_Object *	elm_hoversel_add (Evas_Object *parent)
	Add a new Hoversel object. More...
EOAPI void	elm_obj_hoversel_horizontal_set (Eo *obj, Eina_Bool horizontal)
	Control if the hoversel should expand horizontally. More...
EOAPI Eina_Bool	elm_obj_hoversel_horizontal_get (const Eo *obj)
	Control if the hoversel should expand horizontally. More...
EOAPI void	elm_obj_hoversel_hover_parent_set (Eo *obj, Efl_Canvas_Object *parent)
	Control the hover parent. More...
EOAPI Efl_Canvas_Object *	elm_obj_hoversel_hover_parent_get (const Eo *obj)
	Control the hover parent. More...
EOAPI Eina_Bool	elm_obj_hoversel_expanded_get (const Eo *obj)
	Returns whether the hoversel is expanded. More...
EOAPI const Eina_List *	elm_obj_hoversel_items_get (const Eo *obj)
	Get the list of items within the given hoversel. More...
EOAPI void	elm_obj_hoversel_auto_update_set (Eo *obj, Eina_Bool auto_update)
	Update icon and text of hoversel same to those of selected item automatically. More...
EOAPI Eina_Bool	elm_obj_hoversel_auto_update_get (const Eo *obj)
	Update icon and text of hoversel same to those of selected item automatically. More...
EOAPI void	elm_obj_hoversel_hover_begin (Eo *obj)
	This triggers the hoversel popup from code, the same as if the user had clicked the button.
EOAPI void	elm_obj_hoversel_clear (Eo *obj)
	This will remove all the children items from the hoversel. More...
EOAPI void	elm_obj_hoversel_hover_end (Eo *obj)
	This dismisses the hoversel popup as if the user had clicked outside the hover.
EOAPI Elm_Widget_Item *	elm_obj_hoversel_item_add (Eo *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
	Add an item to the hoversel button. More...

Detailed Description

A hoversel is a button that pops up a list of items (automatically choosing the direction to display) that have a label and, optionally, an icon to select from. It is a convenience widget to avoid the need to do all the piecing together yourself. It is intended for a small number of items in the hoversel menu (no more than 8), though is capable of many more.

This widget inherits from the Button one, so that all the functions acting on it also work for hoversel objects.

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

• "clicked" - the user clicked the hoversel button and popped up the sel
• "selected" - an item in the hoversel list is selected. event_info is the selected item
• "dismissed" - the hover is dismissed
• "expanded" - This is called on clicking hoversel and elm_hoversel_hover_begin().
• "language,changed" - the program's language changed (since 1.9)
• "item,focused" - When the hoversel item has received focus. (since 1.10)
• "item,unfocused" - When the hoversel item has lost focus. (since 1.10)

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

• "icon" - An icon of the hoversel

Default text parts of the hoversel widget that you can use for are:

• "default" - A label of the hoversel

Supported elm_object common APIs.

• elm_object_disabled_set
• elm_object_disabled_get
• elm_object_part_text_set
• elm_object_part_text_get
• elm_object_part_content_set
• elm_object_part_content_unset

Supported elm_object_item common APIs.

• elm_object_item_del
• elm_object_item_part_text_get
• elm_object_item_signal_emit - this works only when the item is created.
• elm_object_item_style_set - this works only when the item is created.
• elm_object_item_style_get - this works only when the item is created.
• elm_object_item_focus_set - this works only when the item is created.
• elm_object_item_focus_get - this works only when the item is created.

See Hoversel example for an example.

Macro Definition Documentation

ELM_HOVERSEL_EVENT_ITEM_FOCUSED

#define ELM_HOVERSEL_EVENT_ITEM_FOCUSED   (&(_ELM_HOVERSEL_EVENT_ITEM_FOCUSED))

Called when hoversel item got focus.

Returns

Efl_Object *

ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED

#define ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED   (&(_ELM_HOVERSEL_EVENT_ITEM_UNFOCUSED))

Called when hoversel item lost focus.

Returns

Efl_Object *

Function Documentation

elm_hoversel_add()

Evas_Object * elm_hoversel_add

(

Evas_Object *

parent

)

Add a new Hoversel object.

Parameters

parent

The parent object

Returns

The new object or NULL if it cannot be created

References EINA_SAFETY_ON_NULL_RETURN_VAL.

elm_obj_hoversel_horizontal_set()

EOAPI void elm_obj_hoversel_horizontal_set	(	Eo *	obj,
		Eina_Bool	horizontal
	)

Control if the hoversel should expand horizontally.

Note

The initial button will display horizontally regradless of this setting.

Parameters

[in]	obj	The object.
[in]	horizontal	If true, the hover will expand horizontally to the right.

elm_obj_hoversel_horizontal_get()

EOAPI Eina_Bool elm_obj_hoversel_horizontal_get

(

const Eo *

obj

)

Control if the hoversel should expand horizontally.

Note

The initial button will display horizontally regradless of this setting.

Parameters

[in]

obj

The object.

Returns

If true, the hover will expand horizontally to the right.

elm_obj_hoversel_hover_parent_set()

EOAPI void elm_obj_hoversel_hover_parent_set	(	Eo *	obj,
		Efl_Canvas_Object *	parent
	)

Control the hover parent.

Sets the hover parent object, the area that will be darkened when the hoversel is clicked. Should probably be the window that the hoversel is in.

Parameters

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

elm_obj_hoversel_hover_parent_get()

EOAPI Efl_Canvas_Object * elm_obj_hoversel_hover_parent_get

(

const Eo *

obj

)

Control the hover parent.

Sets the hover parent object, the area that will be darkened when the hoversel is clicked. Should probably be the window that the hoversel is in.

Parameters

[in]

obj

The object.

Returns

The parent to use

elm_obj_hoversel_expanded_get()

EOAPI Eina_Bool elm_obj_hoversel_expanded_get

(

const Eo *

obj

)

Returns whether the hoversel is expanded.

Parameters

[in]

obj

The object.

Returns

true if the hoversel is expanded or false otherwise

elm_obj_hoversel_items_get()

EOAPI const Eina_List * elm_obj_hoversel_items_get

(

const Eo *

obj

)

Get the list of items within the given hoversel.

Parameters

[in]

obj

The object.

Returns

List of items

elm_obj_hoversel_auto_update_set()

EOAPI void elm_obj_hoversel_auto_update_set	(	Eo *	obj,
		Eina_Bool	auto_update
	)

Update icon and text of hoversel same to those of selected item automatically.

Parameters

[in]	obj	The object.
[in]	auto_update	true if hoversel is updated automatically or false otherwise

elm_obj_hoversel_auto_update_get()

EOAPI Eina_Bool elm_obj_hoversel_auto_update_get

(

const Eo *

obj

)

Update icon and text of hoversel same to those of selected item automatically.

Parameters

[in]

obj

The object.

Returns

true if hoversel is updated automatically or false otherwise

elm_obj_hoversel_clear()

EOAPI void elm_obj_hoversel_clear

(

Eo *

obj

)

This will remove all the children items from the hoversel.

Warning Should not be called while the hoversel is active; use elm_obj_hoversel_expanded_get to check first.

Parameters

[in]

obj

The object.

elm_obj_hoversel_item_add()

EOAPI Elm_Widget_Item * elm_obj_hoversel_item_add	(	Eo *	obj,
		const char *	label,
		const char *	icon_file,
		Elm_Icon_Type	icon_type,
		Evas_Smart_Cb	func,
		const void *	data
	)

Add an item to the hoversel button.

This adds an item to the hoversel to show when it is clicked. Note: if you need to use an icon from an edje file then use Elm.Hoversel.Item.icon.set right after this function, and set icon_file to null here.

Parameters

[in]	obj	The object.
[in]	label	The text label to use for the item (NULL if not desired)
[in]	icon_file	An image file path on disk to use for the icon or standard icon name (NULL if not desired)
[in]	icon_type	The icon type if relevant
[in]	func	Convenience function to call when this item is selected. The last parameter event_info of func is the selected item pointer.
[in]	data	Data to pass to item-related functions

Returns

A handle to the added item.