Enumerations | Functions
List

Enumerations

enum  Elm_List_Mode { ,
  ELM_LIST_SCROLL,
  ELM_LIST_LIMIT,
  ELM_LIST_EXPAND,
  ELM_LIST_LAST ,
  ELM_LIST_SCROLL,
  ELM_LIST_LIMIT,
  ELM_LIST_EXPAND,
  ELM_LIST_LAST
}
 Set list's resizing behavior, transverse axis scrolling and items cropping. More...
 
enum  Elm_List_Mode { ,
  ELM_LIST_SCROLL,
  ELM_LIST_LIMIT,
  ELM_LIST_EXPAND,
  ELM_LIST_LAST ,
  ELM_LIST_SCROLL,
  ELM_LIST_LIMIT,
  ELM_LIST_EXPAND,
  ELM_LIST_LAST
}
 Set list's resizing behavior, transverse axis scrolling and items cropping. More...
 

Functions

EINA_DEPRECATED void elm_list_bounce_set (Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
 Set bouncing behaviour when the scrolled content reaches an edge. More...
 
EINA_DEPRECATED void elm_list_bounce_get (const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
 Get the bouncing behaviour of the internal scroller. More...
 
EINA_DEPRECATED void elm_list_scroller_policy_set (Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v)
 Set the scrollbar policy. More...
 
EINA_DEPRECATED void elm_list_scroller_policy_get (const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v)
 Get the scrollbar policy. More...
 
EOAPI void elm_obj_list_horizontal_set (Eina_Bool horizontal)
 Control horizontal mode on the list object. More...
 
EOAPI Eina_Bool elm_obj_list_horizontal_get (void)
 Control horizontal mode on the list object. More...
 
EOAPI void elm_obj_list_select_mode_set (Elm_Object_Select_Mode mode)
 Control the list select mode. More...
 
EOAPI Elm_Object_Select_Mode elm_obj_list_select_mode_get (void)
 Control the list select mode. More...
 
EOAPI void elm_obj_list_focus_on_selection_set (Eina_Bool enabled)
 Control focus upon items selection mode. More...
 
EOAPI Eina_Bool elm_obj_list_focus_on_selection_get (void)
 Control focus upon items selection mode. More...
 
EOAPI void elm_obj_list_multi_select_set (Eina_Bool multi)
 Control multiple items selection on the list object. More...
 
EOAPI Eina_Bool elm_obj_list_multi_select_get (void)
 Control multiple items selection on the list object. More...
 
EOAPI void elm_obj_list_multi_select_mode_set (Elm_Object_Multi_Select_Mode mode)
 Control the list multi select mode. More...
 
EOAPI Elm_Object_Multi_Select_Mode elm_obj_list_multi_select_mode_get (void)
 Control the list multi select mode. More...
 
EOAPI void elm_obj_list_mode_set (Elm_List_Mode mode)
 Control which mode to use for the list object. More...
 
EOAPI Elm_List_Mode elm_obj_list_mode_get (void)
 Control which mode to use for the list object. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_selected_item_get (void)
 Get the selected item. More...
 
EOAPI const Eina_List * elm_obj_list_items_get (void)
 Get a list of all the list items. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_first_item_get (void)
 Get the first item in the list. More...
 
EOAPI const Eina_List * elm_obj_list_selected_items_get (void)
 Return a list of the currently selected list items. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_last_item_get (void)
 Get the last item in the list. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_item_insert_before (Elm_Widget_Item *before, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Insert a new item into the list object before item before. More...
 
EOAPI void elm_obj_list_go (void)
 Starts the list. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_item_insert_after (Elm_Widget_Item *after, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Insert a new item into the list object after item after. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_at_xy_item_get (Evas_Coord x, Evas_Coord y, int *posret)
 Get the item that is at the x, y canvas coords. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_item_append (const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Append a new item to the list object. More...
 
EOAPI Elm_Widget_Item * elm_obj_list_item_prepend (const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Prepend a new item to the list object. More...
 
EOAPI void elm_obj_list_clear (void)
 Remove all list's items.
 
EOAPI Elm_Widget_Item * elm_obj_list_item_sorted_insert (const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data, Eina_Compare_Cb cmp_func)
 Insert a new item into the sorted list object. More...
 
void elm_list_horizontal_set (Elm_List *obj, Eina_Bool horizontal)
 Control horizontal mode on the list object. More...
 
Eina_Bool elm_list_horizontal_get (const Elm_List *obj)
 Control horizontal mode on the list object. More...
 
void elm_list_select_mode_set (Elm_List *obj, Elm_Object_Select_Mode mode)
 Control the list select mode. More...
 
Elm_Object_Select_Mode elm_list_select_mode_get (const Elm_List *obj)
 Control the list select mode. More...
 
void elm_list_focus_on_selection_set (Elm_List *obj, Eina_Bool enabled)
 Control focus upon items selection mode. More...
 
Eina_Bool elm_list_focus_on_selection_get (const Elm_List *obj)
 Control focus upon items selection mode. More...
 
void elm_list_multi_select_set (Elm_List *obj, Eina_Bool multi)
 Control multiple items selection on the list object. More...
 
Eina_Bool elm_list_multi_select_get (const Elm_List *obj)
 Control multiple items selection on the list object. More...
 
void elm_list_multi_select_mode_set (Elm_List *obj, Elm_Object_Multi_Select_Mode mode)
 Control the list multi select mode. More...
 
Elm_Object_Multi_Select_Mode elm_list_multi_select_mode_get (const Elm_List *obj)
 Control the list multi select mode. More...
 
void elm_list_mode_set (Elm_List *obj, Elm_List_Mode mode)
 Control which mode to use for the list object. More...
 
Elm_List_Mode elm_list_mode_get (const Elm_List *obj)
 Control which mode to use for the list object. More...
 
Elm_Widget_Item * elm_list_selected_item_get (const Elm_List *obj)
 Get the selected item. More...
 
const Eina_List * elm_list_items_get (const Elm_List *obj)
 Get a list of all the list items. More...
 
Elm_Widget_Item * elm_list_first_item_get (const Elm_List *obj)
 Get the first item in the list. More...
 
const Eina_List * elm_list_selected_items_get (const Elm_List *obj)
 Return a list of the currently selected list items. More...
 
Elm_Widget_Item * elm_list_last_item_get (const Elm_List *obj)
 Get the last item in the list. More...
 
Elm_Widget_Item * elm_list_item_insert_before (Elm_List *obj, Elm_Widget_Item *before, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Insert a new item into the list object before item before. More...
 
void elm_list_go (Elm_List *obj)
 Starts the list. More...
 
Elm_Widget_Item * elm_list_item_insert_after (Elm_List *obj, Elm_Widget_Item *after, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Insert a new item into the list object after item after. More...
 
Elm_Widget_Item * elm_list_at_xy_item_get (const Elm_List *obj, Evas_Coord x, Evas_Coord y, int *posret)
 Get the item that is at the x, y canvas coords. More...
 
Elm_Widget_Item * elm_list_item_append (Elm_List *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Append a new item to the list object. More...
 
Elm_Widget_Item * elm_list_item_prepend (Elm_List *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data)
 Prepend a new item to the list object. More...
 
void elm_list_clear (Elm_List *obj)
 Remove all list's items.
 
Elm_Widget_Item * elm_list_item_sorted_insert (Elm_List *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data, Eina_Compare_Cb cmp_func)
 Insert a new item into the sorted list object. More...
 
Evas_Object * elm_list_add (Evas_Object *parent)
 Add a new list widget to the given parent Elementary (container) object. More...
 

Detailed Description

list_inheritance_tree.png
preview-00.png
list.png

A list widget is a container whose children are displayed vertically or horizontally, in order, and can be selected. The list can accept only one or multiple item selections. Also has many modes of items displaying.

A list is a very simple type of list widget. For more robust lists, Genlist should probably be used.

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

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

Available styles for it are:

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

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

Supported elm_object_item common APIs.

This widget implements the elm-scrollable-interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for lists.

Some calls on the list's API are marked as deprecated, as they just wrap the scrollable widgets counterpart functions. Use the ones we point you to, for each case of deprecation here, instead – eventually the deprecated ones will be discarded (next major release).

List of examples:

Enumeration Type Documentation

Set list's resizing behavior, transverse axis scrolling and items cropping.

See each mode's description for more details.

Note
Default value is Elm_List_Mode::ELM_LIST_SCROLL.

Values here don't work as bitmasks – only one can be chosen at a time.

See also elm_obj_list_mode_set, elm_obj_list_mode_get.

Enumerator
ELM_LIST_SCROLL 

The list won't set any of its size hints to inform how a possible container should resize it.

Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.

ELM_LIST_LIMIT 

Default value.

This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction.

ELM_LIST_EXPAND 

Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly).

More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally.

ELM_LIST_LAST 

Besides setting a minimum size on the transverse axis, just like on Elm_List_Mode::ELM_LIST_LIMIT, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.

. This is naturally bound by the list object's maximum size hints, set externally. Indicates error if returned by elm_list_mode_get().

ELM_LIST_SCROLL 

The list won't set any of its size hints to inform how a possible container should resize it.

Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.

ELM_LIST_LIMIT 

Default value.

This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction.

ELM_LIST_EXPAND 

Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly).

More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally.

ELM_LIST_LAST 

Besides setting a minimum size on the transverse axis, just like on Elm_List_Mode::ELM_LIST_LIMIT, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.

. This is naturally bound by the list object's maximum size hints, set externally. Indicates error if returned by elm_list_mode_get().

Set list's resizing behavior, transverse axis scrolling and items cropping.

See each mode's description for more details.

Note
Default value is Elm_List_Mode::ELM_LIST_SCROLL.

Values here don't work as bitmasks – only one can be chosen at a time.

See also elm_list_mode_set, elm_list_mode_get.

Enumerator
ELM_LIST_SCROLL 

The list won't set any of its size hints to inform how a possible container should resize it.

Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.

ELM_LIST_LIMIT 

Default value.

This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction.

ELM_LIST_EXPAND 

Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly).

More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally.

ELM_LIST_LAST 

Besides setting a minimum size on the transverse axis, just like on Elm_List_Mode::ELM_LIST_LIMIT, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.

. This is naturally bound by the list object's maximum size hints, set externally. Indicates error if returned by elm_list_mode_get().

ELM_LIST_SCROLL 

The list won't set any of its size hints to inform how a possible container should resize it.

Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction.

ELM_LIST_LIMIT 

Default value.

This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction.

ELM_LIST_EXPAND 

Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly).

More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally.

ELM_LIST_LAST 

Besides setting a minimum size on the transverse axis, just like on Elm_List_Mode::ELM_LIST_LIMIT, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time.

. This is naturally bound by the list object's maximum size hints, set externally. Indicates error if returned by elm_list_mode_get().

Function Documentation

Evas_Object* elm_list_add ( Evas_Object *  parent)

Add a new list widget to the given parent Elementary (container) object.

Parameters
parentThe parent object.
Returns
a new list widget handle or NULL, on errors.

This function inserts a new list widget on the canvas.

Elm_Widget_Item* elm_list_at_xy_item_get ( const Elm_List *  obj,
Evas_Coord  x,
Evas_Coord  y,
int *  posret 
)

Get the item that is at the x, y canvas coords.

This returns the item at the given coordinates (which are canvas relative, not object-relative). If an item is at that coordinate, that item handle is returned, and if posret is not NULL, the integer pointed to is set to a value of -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1). If NULL is returned as an item (no item found there), then posret may indicate -1 or 1 based if the coordinate is above or below all items respectively in the list.

Parameters
[in]yThe input y coordinate
[out]posretThe position relative to the item returned here
Returns
The item at the coordinates or NULL if none

References elm_obj_list_at_xy_item_get().

EINA_DEPRECATED void elm_list_bounce_get ( const Evas_Object *  obj,
Eina_Bool *  h_bounce,
Eina_Bool *  v_bounce 
)

Get the bouncing behaviour of the internal scroller.

Get whether the internal scroller should bounce when the edge of each axis is reached scrolling.

Parameters
objThe list object.
h_bouncePointer to store the bounce state of the horizontal axis.
v_bouncePointer to store the bounce state of the vertical axis.
Deprecated:
Use elm_scroller_bounce_get() instead.
See also
elm_scroller_bounce_get()
elm_list_bounce_set()
EINA_DEPRECATED void elm_list_bounce_set ( Evas_Object *  obj,
Eina_Bool  h_bounce,
Eina_Bool  v_bounce 
)

Set bouncing behaviour when the scrolled content reaches an edge.

Tell the internal scroller object whether it should bounce or not when it reaches the respective edges for each axis.

Parameters
objThe list object
h_bounceWhether to bounce or not in the horizontal axis.
v_bounceWhether to bounce or not in the vertical axis.
Deprecated:
Use elm_scroller_bounce_set() instead.
See also
elm_scroller_bounce_set()
Elm_Widget_Item* elm_list_first_item_get ( const Elm_List *  obj)

Get the first item in the list.

This returns the first item in the list.

Returns
The first item, or NULL if none

References elm_obj_list_first_item_get().

Eina_Bool elm_list_focus_on_selection_get ( const Elm_List *  obj)

Control focus upon items selection mode.

When enabled, every selection of an item inside the genlist will automatically set focus to its first focusable widget from the left. This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a focusable widget inside an item will couse this particular item to get focus as usual.

Returns
The tree effect status (true = enabled, false = disabled)

References elm_obj_list_focus_on_selection_get().

void elm_list_focus_on_selection_set ( Elm_List *  obj,
Eina_Bool  enabled 
)

Control focus upon items selection mode.

When enabled, every selection of an item inside the genlist will automatically set focus to its first focusable widget from the left. This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a focusable widget inside an item will couse this particular item to get focus as usual.

Parameters
[in]enabledThe tree effect status (true = enabled, false = disabled)

References elm_obj_list_focus_on_selection_set().

void elm_list_go ( Elm_List *  obj)

Starts the list.

Note
Call before running show() on the list object. Warning: If not called, it won't display the list properly.

References elm_obj_list_go().

Eina_Bool elm_list_horizontal_get ( const Elm_List *  obj)

Control horizontal mode on the list object.

Note
Vertical mode is set by default.

On horizontal mode items are displayed on list from left to right, instead of from top to bottom. Also, the list will scroll horizontally. Each item will presents left icon on top and right icon, or end, at the bottom.

Returns
true to enable horizontal or false to disable it, i.e., to enable vertical mode.

References elm_obj_list_horizontal_get().

void elm_list_horizontal_set ( Elm_List *  obj,
Eina_Bool  horizontal 
)

Control horizontal mode on the list object.

Note
Vertical mode is set by default.

On horizontal mode items are displayed on list from left to right, instead of from top to bottom. Also, the list will scroll horizontally. Each item will presents left icon on top and right icon, or end, at the bottom.

Parameters
[in]horizontaltrue to enable horizontal or false to disable it, i.e., to enable vertical mode.

References elm_obj_list_horizontal_set().

Elm_Widget_Item* elm_list_item_append ( Elm_List *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Append a new item to the list object.

A new item will be created and appended to the list, i.e., will be set as last item.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

References elm_obj_list_item_append().

Elm_Widget_Item* elm_list_item_insert_after ( Elm_List *  obj,
Elm_Widget_Item *  after,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the list object after item after.

A new item will be created and added to the list. Its position in this list will be just after item after.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]labelThe label of the list item.
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

References elm_obj_list_item_insert_after().

Elm_Widget_Item* elm_list_item_insert_before ( Elm_List *  obj,
Elm_Widget_Item *  before,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the list object before item before.

A new item will be created and added to the list. Its position in this list will be just before item before.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]labelThe label of the list item.
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

References elm_obj_list_item_insert_before().

Elm_Widget_Item* elm_list_item_prepend ( Elm_List *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Prepend a new item to the list object.

A new item will be created and prepended to the list, i.e., will be set as first item.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

References elm_obj_list_item_prepend().

Elm_Widget_Item* elm_list_item_sorted_insert ( Elm_List *  obj,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data,
Eina_Compare_Cb  cmp_func 
)

Insert a new item into the sorted list object.

Note
This function inserts values into a list object assuming it was sorted and the result will be sorted.

A new item will be created and added to the list. Its position in this list will be found comparing the new item with previously inserted items using function cmp_func.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
[in]cmp_funcThe comparing function to be used to sort list items by #Elm.Widget_Item item handles. This function will receive two items and compare them, returning a non-negative integer if the second item should be place after the first, or negative value if should be placed before.
Returns
The created item or NULL upon failure.

References elm_obj_list_item_sorted_insert().

const Eina_List* elm_list_items_get ( const Elm_List *  obj)

Get a list of all the list items.

Returns
A list of list items, #Elm.Widget_Item, or NULL on failure.

References elm_obj_list_items_get().

Elm_Widget_Item* elm_list_last_item_get ( const Elm_List *  obj)

Get the last item in the list.

This returns the last item in the list.

Returns
The last item, or NULL if none

References elm_obj_list_last_item_get().

Elm_List_Mode elm_list_mode_get ( const Elm_List *  obj)

Control which mode to use for the list object.

Set list's resize behavior, transverse axis scroll and items cropping. See each mode's description for more details.

Note
Default value is ELM_LIST_SCROLL.

Only one mode at a time can be set. If a previous one was set, it will be changed by the new mode after this call. Bitmasks won't work here as well.

Warning
This function's behavior will clash with those of elm_scroller_content_min_limit(), so use either one of them, but not both.
Returns
One of Elm_List_Mode: #ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT or ELM_LIST_EXPAND.

References elm_obj_list_mode_get().

void elm_list_mode_set ( Elm_List *  obj,
Elm_List_Mode  mode 
)

Control which mode to use for the list object.

Set list's resize behavior, transverse axis scroll and items cropping. See each mode's description for more details.

Note
Default value is ELM_LIST_SCROLL.

Only one mode at a time can be set. If a previous one was set, it will be changed by the new mode after this call. Bitmasks won't work here as well.

Warning
This function's behavior will clash with those of elm_scroller_content_min_limit(), so use either one of them, but not both.
Parameters
[in]modeOne of Elm_List_Mode: #ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT or ELM_LIST_EXPAND.

References elm_obj_list_mode_set().

Eina_Bool elm_list_multi_select_get ( const Elm_List *  obj)

Control multiple items selection on the list object.

Disabled by default. If disabled, the user can select a single item of the list each time. Selected items are highlighted on list. If enabled, many items can be selected.

If a selected item is selected again, it will be unselected.

Returns
true to enable multi selection or false to disable it.

References elm_obj_list_multi_select_get().

Elm_Object_Multi_Select_Mode elm_list_multi_select_mode_get ( const Elm_List *  obj)

Control the list multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked. - #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.

See: elm_list_multi_select_get

Returns
The multi select mode
Since
1.8

References elm_obj_list_multi_select_mode_get().

void elm_list_multi_select_mode_set ( Elm_List *  obj,
Elm_Object_Multi_Select_Mode  mode 
)

Control the list multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked. - #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.

See: elm_list_multi_select_get

Parameters
[in]modeThe multi select mode
Since
1.8

References elm_obj_list_multi_select_mode_set().

void elm_list_multi_select_set ( Elm_List *  obj,
Eina_Bool  multi 
)

Control multiple items selection on the list object.

Disabled by default. If disabled, the user can select a single item of the list each time. Selected items are highlighted on list. If enabled, many items can be selected.

If a selected item is selected again, it will be unselected.

Parameters
[in]multitrue to enable multi selection or false to disable it.

References elm_obj_list_multi_select_set().

EINA_DEPRECATED void elm_list_scroller_policy_get ( const Evas_Object *  obj,
Elm_Scroller_Policy policy_h,
Elm_Scroller_Policy policy_v 
)

Get the scrollbar policy.

See also
elm_list_scroller_policy_get() for details.
Parameters
objThe list object.
policy_hPointer to store horizontal scrollbar policy.
policy_vPointer to store vertical scrollbar policy.
Deprecated:
Use elm_scroller_policy_get() instead.
EINA_DEPRECATED void elm_list_scroller_policy_set ( Evas_Object *  obj,
Elm_Scroller_Policy  policy_h,
Elm_Scroller_Policy  policy_v 
)

Set the scrollbar policy.

Parameters
objThe list object
policy_hHorizontal scrollbar policy.
policy_vVertical scrollbar policy.

This sets the scrollbar visibility policy for the given scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies respectively for the horizontal and vertical scrollbars.

The both are disabled by default, i.e., are set to ELM_SCROLLER_POLICY_OFF.

Deprecated:
Use elm_scroller_policy_set() instead.
Elm_Object_Select_Mode elm_list_select_mode_get ( const Elm_List *  obj)

Control the list select mode.

elm_list_select_mode_set() changes item select mode in the list widget. - #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and callback when first becoming selected. Any further clicks will do nothing, unless you set always select mode. - #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected, every click will make the selected callbacks be called. - #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.

Returns
The select mode

References elm_obj_list_select_mode_get().

void elm_list_select_mode_set ( Elm_List *  obj,
Elm_Object_Select_Mode  mode 
)

Control the list select mode.

elm_list_select_mode_set() changes item select mode in the list widget. - #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and callback when first becoming selected. Any further clicks will do nothing, unless you set always select mode. - #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected, every click will make the selected callbacks be called. - #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.

Parameters
[in]modeThe select mode

References elm_obj_list_select_mode_set().

Elm_Widget_Item* elm_list_selected_item_get ( const Elm_List *  obj)

Get the selected item.

The selected item can be unselected with function elm_list_item_selected_set().

The selected item always will be highlighted on list.

Returns
The selected list item.

References elm_obj_list_selected_item_get().

const Eina_List* elm_list_selected_items_get ( const Elm_List *  obj)

Return a list of the currently selected list items.

Multiple items can be selected if multi select is enabled. It can be done with elm_list_multi_select_set().

Returns
An list of list items, #Elm.Widget_Item, or NULL on failure.

References elm_obj_list_selected_items_get().

EOAPI Elm_Widget_Item* elm_obj_list_at_xy_item_get ( Evas_Coord  x,
Evas_Coord  y,
int *  posret 
)

Get the item that is at the x, y canvas coords.

This returns the item at the given coordinates (which are canvas relative, not object-relative). If an item is at that coordinate, that item handle is returned, and if posret is not NULL, the integer pointed to is set to a value of -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1). If NULL is returned as an item (no item found there), then posret may indicate -1 or 1 based if the coordinate is above or below all items respectively in the list.

Parameters
[in]yThe input y coordinate
[out]posretThe position relative to the item returned here
Returns
The item at the coordinates or NULL if none

Referenced by elm_list_at_xy_item_get().

EOAPI Elm_Widget_Item* elm_obj_list_first_item_get ( void  )

Get the first item in the list.

This returns the first item in the list.

Returns
The first item, or NULL if none

Referenced by elm_list_first_item_get().

EOAPI Eina_Bool elm_obj_list_focus_on_selection_get ( void  )

Control focus upon items selection mode.

When enabled, every selection of an item inside the genlist will automatically set focus to its first focusable widget from the left. This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a focusable widget inside an item will couse this particular item to get focus as usual.

Returns
The tree effect status (true = enabled, false = disabled)

Referenced by elm_list_focus_on_selection_get().

EOAPI void elm_obj_list_focus_on_selection_set ( Eina_Bool  enabled)

Control focus upon items selection mode.

When enabled, every selection of an item inside the genlist will automatically set focus to its first focusable widget from the left. This is true of course if the selection was made by clicking an unfocusable area in an item or selecting it with a key movement. Clicking on a focusable widget inside an item will couse this particular item to get focus as usual.

Parameters
[in]enabledThe tree effect status (true = enabled, false = disabled)

Referenced by elm_list_focus_on_selection_set().

EOAPI void elm_obj_list_go ( void  )

Starts the list.

Note
Call before running show() on the list object. Warning: If not called, it won't display the list properly.

Referenced by elm_list_go().

EOAPI Eina_Bool elm_obj_list_horizontal_get ( void  )

Control horizontal mode on the list object.

Note
Vertical mode is set by default.

On horizontal mode items are displayed on list from left to right, instead of from top to bottom. Also, the list will scroll horizontally. Each item will presents left icon on top and right icon, or end, at the bottom.

Returns
true to enable horizontal or false to disable it, i.e., to enable vertical mode.

Referenced by elm_list_horizontal_get().

EOAPI void elm_obj_list_horizontal_set ( Eina_Bool  horizontal)

Control horizontal mode on the list object.

Note
Vertical mode is set by default.

On horizontal mode items are displayed on list from left to right, instead of from top to bottom. Also, the list will scroll horizontally. Each item will presents left icon on top and right icon, or end, at the bottom.

Parameters
[in]horizontaltrue to enable horizontal or false to disable it, i.e., to enable vertical mode.

Referenced by elm_list_horizontal_set().

EOAPI Elm_Widget_Item* elm_obj_list_item_append ( const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Append a new item to the list object.

A new item will be created and appended to the list, i.e., will be set as last item.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

Referenced by elm_list_item_append().

EOAPI Elm_Widget_Item* elm_obj_list_item_insert_after ( Elm_Widget_Item *  after,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the list object after item after.

A new item will be created and added to the list. Its position in this list will be just after item after.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]labelThe label of the list item.
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

Referenced by elm_list_item_insert_after().

EOAPI Elm_Widget_Item* elm_obj_list_item_insert_before ( Elm_Widget_Item *  before,
const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Insert a new item into the list object before item before.

A new item will be created and added to the list. Its position in this list will be just before item before.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]labelThe label of the list item.
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

Referenced by elm_list_item_insert_before().

EOAPI Elm_Widget_Item* elm_obj_list_item_prepend ( const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data 
)

Prepend a new item to the list object.

A new item will be created and prepended to the list, i.e., will be set as first item.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
Returns
The created item or NULL upon failure.

Referenced by elm_list_item_prepend().

EOAPI Elm_Widget_Item* elm_obj_list_item_sorted_insert ( const char *  label,
Evas_Object *  icon,
Evas_Object *  end,
Evas_Smart_Cb  func,
const void *  data,
Eina_Compare_Cb  cmp_func 
)

Insert a new item into the sorted list object.

Note
This function inserts values into a list object assuming it was sorted and the result will be sorted.

A new item will be created and added to the list. Its position in this list will be found comparing the new item with previously inserted items using function cmp_func.

Items created with this method can be deleted with elm_object_item_del().

Associated data can be properly freed when item is deleted if a callback function is set with elm_object_item_del_cb_set().

If a function is passed as argument, it will be called every time this item is selected, i.e., the user clicks over an unselected item. If always select is enabled it will call this function every time user clicks over an item (already selected or not). If such function isn't needed, just passing NULL as func is enough. The same should be done for data.

Note
Remember that the label parameter is copied inside the list. So if an application dynamically allocated the label, the application should free the label after this call.
Parameters
[in]iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
[in]endThe icon object to use for the right side of the item. An icon can be any Evas object.
[in]funcThe function to call when the item is clicked.
[in]dataThe data to associate with the item for related callbacks.
[in]cmp_funcThe comparing function to be used to sort list items by #Elm.Widget_Item item handles. This function will receive two items and compare them, returning a non-negative integer if the second item should be place after the first, or negative value if should be placed before.
Returns
The created item or NULL upon failure.

Referenced by elm_list_item_sorted_insert().

EOAPI const Eina_List* elm_obj_list_items_get ( void  )

Get a list of all the list items.

Returns
A list of list items, #Elm.Widget_Item, or NULL on failure.

Referenced by elm_list_items_get().

EOAPI Elm_Widget_Item* elm_obj_list_last_item_get ( void  )

Get the last item in the list.

This returns the last item in the list.

Returns
The last item, or NULL if none

Referenced by elm_list_last_item_get().

EOAPI Elm_List_Mode elm_obj_list_mode_get ( void  )

Control which mode to use for the list object.

Set list's resize behavior, transverse axis scroll and items cropping. See each mode's description for more details.

Note
Default value is ELM_LIST_SCROLL.

Only one mode at a time can be set. If a previous one was set, it will be changed by the new mode after this call. Bitmasks won't work here as well.

Warning
This function's behavior will clash with those of elm_scroller_content_min_limit(), so use either one of them, but not both.
Returns
One of Elm_List_Mode: #ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT or ELM_LIST_EXPAND.

Referenced by elm_list_mode_get().

EOAPI void elm_obj_list_mode_set ( Elm_List_Mode  mode)

Control which mode to use for the list object.

Set list's resize behavior, transverse axis scroll and items cropping. See each mode's description for more details.

Note
Default value is ELM_LIST_SCROLL.

Only one mode at a time can be set. If a previous one was set, it will be changed by the new mode after this call. Bitmasks won't work here as well.

Warning
This function's behavior will clash with those of elm_scroller_content_min_limit(), so use either one of them, but not both.
Parameters
[in]modeOne of Elm_List_Mode: #ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT or ELM_LIST_EXPAND.

Referenced by elm_list_mode_set().

EOAPI Eina_Bool elm_obj_list_multi_select_get ( void  )

Control multiple items selection on the list object.

Disabled by default. If disabled, the user can select a single item of the list each time. Selected items are highlighted on list. If enabled, many items can be selected.

If a selected item is selected again, it will be unselected.

Returns
true to enable multi selection or false to disable it.

Referenced by elm_list_multi_select_get().

EOAPI Elm_Object_Multi_Select_Mode elm_obj_list_multi_select_mode_get ( void  )

Control the list multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked. - #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.

See: elm_obj_list_multi_select_get

Returns
The multi select mode
Since
1.8

Referenced by elm_list_multi_select_mode_get().

EOAPI void elm_obj_list_multi_select_mode_set ( Elm_Object_Multi_Select_Mode  mode)

Control the list multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked. - #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.

See: elm_obj_list_multi_select_get

Parameters
[in]modeThe multi select mode
Since
1.8

Referenced by elm_list_multi_select_mode_set().

EOAPI void elm_obj_list_multi_select_set ( Eina_Bool  multi)

Control multiple items selection on the list object.

Disabled by default. If disabled, the user can select a single item of the list each time. Selected items are highlighted on list. If enabled, many items can be selected.

If a selected item is selected again, it will be unselected.

Parameters
[in]multitrue to enable multi selection or false to disable it.

Referenced by elm_list_multi_select_set().

EOAPI Elm_Object_Select_Mode elm_obj_list_select_mode_get ( void  )

Control the list select mode.

elm_list_select_mode_set() changes item select mode in the list widget. - #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and callback when first becoming selected. Any further clicks will do nothing, unless you set always select mode. - #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected, every click will make the selected callbacks be called. - #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.

Returns
The select mode

Referenced by elm_list_select_mode_get().

EOAPI void elm_obj_list_select_mode_set ( Elm_Object_Select_Mode  mode)

Control the list select mode.

elm_list_select_mode_set() changes item select mode in the list widget. - #ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and callback when first becoming selected. Any further clicks will do nothing, unless you set always select mode. - #ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected, every click will make the selected callbacks be called. - #ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.

Parameters
[in]modeThe select mode

Referenced by elm_list_select_mode_set().

EOAPI Elm_Widget_Item* elm_obj_list_selected_item_get ( void  )

Get the selected item.

The selected item can be unselected with function elm_list_item_selected_set().

The selected item always will be highlighted on list.

Returns
The selected list item.

Referenced by elm_list_selected_item_get().

EOAPI const Eina_List* elm_obj_list_selected_items_get ( void  )

Return a list of the currently selected list items.

Multiple items can be selected if multi select is enabled. It can be done with elm_list_multi_select_set().

Returns
An list of list items, #Elm.Widget_Item, or NULL on failure.

Referenced by elm_list_selected_items_get().