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) |
Enable or disable horizontal mode on the list object. More... | |
EOAPI Eina_Bool | elm_obj_list_horizontal_get (void) |
Get a value whether horizontal mode is enabled or not. More... | |
EOAPI void | elm_obj_list_select_mode_set (Elm_Object_Select_Mode mode) |
Set the list select mode. More... | |
EOAPI Elm_Object_Select_Mode | elm_obj_list_select_mode_get (void) |
Get the list select mode. More... | |
EOAPI void | elm_obj_list_focus_on_selection_set (Eina_Bool enabled) |
Set focus upon items selection mode. More... | |
EOAPI Eina_Bool | elm_obj_list_focus_on_selection_get (void) |
Get whether focus upon item's selection mode is enabled. More... | |
EOAPI void | elm_obj_list_multi_select_set (Eina_Bool multi) |
Enable or disable multiple items selection on the list object. More... | |
EOAPI Eina_Bool | elm_obj_list_multi_select_get (void) |
Get a value whether multiple items selection is enabled or not. More... | |
EOAPI void | elm_obj_list_multi_select_mode_set (Elm_Object_Multi_Select_Mode mode) |
Set the list multi select mode. More... | |
EOAPI Elm_Object_Multi_Select_Mode | elm_obj_list_multi_select_mode_get (void) |
Get the list multi select mode. More... | |
EOAPI void | elm_obj_list_mode_set (Elm_List_Mode mode) |
Set which mode to use for the list object. More... | |
EOAPI Elm_List_Mode | elm_obj_list_mode_get (void) |
Get the mode the list is at. More... | |
EOAPI Elm_Object_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_Object_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_Object_Item * | elm_obj_list_last_item_get (void) |
Get the last item in the list. More... | |
EOAPI Elm_Object_Item * | elm_obj_list_item_insert_before (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 . More... | |
EOAPI void | elm_obj_list_go (void) |
Starts the list. More... | |
EOAPI Elm_Object_Item * | elm_obj_list_item_insert_after (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 . More... | |
EOAPI Elm_Object_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_Object_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_Object_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. More... | |
EOAPI Elm_Object_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) |
Enable or disable horizontal mode on the list object. More... | |
Eina_Bool | elm_list_horizontal_get (const Elm_List *obj) |
Get a value whether horizontal mode is enabled or not. More... | |
void | elm_list_select_mode_set (Elm_List *obj, Elm_Object_Select_Mode mode) |
Set the list select mode. More... | |
Elm_Object_Select_Mode | elm_list_select_mode_get (const Elm_List *obj) |
Get the list select mode. More... | |
void | elm_list_focus_on_selection_set (Elm_List *obj, Eina_Bool enabled) |
Set focus upon items selection mode. More... | |
Eina_Bool | elm_list_focus_on_selection_get (const Elm_List *obj) |
Get whether focus upon item's selection mode is enabled. More... | |
void | elm_list_multi_select_set (Elm_List *obj, Eina_Bool multi) |
Enable or disable multiple items selection on the list object. More... | |
Eina_Bool | elm_list_multi_select_get (const Elm_List *obj) |
Get a value whether multiple items selection is enabled or not. More... | |
void | elm_list_multi_select_mode_set (Elm_List *obj, Elm_Object_Multi_Select_Mode mode) |
Set the list multi select mode. More... | |
Elm_Object_Multi_Select_Mode | elm_list_multi_select_mode_get (const Elm_List *obj) |
Get the list multi select mode. More... | |
void | elm_list_mode_set (Elm_List *obj, Elm_List_Mode mode) |
Set which mode to use for the list object. More... | |
Elm_List_Mode | elm_list_mode_get (const Elm_List *obj) |
Get the mode the list is at. More... | |
Elm_Object_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_Object_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_Object_Item * | elm_list_last_item_get (const Elm_List *obj) |
Get the last item in the list. More... | |
Elm_Object_Item * | elm_list_item_insert_before (Elm_List *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 . More... | |
void | elm_list_go (Elm_List *obj) |
Starts the list. More... | |
Elm_Object_Item * | elm_list_item_insert_after (Elm_List *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 . More... | |
Elm_Object_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_Object_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_Object_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. More... | |
Elm_Object_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... | |
EOAPI void | elm_obj_list_item_separator_set (Eina_Bool setting) |
Set or unset item as a separator. More... | |
EOAPI Eina_Bool | elm_obj_list_item_separator_get (void) |
Get a value whether item is a separator or not. More... | |
EOAPI void | elm_obj_list_item_selected_set (Eina_Bool selected) |
Set the selected state of an item. More... | |
EOAPI Eina_Bool | elm_obj_list_item_selected_get (void) |
Get whether the item is selected or not. More... | |
EOAPI Evas_Object * | elm_obj_list_item_object_get (void) |
Get the real Evas(Edje) object created to implement the view of a given list item . More... | |
EOAPI Elm_Object_Item * | elm_obj_list_item_prev_get (void) |
Get the item before it in list. More... | |
EOAPI Elm_Object_Item * | elm_obj_list_item_next_get (void) |
Get the item after it in list. More... | |
EOAPI void | elm_obj_list_item_show (void) |
Show item in the list view. More... | |
EOAPI void | elm_obj_list_item_bring_in (void) |
Bring in the given item to list view. More... | |
void | elm_list_item_separator_set (Elm_List_Item *obj, Eina_Bool setting) |
Set or unset item as a separator. More... | |
Eina_Bool | elm_list_item_separator_get (const Elm_List_Item *obj) |
Get a value whether item is a separator or not. More... | |
void | elm_list_item_selected_set (Elm_List_Item *obj, Eina_Bool selected) |
Set the selected state of an item. More... | |
Eina_Bool | elm_list_item_selected_get (const Elm_List_Item *obj) |
Get whether the item is selected or not. More... | |
Evas_Object * | elm_list_item_object_get (const Elm_List_Item *obj) |
Get the real Evas(Edje) object created to implement the view of a given list item . More... | |
Elm_Object_Item * | elm_list_item_prev (const Elm_List_Item *obj) |
Get the item before it in list. More... | |
Elm_Object_Item * | elm_list_item_next (const Elm_List_Item *obj) |
Get the item after it in list. More... | |
void | elm_list_item_show (Elm_List_Item *obj) |
Show item in the list view. More... | |
void | elm_list_item_bring_in (Elm_List_Item *obj) |
Bring in the given item to list view. More... | |
Evas_Object * | elm_list_add (Evas_Object *parent) |
Add a new list widget to the given parent Elementary (container) object. More... | |
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 (Generic list) 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. The event_info
parameter is the item that was activated."clicked,double"
- The user has double-clicked an item. The event_info
parameter is the item that was double-clicked."clicked,right"
- The user has right-clicked an item. The event_info
parameter is the item that was right-clicked. (since 1.13)"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"highlighted"
- an item in the list is highlighted. This is called when the user presses an item or keyboard selection is done so the item is physically highlighted. The event_info
parameter is the item that was highlighted."unhighlighted"
- an item in the list is unhighlighted. This is called when the user releases an item or keyboard selection is moved so the item is physically unhighlighted. The event_info
parameter is the item that was unhighlighted."language,changed"
- the program's language changed"focused"
- When the list has received focus. (since 1.8)"unfocused"
- When the list has lost focus. (since 1.8)"item,focused"
- When the list item has received focus. (since 1.10)"item,unfocused"
- When the list item has lost focus. (since 1.10)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 Another parts for customized styles are not accepted.Default text parts of the list items that you can use are:
"default"
- A label in the list item Another parts for customized styles are not accepted.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:
Evas_Object* elm_list_add | ( | Evas_Object * | parent | ) |
Add a new list widget to the given parent Elementary (container) object.
parent | The parent object. |
NULL
, on errors.This function inserts a new list widget on the canvas.
Elm_Object_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.
[in] | x | The input x coordinate |
[in] | y | The input y coordinate |
[out] | posret | The position relative to the item returned here |
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.
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. |
References elm_interface_scrollable_bounce_allow_get().
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.
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. |
References elm_interface_scrollable_bounce_allow_set().
void elm_list_clear | ( | Elm_List * | obj | ) |
Remove all list's items.
References elm_obj_list_clear().
Elm_Object_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.
References elm_obj_list_first_item_get().
Eina_Bool elm_list_focus_on_selection_get | ( | const Elm_List * | obj | ) |
Get whether focus upon item's selection mode is enabled.
References elm_obj_list_focus_on_selection_get().
void elm_list_focus_on_selection_set | ( | Elm_List * | obj, |
Eina_Bool | enabled | ||
) |
Set 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.
[in] | enabled | The tree effect status (EINA_TRUE = enabled, EINA_FALSE = disabled) |
References elm_obj_list_focus_on_selection_set().
void elm_list_go | ( | Elm_List * | obj | ) |
Starts the list.
References elm_obj_list_go().
Eina_Bool elm_list_horizontal_get | ( | const Elm_List * | obj | ) |
Get a value whether horizontal mode is enabled or not.
EINA_TRUE
means horizontal mode selection is enabled. EINA_FALSE
indicates it's disabled. If obj
is NULL
, EINA_FALSE
is returned.References elm_obj_list_horizontal_get().
void elm_list_horizontal_set | ( | Elm_List * | obj, |
Eina_Bool | horizontal | ||
) |
Enable or disable horizontal mode on the list object.
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.
[in] | horizontal | EINA_TRUE to enable horizontal or EINA_FALSE to disable it, i.e., to enable vertical mode. |
References elm_obj_list_horizontal_set().
Elm_Object_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.
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):
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
References elm_obj_list_item_append().
void elm_list_item_bring_in | ( | Elm_List_Item * | obj | ) |
Bring in the given item to list view.
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.
References elm_obj_list_item_bring_in().
Elm_Object_Item* elm_list_item_insert_after | ( | Elm_List * | 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
.
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
.
[in] | after | The list item to insert after. |
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
References elm_obj_list_item_insert_after().
Elm_Object_Item* elm_list_item_insert_before | ( | Elm_List * | 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
.
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
.
[in] | before | The list item to insert before. |
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
References elm_obj_list_item_insert_before().
Elm_Object_Item* elm_list_item_next | ( | const Elm_List_Item * | obj | ) |
Get the item after it
in list.
NULL
will be returned.References elm_obj_list_item_next_get().
Evas_Object* elm_list_item_object_get | ( | const Elm_List_Item * | obj | ) |
Get the real Evas(Edje) object created to implement the view of a given list item
.
Base object is the Evas_Object
that represents that item.
References elm_obj_list_item_object_get().
Elm_Object_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.
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
.
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
References elm_obj_list_item_prepend().
Elm_Object_Item* elm_list_item_prev | ( | const Elm_List_Item * | obj | ) |
Get the item before it
in list.
NULL
will be returned.References elm_obj_list_item_prev_get().
Eina_Bool elm_list_item_selected_get | ( | const Elm_List_Item * | obj | ) |
Get whether the item
is selected or not.
References elm_obj_list_item_selected_get().
void elm_list_item_selected_set | ( | Elm_List_Item * | obj, |
Eina_Bool | selected | ||
) |
Set the selected state of an item.
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.
[in] | selected | the selected state (EINA_TRUE selected, EINA_FALSE not selected) |
References elm_obj_list_item_selected_set().
Eina_Bool elm_list_item_separator_get | ( | const Elm_List_Item * | obj | ) |
Get a value whether item is a separator or not.
References elm_obj_list_item_separator_get().
void elm_list_item_separator_set | ( | Elm_List_Item * | obj, |
Eina_Bool | setting | ||
) |
Set or unset item as a separator.
Items aren't set as separator by default.
If set as separator it will display separator theme, so won't display icons or label.
[in] | setting | EINA_TRUE means item it is a separator. EINA_FALSE indicates it's not. |
References elm_obj_list_item_separator_set().
void elm_list_item_show | ( | Elm_List_Item * | obj | ) |
Show item
in the list view.
It won't animate list until item is visible. If such behavior is wanted, use elm_list_bring_in() instead.
References elm_obj_list_item_show().
Elm_Object_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.
NULL
upon failure.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
.
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
[in] | 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. |
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.
list
of list items, Elm_Object_Item, or NULL
on failure.References elm_obj_list_items_get().
Elm_Object_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.
References elm_obj_list_last_item_get().
Elm_List_Mode elm_list_mode_get | ( | const Elm_List * | obj | ) |
Get the mode the list is at.
References elm_obj_list_mode_get().
void elm_list_mode_set | ( | Elm_List * | obj, |
Elm_List_Mode | mode | ||
) |
Set 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.
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.
[in] | mode | One 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 | ) |
Get a value whether multiple items selection is enabled or not.
EINA_TRUE
means multiple items selection is enabled. EINA_FALSE
indicates it's disabled. If obj
is NULL
, EINA_FALSE
is returned. References elm_obj_list_multi_select_get().
Elm_Object_Multi_Select_Mode elm_list_multi_select_mode_get | ( | const Elm_List * | obj | ) |
Get the list multi select mode.
References elm_obj_list_multi_select_mode_get().
void elm_list_multi_select_mode_set | ( | Elm_List * | obj, |
Elm_Object_Multi_Select_Mode | mode | ||
) |
Set the list multi select mode.
[in] | mode | The multi select mode |
References elm_obj_list_multi_select_mode_set().
void elm_list_multi_select_set | ( | Elm_List * | obj, |
Eina_Bool | multi | ||
) |
Enable or disable 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.
[in] | multi | EINA_TRUE to enable multi selection or EINA_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.
obj | The list object. |
policy_h | Pointer to store horizontal scrollbar policy. |
policy_v | Pointer to store vertical scrollbar policy. |
References elm_interface_scrollable_policy_get().
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.
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.
References elm_interface_scrollable_policy_set().
Elm_Object_Select_Mode elm_list_select_mode_get | ( | const Elm_List * | obj | ) |
Get the list select mode.
References elm_obj_list_select_mode_get().
void elm_list_select_mode_set | ( | Elm_List * | obj, |
Elm_Object_Select_Mode | mode | ||
) |
Set the list select mode.
elm_list_select_mode_set() changes item select mode in the list widget.
[in] | mode | The select mode |
References elm_obj_list_select_mode_set().
Elm_Object_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.
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.
list
of list items, Elm_Object_Item, or NULL
on failure.Multiple items can be selected if multi select is enabled. It can be done with elm_list_multi_select_set().
References elm_obj_list_selected_items_get().
EOAPI Elm_Object_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.
[in] | x | The input x coordinate |
[in] | y | The input y coordinate |
[out] | posret | The position relative to the item returned here |
Referenced by elm_list_at_xy_item_get().
EOAPI void elm_obj_list_clear | ( | void | ) |
Remove all list's items.
Referenced by elm_list_clear().
EOAPI Elm_Object_Item* elm_obj_list_first_item_get | ( | void | ) |
Get the first item in the list.
This returns the first item in the list.
Referenced by elm_list_first_item_get().
EOAPI Eina_Bool elm_obj_list_focus_on_selection_get | ( | void | ) |
Get whether focus upon item's selection mode is enabled.
Referenced by elm_list_focus_on_selection_get().
EOAPI void elm_obj_list_focus_on_selection_set | ( | Eina_Bool | enabled | ) |
Set 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.
[in] | enabled | The tree effect status (EINA_TRUE = enabled, EINA_FALSE = disabled) |
Referenced by elm_list_focus_on_selection_set().
EOAPI void elm_obj_list_go | ( | void | ) |
Starts the list.
Referenced by elm_list_go().
EOAPI Eina_Bool elm_obj_list_horizontal_get | ( | void | ) |
Get a value whether horizontal mode is enabled or not.
EINA_TRUE
means horizontal mode selection is enabled. EINA_FALSE
indicates it's disabled. If obj
is NULL
, EINA_FALSE
is returned.Referenced by elm_list_horizontal_get().
EOAPI void elm_obj_list_horizontal_set | ( | Eina_Bool | horizontal | ) |
Enable or disable horizontal mode on the list object.
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.
[in] | horizontal | EINA_TRUE to enable horizontal or EINA_FALSE to disable it, i.e., to enable vertical mode. |
Referenced by elm_list_horizontal_set().
EOAPI Elm_Object_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.
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):
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
Referenced by elm_list_item_append().
EOAPI void elm_obj_list_item_bring_in | ( | void | ) |
Bring in the given item to list view.
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.
Referenced by elm_list_item_bring_in().
EOAPI Elm_Object_Item* elm_obj_list_item_insert_after | ( | 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
.
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
.
[in] | after | The list item to insert after. |
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
Referenced by elm_list_item_insert_after().
EOAPI Elm_Object_Item* elm_obj_list_item_insert_before | ( | 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
.
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
.
[in] | before | The list item to insert before. |
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
Referenced by elm_list_item_insert_before().
EOAPI Elm_Object_Item* elm_obj_list_item_next_get | ( | void | ) |
Get the item after it
in list.
NULL
will be returned.Referenced by elm_list_item_next().
EOAPI Evas_Object* elm_obj_list_item_object_get | ( | void | ) |
Get the real Evas(Edje) object created to implement the view of a given list item
.
Base object is the Evas_Object
that represents that item.
Referenced by elm_list_item_object_get().
EOAPI Elm_Object_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.
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
.
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
Referenced by elm_list_item_prepend().
EOAPI Elm_Object_Item* elm_obj_list_item_prev_get | ( | void | ) |
Get the item before it
in list.
NULL
will be returned.Referenced by elm_list_item_prev().
EOAPI Eina_Bool elm_obj_list_item_selected_get | ( | void | ) |
Get whether the item
is selected or not.
Referenced by elm_list_item_selected_get().
EOAPI void elm_obj_list_item_selected_set | ( | Eina_Bool | selected | ) |
Set the selected state of an item.
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.
[in] | selected | the selected state (EINA_TRUE selected, EINA_FALSE not selected) |
Referenced by elm_list_item_selected_set().
EOAPI Eina_Bool elm_obj_list_item_separator_get | ( | void | ) |
Get a value whether item is a separator or not.
Referenced by elm_list_item_separator_get().
EOAPI void elm_obj_list_item_separator_set | ( | Eina_Bool | setting | ) |
Set or unset item as a separator.
Items aren't set as separator by default.
If set as separator it will display separator theme, so won't display icons or label.
[in] | setting | EINA_TRUE means item it is a separator. EINA_FALSE indicates it's not. |
Referenced by elm_list_item_separator_set().
EOAPI void elm_obj_list_item_show | ( | void | ) |
Show item
in the list view.
It won't animate list until item is visible. If such behavior is wanted, use elm_list_bring_in() instead.
Referenced by elm_list_item_show().
EOAPI Elm_Object_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.
NULL
upon failure.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
.
[in] | label | The label of the list item. |
[in] | 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(). |
[in] | end | The icon object to use for the right side of the item. An icon can be any Evas object. |
[in] | func | The function to call when the item is clicked. |
[in] | data | The data to associate with the item for related callbacks. |
[in] | 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. |
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.
list
of list items, Elm_Object_Item, or NULL
on failure.Referenced by elm_list_items_get().
EOAPI Elm_Object_Item* elm_obj_list_last_item_get | ( | void | ) |
Get the last item in the list.
This returns the last item in the list.
Referenced by elm_list_last_item_get().
EOAPI Elm_List_Mode elm_obj_list_mode_get | ( | void | ) |
Get the mode the list is at.
Referenced by elm_list_mode_get().
EOAPI void elm_obj_list_mode_set | ( | Elm_List_Mode | mode | ) |
Set 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.
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.
[in] | mode | One 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 | ) |
Get a value whether multiple items selection is enabled or not.
EINA_TRUE
means multiple items selection is enabled. EINA_FALSE
indicates it's disabled. If obj
is NULL
, EINA_FALSE
is returned. Referenced by elm_list_multi_select_get().
EOAPI Elm_Object_Multi_Select_Mode elm_obj_list_multi_select_mode_get | ( | void | ) |
Get the list multi select mode.
Referenced by elm_list_multi_select_mode_get().
EOAPI void elm_obj_list_multi_select_mode_set | ( | Elm_Object_Multi_Select_Mode | mode | ) |
Set the list multi select mode.
[in] | mode | The multi select mode |
Referenced by elm_list_multi_select_mode_set().
EOAPI void elm_obj_list_multi_select_set | ( | Eina_Bool | multi | ) |
Enable or disable 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.
[in] | multi | EINA_TRUE to enable multi selection or EINA_FALSE to disable it. |
Referenced by elm_list_multi_select_set().
EOAPI Elm_Object_Select_Mode elm_obj_list_select_mode_get | ( | void | ) |
Get the list select mode.
Referenced by elm_list_select_mode_get().
EOAPI void elm_obj_list_select_mode_set | ( | Elm_Object_Select_Mode | mode | ) |
Set the list select mode.
elm_list_select_mode_set() changes item select mode in the list widget.
[in] | mode | The select mode |
Referenced by elm_list_select_mode_set().
EOAPI Elm_Object_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.
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.
list
of list items, Elm_Object_Item, or NULL
on failure.Multiple items can be selected if multi select is enabled. It can be done with elm_list_multi_select_set().
Referenced by elm_list_selected_items_get().