Enumerations | |
enum | Elm_List_Mode { ELM_LIST_COMPRESS = 0, 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 | |
Evas_Object * | elm_list_add (Evas_Object *parent) |
Add a new list widget to the given parent Elementary (container) object. | |
void | elm_list_go (Evas_Object *obj) |
Starts the list. | |
void | elm_list_multi_select_set (Evas_Object *obj, Eina_Bool multi) |
Enable or disable multiple items selection on the list object. | |
Eina_Bool | elm_list_multi_select_get (const Evas_Object *obj) |
Get a value whether multiple items selection is enabled or not. | |
void | elm_list_mode_set (Evas_Object *obj, Elm_List_Mode mode) |
Set which mode to use for the list object. | |
Elm_List_Mode | elm_list_mode_get (const Evas_Object *obj) |
Get the mode the list is at. | |
void | elm_list_horizontal_set (Evas_Object *obj, Eina_Bool horizontal) |
Enable or disable horizontal mode on the list object. | |
Eina_Bool | elm_list_horizontal_get (const Evas_Object *obj) |
Get a value whether horizontal mode is enabled or not. | |
void | elm_list_select_mode_set (Evas_Object *obj, Elm_Object_Select_Mode mode) |
Set the list select mode. | |
Elm_Object_Select_Mode | elm_list_select_mode_get (const Evas_Object *obj) |
Get the list select mode. | |
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. | |
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. | |
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. | |
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. | |
Elm_Object_Item * | elm_list_item_append (Evas_Object *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. | |
Elm_Object_Item * | elm_list_item_prepend (Evas_Object *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. | |
Elm_Object_Item * | elm_list_item_insert_before (Evas_Object *obj, Elm_Object_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 . | |
Elm_Object_Item * | elm_list_item_insert_after (Evas_Object *obj, Elm_Object_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 . | |
Elm_Object_Item * | elm_list_item_sorted_insert (Evas_Object *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. | |
void | elm_list_clear (Evas_Object *obj) |
Remove all list's items. | |
const Eina_List * | elm_list_items_get (const Evas_Object *obj) |
Get a list of all the list items. | |
Elm_Object_Item * | elm_list_selected_item_get (const Evas_Object *obj) |
Get the selected item. | |
const Eina_List * | elm_list_selected_items_get (const Evas_Object *obj) |
Return a list of the currently selected list items. | |
void | elm_list_item_selected_set (Elm_Object_Item *it, Eina_Bool selected) |
Set the selected state of an item. | |
void | elm_list_item_separator_set (Elm_Object_Item *it, Eina_Bool setting) |
Set or unset item as a separator. | |
Eina_Bool | elm_list_item_separator_get (const Elm_Object_Item *it) |
Get a value whether item is a separator or not. | |
void | elm_list_item_show (Elm_Object_Item *it) |
Show item in the list view. | |
void | elm_list_item_bring_in (Elm_Object_Item *it) |
Bring in the given item to list view. | |
Evas_Object * | elm_list_item_object_get (const Elm_Object_Item *it) |
Gets the base object of the item. | |
Elm_Object_Item * | elm_list_item_prev (const Elm_Object_Item *it) |
Get the item before it in list. | |
Elm_Object_Item * | elm_list_item_next (const Elm_Object_Item *it) |
Get the item after it in list. | |
Elm_Object_Item * | elm_list_first_item_get (const Evas_Object *obj) |
Get the first item in the list. | |
Elm_Object_Item * | elm_list_last_item_get (const Evas_Object *obj) |
Get the last item in the list. |
Detailed Description



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:
"activated"
- The user has double-clicked or pressed (enter|return|spacebar) on an item. Theevent_info
parameter is the item that was activated."clicked,double"
- The user has double-clicked an item. Theevent_info
parameter is the item that was double-clicked."selected"
- when the user selected an item"unselected"
- when the user unselected an item"longpressed"
- an item in the list is long-pressed"edge,top"
- the list is scrolled until the top edge"edge,bottom"
- the list is scrolled until the bottom edge"edge,left"
- the list is scrolled until the left edge"edge,right"
- the list is scrolled until the right edge"language,changed"
- the program's language changed
Available styles for it are:
"default"
Default content parts of the list items that you can use are:
"start"
- A start position object in the list item"end"
- An end position object in the list item
Default text parts of the list items that you can use are:
"default"
- label in the list item
Supported elm_object_item
common APIs.
- elm_object_item_disabled_set
- elm_object_item_disabled_get
- elm_object_item_part_text_set
- elm_object_item_part_text_get
- elm_object_item_part_content_set
- elm_object_item_part_content_get
- elm_object_item_part_content_unset
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
enum Elm_List_Mode |
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_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_COMPRESS 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_SCROLL 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_LIMIT 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_EXPAND Besides setting a minimum size on the transverse axis, just like on ELM_LIST_LIMIT, the list will set a minimum size on the 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.
ELM_LIST_LAST 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:
-
parent The parent object.
- Returns:
- a new list widget handle or
NULL
, on errors.
This function inserts a new list widget on the canvas.
Referenced by elm_ctxpopup_item_append().
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:
-
obj The list object. h_bounce Pointer to store the bounce state of the horizontal axis. v_bounce Pointer to store the bounce state of the vertical axis.
- Deprecated:
- Use elm_scroller_bounce_get() instead.
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:
-
obj The list object h_bounce Whether to bounce or not in the horizontal axis. v_bounce Whether to bounce or not in the vertical axis.
- Deprecated:
- Use elm_scroller_bounce_set() instead.
- See also:
- elm_scroller_bounce_set()
void elm_list_clear | ( | Evas_Object * | obj | ) |
Elm_Object_Item* elm_list_first_item_get | ( | const Evas_Object * | obj | ) |
Get the first item in the list.
This returns the first item in the list.
- Parameters:
-
obj The list object
- Returns:
- The first item, or NULL if none
void elm_list_go | ( | Evas_Object * | obj | ) |
Starts the list.
- Parameters:
-
obj The list object
- Note:
- Call before running show() on the list object.
- Warning:
- If not called, it won't display the list properly.
li = elm_list_add(win); elm_list_item_append(li, "First", NULL, NULL, NULL, NULL); elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL); elm_list_go(li); evas_object_show(li);
Eina_Bool elm_list_horizontal_get | ( | const Evas_Object * | obj | ) |
Get a value whether horizontal mode is enabled or not.
- Parameters:
-
obj The list object.
- Returns:
EINA_TRUE
means horizontal mode selection is enabled.EINA_FALSE
indicates it's disabled. Ifobj
isNULL
,EINA_FALSE
is returned.
- See also:
- elm_list_horizontal_set() for details.
void elm_list_horizontal_set | ( | Evas_Object * | obj, |
Eina_Bool | horizontal | ||
) |
Enable or disable horizontal mode on the list object.
- Parameters:
-
obj The list object. horizontal EINA_TRUE
to enable horizontal orEINA_FALSE
to disable it, i.e., to enable vertical mode.
- 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.
- See also:
- elm_list_horizontal_get()
References elm_box_horizontal_set().
Referenced by elm_ctxpopup_horizontal_set(), and elm_ctxpopup_item_append().
Elm_Object_Item* elm_list_item_append | ( | Evas_Object * | 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.
- Parameters:
-
obj The list object. label The label of the list item. icon The 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(). end The icon object to use for the right side of the item. An icon can be any Evas object. func The function to call when the item is clicked. data The data to associate with the item for related callbacks.
- Returns:
- The created item or
NULL
upon failure.
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
.
Simple example (with no function callback or data associated):
li = elm_list_add(win); ic = elm_icon_add(win); elm_image_file_set(ic, "path/to/image", NULL); elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE); elm_list_item_append(li, "label", ic, NULL, NULL, NULL); elm_list_go(li); evas_object_show(li);
- See also:
- elm_list_select_mode_set()
- elm_object_item_del()
- elm_object_item_del_cb_set()
- elm_list_clear()
- elm_icon_add()
References elm_box_pack_end().
Referenced by elm_ctxpopup_item_append().
void elm_list_item_bring_in | ( | Elm_Object_Item * | it | ) |
Bring in the given item to list view.
- Parameters:
-
it The item.
This causes list to jump to the given item item
and show it (by scrolling), if it is not fully visible.
This may use animation to do so and take a period of time.
If animation isn't wanted, elm_list_item_show() can be used.
Elm_Object_Item* elm_list_item_insert_after | ( | Evas_Object * | obj, |
Elm_Object_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
.
- Parameters:
-
obj The list object. after The list item to insert after. label The label of the list item. icon The 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(). end The icon object to use for the right side of the item. An icon can be any Evas object. func The function to call when the item is clicked. data The data to associate with the item for related callbacks.
- Returns:
- The created item or
NULL
upon failure.
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
.
- See also:
- elm_list_item_append() for a simple code example.
- elm_list_select_mode_set()
- elm_object_item_del()
- elm_object_item_del_cb_set()
- elm_list_clear()
- elm_icon_add()
References elm_box_pack_after().
Elm_Object_Item* elm_list_item_insert_before | ( | Evas_Object * | obj, |
Elm_Object_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
.
- Parameters:
-
obj The list object. before The list item to insert before. label The label of the list item. icon The 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(). end The icon object to use for the right side of the item. An icon can be any Evas object. func The function to call when the item is clicked. data The data to associate with the item for related callbacks.
- Returns:
- The created item or
NULL
upon failure.
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
.
- See also:
- elm_list_item_append() for a simple code example.
- elm_list_select_mode_set()
- elm_object_item_del()
- elm_object_item_del_cb_set()
- elm_list_clear()
- elm_icon_add()
References elm_box_pack_before().
Elm_Object_Item* elm_list_item_next | ( | const Elm_Object_Item * | it | ) |
Get the item after it
in list.
- Parameters:
-
it The list item.
- Returns:
- The item after
it
, orNULL
if none or on failure.
- Note:
- If it is the last item,
NULL
will be returned.
Evas_Object* elm_list_item_object_get | ( | const Elm_Object_Item * | it | ) |
Gets the base object of the item.
- Parameters:
-
it The list item
- Returns:
- The base object associated with
item
Base object is the Evas_Object
that represents that item.
Elm_Object_Item* elm_list_item_prepend | ( | Evas_Object * | 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.
- Parameters:
-
obj The list object. label The label of the list item. icon The 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(). end The icon object to use for the right side of the item. An icon can be any Evas object. func The function to call when the item is clicked. data The data to associate with the item for related callbacks.
- Returns:
- The created item or
NULL
upon failure.
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
.
- See also:
- elm_list_item_append() for a simple code example.
- elm_list_select_mode_set()
- elm_object_item_del()
- elm_object_item_del_cb_set()
- elm_list_clear()
- elm_icon_add()
References elm_box_pack_start().
Elm_Object_Item* elm_list_item_prev | ( | const Elm_Object_Item * | it | ) |
Get the item before it
in list.
- Parameters:
-
it The list item.
- Returns:
- The item before
it
, orNULL
if none or on failure.
- Note:
- If it is the first item,
NULL
will be returned.
void elm_list_item_selected_set | ( | Elm_Object_Item * | it, |
Eina_Bool | selected | ||
) |
Set the selected state of an item.
- Parameters:
-
it The list item selected The selected state
This sets the selected state of the given item it
. EINA_TRUE
for selected, EINA_FALSE
for not selected.
If a new item is selected the previously selected will be unselected, unless multiple selection is enabled with elm_list_multi_select_set(). Previously selected item can be get with function elm_list_selected_item_get().
Selected items will be highlighted.
- See also:
- elm_list_item_selected_get()
- elm_list_selected_item_get()
- elm_list_multi_select_set()
Eina_Bool elm_list_item_separator_get | ( | const Elm_Object_Item * | it | ) |
Get a value whether item is a separator or not.
- See also:
- elm_list_item_separator_set() for details.
- Parameters:
-
it The list item.
- Returns:
EINA_TRUE
means itemit
is a separator.EINA_FALSE
indicates it's not. Ifit
isNULL
,EINA_FALSE
is returned.
void elm_list_item_separator_set | ( | Elm_Object_Item * | it, |
Eina_Bool | setting | ||
) |
Set or unset item as a separator.
- Parameters:
-
it The list item. setting EINA_TRUE
to set itemit
as separator orEINA_FALSE
to unset, i.e., item will be used as a regular item.
Items aren't set as separator by default.
If set as separator it will display separator theme, so won't display icons or label.
- See also:
- elm_list_item_separator_get()
void elm_list_item_show | ( | Elm_Object_Item * | it | ) |
Show item
in the list view.
- Parameters:
-
it The list item to be shown.
It won't animate list until item is visible. If such behavior is wanted, use elm_list_bring_in() instead.
Elm_Object_Item* elm_list_item_sorted_insert | ( | Evas_Object * | 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.
- Parameters:
-
obj The list object. label The label of the list item. icon The 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(). end The icon object to use for the right side of the item. An icon can be any Evas object. func The function to call when the item is clicked. data The data to associate with the item for related callbacks. cmp_func The comparing function to be used to sort list items by Elm_Object_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.
- 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
.
- See also:
- elm_list_item_append() for a simple code example.
- elm_list_select_mode_set()
- elm_object_item_del()
- elm_object_item_del_cb_set()
- elm_list_clear()
- elm_icon_add()
References elm_box_pack_before(), and elm_box_pack_end().
const Eina_List* elm_list_items_get | ( | const Evas_Object * | obj | ) |
Get a list of all the list items.
- Parameters:
-
obj The list object
- Returns:
- An
Eina_List
of list items, Elm_Object_Item, orNULL
on failure.
Elm_Object_Item* elm_list_last_item_get | ( | const Evas_Object * | obj | ) |
Get the last item in the list.
This returns the last item in the list.
- Returns:
- The last item, or NULL if none
Elm_List_Mode elm_list_mode_get | ( | const Evas_Object * | obj | ) |
Get the mode the list is at.
- Parameters:
-
obj The list object
- Returns:
- One of Elm_List_Mode: ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT, ELM_LIST_EXPAND or ELM_LIST_LAST on errors.
- Note:
- see elm_list_mode_set() for more information.
References ELM_LIST_LAST.
void elm_list_mode_set | ( | Evas_Object * | obj, |
Elm_List_Mode | mode | ||
) |
Set which mode to use for the list object.
- Parameters:
-
obj The list object mode One of Elm_List_Mode: ELM_LIST_COMPRESS, ELM_LIST_SCROLL, ELM_LIST_LIMIT or ELM_LIST_EXPAND.
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.
- See also:
- elm_list_mode_get()
Referenced by elm_ctxpopup_item_append().
Eina_Bool elm_list_multi_select_get | ( | const Evas_Object * | obj | ) |
Get a value whether multiple items selection is enabled or not.
- See also:
- elm_list_multi_select_set() for details.
- Parameters:
-
obj The list object.
- Returns:
EINA_TRUE
means multiple items selection is enabled.EINA_FALSE
indicates it's disabled. Ifobj
isNULL
,EINA_FALSE
is returned.
void elm_list_multi_select_set | ( | Evas_Object * | obj, |
Eina_Bool | multi | ||
) |
Enable or disable multiple items selection on the list object.
- Parameters:
-
obj The list object multi EINA_TRUE
to enable multi selection orEINA_FALSE
to disable it.
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.
- See also:
- elm_list_multi_select_get()
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:
-
obj The list object. policy_h Pointer to store horizontal scrollbar policy. policy_v Pointer 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:
-
obj The list object policy_h Horizontal scrollbar policy. policy_v Vertical 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 Evas_Object * | obj | ) |
Get the list select mode.
- Parameters:
-
obj The list object
- Returns:
- The select mode (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
- See also:
- elm_list_select_mode_set()
void elm_list_select_mode_set | ( | Evas_Object * | obj, |
Elm_Object_Select_Mode | mode | ||
) |
Set the list select mode.
- Parameters:
-
obj The list object mode The 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.
- See also:
- elm_list_select_mode_get()
Elm_Object_Item* elm_list_selected_item_get | ( | const Evas_Object * | obj | ) |
Get the selected item.
- Parameters:
-
obj The list object.
- Returns:
- The selected list item.
The selected item can be unselected with function elm_list_item_selected_set().
The selected item always will be highlighted on list.
- See also:
- elm_list_selected_items_get()
const Eina_List* elm_list_selected_items_get | ( | const Evas_Object * | obj | ) |
Return a list of the currently selected list items.
- Parameters:
-
obj The list object.
- Returns:
- An
Eina_List
of list items, Elm_Object_Item, orNULL
on failure.
Multiple items can be selected if multi select is enabled. It can be done with elm_list_multi_select_set().