Macros | Functions
Combobox

Macros

#define ELM_COMBOBOX_CLASS   elm_combobox_class_get()
 Elementary combobox class.
 
#define ELM_COMBOBOX_EVENT_DISMISSED   (&(_ELM_COMBOBOX_EVENT_DISMISSED))
 Called when combobox was dismissed.
 
#define ELM_COMBOBOX_EVENT_EXPANDED   (&(_ELM_COMBOBOX_EVENT_EXPANDED))
 Called when combobox was expanded.
 
#define ELM_COMBOBOX_EVENT_ITEM_SELECTED   (&(_ELM_COMBOBOX_EVENT_ITEM_SELECTED))
 Called when combobox item was selected. More...
 
#define ELM_COMBOBOX_EVENT_ITEM_PRESSED   (&(_ELM_COMBOBOX_EVENT_ITEM_PRESSED))
 Called when combobox item was pressed. More...
 
#define ELM_COMBOBOX_EVENT_FILTER_DONE   (&(_ELM_COMBOBOX_EVENT_FILTER_DONE))
 Called when combobox filter was done. More...
 

Functions

Evas_Objectelm_combobox_add (Evas_Object *parent)
 Add a new Combobox object. More...
 
EOAPI Eina_Bool elm_obj_combobox_expanded_get (const Eo *obj)
 Returns whether the combobox is expanded. More...
 
EOAPI void elm_obj_combobox_hover_begin (Eo *obj)
 This triggers the combobox popup from code, the same as if the user had clicked the button. More...
 
EOAPI void elm_obj_combobox_hover_end (Eo *obj)
 This dismisses the combobox popup as if the user had clicked outside the hover. More...
 
Eina_Bool elm_combobox_expanded_get (const Elm_Combobox *obj)
 Returns whether the combobox is expanded. More...
 
void elm_combobox_hover_begin (Elm_Combobox *obj)
 This triggers the combobox popup from code, the same as if the user had clicked the button. More...
 
void elm_combobox_hover_end (Elm_Combobox *obj)
 This dismisses the combobox popup as if the user had clicked outside the hover. More...
 

Detailed Description

combobox_inheritance_tree.png
preview-00.png

A combobox is a button displaying an entry that pops up a list of items (automatically choosing the direction to display). It is a convenience widget to avoid the need to do all the piecing together yourself. It is intended for manipulating a large number of items in the combobox menu.

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

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

Default content parts of the combobox widget that you can use are the the same that you use with the Button

Default text parts of the combobox widget that you can use are the the same that you use with the Entry

Supported elm_object common APIs.

Supported elm_object_item common APIs.

See tutorial_combobox for an example.

Macro Definition Documentation

◆ ELM_COMBOBOX_EVENT_ITEM_SELECTED

#define ELM_COMBOBOX_EVENT_ITEM_SELECTED   (&(_ELM_COMBOBOX_EVENT_ITEM_SELECTED))

Called when combobox item was selected.

Returns
Efl_Object *

◆ ELM_COMBOBOX_EVENT_ITEM_PRESSED

#define ELM_COMBOBOX_EVENT_ITEM_PRESSED   (&(_ELM_COMBOBOX_EVENT_ITEM_PRESSED))

Called when combobox item was pressed.

Returns
Efl_Object *

◆ ELM_COMBOBOX_EVENT_FILTER_DONE

#define ELM_COMBOBOX_EVENT_FILTER_DONE   (&(_ELM_COMBOBOX_EVENT_FILTER_DONE))

Called when combobox filter was done.

Returns
Efl_Object *

Function Documentation

◆ elm_combobox_add()

Evas_Object* elm_combobox_add ( Evas_Object parent)

Add a new Combobox object.

Parameters
parentThe parent object
Returns
The new object or NULL if it cannot be created

◆ elm_obj_combobox_expanded_get()

EOAPI Eina_Bool elm_obj_combobox_expanded_get ( const Eo obj)

Returns whether the combobox is expanded.

This will return EINA_TRUE if the combobox is expanded or EINA_FALSE if it is not expanded.

Parameters
[in]objThe object.
Returns
true if combobox is expenaded, false otherwise
Since
1.17

Referenced by elm_combobox_expanded_get().

◆ elm_obj_combobox_hover_begin()

EOAPI void elm_obj_combobox_hover_begin ( Eo obj)

This triggers the combobox popup from code, the same as if the user had clicked the button.

Since
1.17

Referenced by elm_combobox_hover_begin().

◆ elm_obj_combobox_hover_end()

EOAPI void elm_obj_combobox_hover_end ( Eo obj)

This dismisses the combobox popup as if the user had clicked outside the hover.

Since
1.17

Referenced by elm_combobox_hover_end().

◆ elm_combobox_expanded_get()

Eina_Bool elm_combobox_expanded_get ( const Elm_Combobox *  obj)

Returns whether the combobox is expanded.

This will return EINA_TRUE if the combobox is expanded or EINA_FALSE if it is not expanded.

Parameters
[in]objThe object.
Returns
true if combobox is expenaded, false otherwise
Since
1.17

References elm_obj_combobox_expanded_get().

◆ elm_combobox_hover_begin()

void elm_combobox_hover_begin ( Elm_Combobox *  obj)

This triggers the combobox popup from code, the same as if the user had clicked the button.

Since
1.17

References elm_obj_combobox_hover_begin().

◆ elm_combobox_hover_end()

void elm_combobox_hover_end ( Elm_Combobox *  obj)

This dismisses the combobox popup as if the user had clicked outside the hover.

Since
1.17

References elm_obj_combobox_hover_end().