---

This widget aims to have more expansive list than the simple list in Elementary that could have more flexible items and allow many more entries while still being fast and low on memory usage. At the same time it was also made to be able to do tree structures. But the price to pay is more complexity when it comes to usage. If all you want is a simple list with icons and a single text, use the normal List object.

Genlist has a fairly large API, mostly because it's relatively complex, trying to be both expansive, powerful and efficient. First we will begin an overview on the theory behind genlist.

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

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

Some calls on the genlist'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).

Genlist item classes - creating items

In order to have the ability to add and delete items on the fly, genlist implements a class (callback) system where the application provides a structure with information about that type of item (genlist may contain multiple different items with different classes, states and styles). Genlist will call the functions in this struct (methods) when an item is "realized" (i.e., created dynamically, while the user is scrolling the list). All objects will simply be deleted when no longer needed with evas_object_del(). The #Elm_Genlist_Item_Class structure contains the following members:

• item_style - This is a constant string and simply defines the name of the item style. It must be specified and the default should be "default".
• decorate_item_style - This is a constant string and simply defines the name of the decorate mode item style. It is used to specify decorate mode item style. It can be used when you call elm_genlist_item_decorate_mode_set().
• decorate_all_item_style - This is a constant string and simply defines the name of the decorate all item style. It is used to specify decorate all item style. It can be used to set selection, checking and deletion mode. This is used when you call elm_genlist_decorate_mode_set().
• func - A struct with pointers to functions that will be called when an item is going to be actually created. All of them receive a data parameter that will point to the same data passed to elm_genlist_item_append() and related item creation functions, and an obj parameter that points to the genlist object itself.

The function pointers inside func are text_get, content_get, state_get and del. The 3 first functions also receive a part parameter described below. A brief description of these functions follows:

• text_get - The part parameter is the name string of one of the existing text parts in the Edje group implementing the item's theme. This function must return a strdup'()ed string, as the caller will free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
• content_get - The part parameter is the name string of one of the existing (content) swallow parts in the Edje group implementing the item's theme. It must return NULL, when no content is desired, or a valid object handle, otherwise. The object will be deleted by the genlist on its deletion or when the item is "unrealized". See #Elm_Genlist_Item_Content_Get_Cb.
• func.state_get - The part parameter is the name string of one of the state parts in the Edje group implementing the item's theme. Return EINA_FALSE for false/off or EINA_TRUE for true/on. Genlists will emit a signal to its theming Edje object with "elm,state,xxx,active" and "elm" as "emission" and "source" arguments, respectively, when the state is true (the default is false), where xxx is the name of the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
• func.del - This is intended for use when genlist items are deleted, so any data attached to the item (e.g. its data parameter on creation) can be deleted. See #Elm_Genlist_Item_Del_Cb.

available item styles:

• default
• default_style - The text part is a textblock
• double_label
• icon_top_text_bottom
• group_index
• one_icon - Only 1 icon (left) (since 1.7)
• end_icon - Only 1 icon (at end/right) (since 1.7)
• no_icon - No icon (at end/right) (since 1.7)
• full - Only 1 icon, elm.swallow.content, which consumes whole area of genlist item (since 1.7)

If one wants to use more icons and texts than are offered in theme, there are two solutions. One is to use 'full' style that has one big swallow part. You can swallow anything there. The other solution is to customize genlist item style in application side by using elm_theme_extension_add() and its own edc.

Structure of items

An item in a genlist can have 0 or more texts (they can be regular text or textblock Evas objects - that's up to the style to determine), 0 or more contents (which are simply objects swallowed into the genlist item's theming Edje object) and 0 or more boolean states, which have the behavior left to the user to define. The Edje part names for each of these properties will be looked up, in the theme file for the genlist, under the Edje (string) data items named "labels", "contents" and "states", respectively. For each of those properties, if more than one part is provided, they must have names listed separated by spaces in the data fields. For the default genlist item theme, we have one text part ("elm.text"), two content parts ("elm.swalllow.icon" and "elm.swallow.end") and no state parts.

A genlist item may be at one of several styles. Elementary provides one by default - "default", but this can be extended by system or application custom themes/overlays/extensions (see themes for more details).

Editing and Navigating

Items can be added by several calls. All of them return a Elm_Object_Item handle that is an internal member inside the genlist. They all take a data parameter that is meant to be used for a handle to the applications internal data (eg. the struct with the original item data). The parent parameter is the parent genlist item this belongs to if it is a tree or an indexed group, and NULL if there is no parent. The flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, #ELM_GENLIST_ITEM_TREE and #ELM_GENLIST_ITEM_GROUP. If #ELM_GENLIST_ITEM_TREE is set then this item is displayed as an item that is able to expand and have child items. If #ELM_GENLIST_ITEM_GROUP is set then this item is group index item that is displayed at the top until the next group comes. The func parameter is a convenience callback that is called when the item is selected and the data parameter will be the func_data parameter, obj be the genlist object and event_info will be the genlist item.

elm_genlist_item_append() adds an item to the end of the list, or if there is a parent, to the end of all the child items of the parent. elm_genlist_item_prepend() is the same but adds to the beginning of the list or children list. elm_genlist_item_insert_before() inserts at item before another item and elm_genlist_item_insert_after() inserts after the indicated item.

The application can clear the list with elm_genlist_clear() which deletes all the items in the list and elm_object_item_del() will delete a specific item. elm_genlist_item_subitems_clear() will clear all items that are children of the indicated parent item.

To help inspect list items you can jump to the item at the top of the list with elm_genlist_first_item_get() which will return the item pointer, and similarly elm_genlist_last_item_get() gets the item at the end of the list. elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next and previous items respectively relative to the indicated item. Using these calls you can walk the entire item list/tree. Note that as a tree the items are flattened in the list, so elm_genlist_item_parent_get() will let you know which item is the parent (and thus know how to skip them if wanted).

Multi-selection

If the application wants multiple items to be able to be selected, elm_genlist_multi_select_set() can enable this. If the list is single-selection only (the default), then elm_genlist_selected_item_get() will return the selected item, if any, or NULL if none is selected. If the list is multi-select then elm_genlist_selected_items_get() will return a list (that is only valid as long as no items are modified (added, deleted, selected or unselected)).

Usage hints

There are also convenience functions. elm_object_item_widget_get() will return the genlist object the item belongs to. elm_genlist_item_show() will make the scroller scroll to show that specific item so its visible. elm_object_item_data_get() returns the data pointer set by the item creation functions.

If an item changes (state of boolean changes, text or contents change), then use elm_genlist_item_update() to have genlist update the item with the new state. Genlist will re-realize the item and thus call the functions in the _Elm_Genlist_Item_Class for that item.

To programmatically (un)select an item use elm_genlist_item_selected_set(). To get its selected state use elm_genlist_item_selected_get(). Similarly to expand/contract an item and get its expanded state, use elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And again to make an item disabled (unable to be selected and appear differently) use elm_object_item_disabled_set() to set this and elm_object_item_disabled_get() to get the disabled state.

In general to indicate how the genlist should expand items horizontally to fill the list area, use elm_genlist_mode_set(). Valid modes are ELM_LIST_LIMIT, ELM_LIST_COMPRESS and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This mode means that if items are too wide to fit, the scroller will scroll horizontally. Otherwise items are expanded to fill the width of the viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded to the viewport width if larger than the item, but genlist widget witdh is limited to the largest item. Do not use ELM_LIST_LIMIT mode with homogenous mode turned on. ELM_LIST_COMPRESS can be combined with a different style that uses edjes' ellipsis feature (cutting text off like this: "tex...").

Items will call their selection func and callback only once when first becoming selected. Any further clicks will do nothing, unless you enable always select with elm_genlist_select_mode_set() as ELM_OBJECT_SELECT_MODE_ALWAYS. This means even if selected, every click will make the selected callbacks be called. elm_genlist_select_mode_set() as ELM_OBJECT_SELECT_MODE_NONE will turn off the ability to select items entirely and they will neither appear selected nor call selected callback functions.

Remember that you can create new styles and add your own theme augmentation per application with elm_theme_extension_add(). If you absolutely must have a specific style that overrides any theme the user or system sets up you can use elm_theme_overlay_add() to add such a file.

Implementation

Evas tracks every object you create. Every time it processes an event (mouse move, down, up etc.) it needs to walk through objects and find out what event that affects. Even worse every time it renders display updates, in order to just calculate what to re-draw, it needs to walk through many many many objects. Thus, the more objects you keep active, the more overhead Evas has in just doing its work. It is advisable to keep your active objects to the minimum working set you need. Also remember that object creation and deletion carries an overhead, so there is a middle-ground, which is not easily determined. But don't keep massive lists of objects you can't see or use. Genlist does this with list objects. It creates and destroys them dynamically as you scroll around. It groups them into blocks so it can determine the visibility etc. of a whole block at once as opposed to having to walk the whole list. This 2-level list allows for very large numbers of items to be in the list (tests have used up to 2,000,000 items). Also genlist employs a queue for adding items. As items may be different sizes, every item added needs to be calculated as to its size and thus this presents a lot of overhead on populating the list, this genlist employs a queue. Any item added is queued and spooled off over time, actually appearing some time later, so if your list has many members you may find it takes a while for them to all appear, with your process consuming a lot of CPU while it is busy spooling.

Genlist also implements a tree structure for items, but it does so with callbacks to the application, with the application filling in tree structures when requested (allowing for efficient building of a very deep tree that could even be used for file-management). See the above smart signal callbacks for details.

Genlist smart events

This widget emits the following signals, besides the ones sent from Elm_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.
• "pressed" - The user pressed an item. The event_info parameter is the item that was pressed.
• "released" - The user released an item. The event_info parameter is the item that was released.
• "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" - This is called when a user has made an item selected. The event_info parameter is the genlist item that was selected.
• "unselected" - This is called when a user has made an item unselected. The event_info parameter is the genlist item that was unselected.
• "expanded" - This is called when elm_genlist_item_expanded_set() is called and the item is now meant to be expanded. The event_info parameter is the genlist item that was indicated to expand. It is the job of this callback to then fill in the child items.
• "contracted" - This is called when elm_genlist_item_expanded_set() is called and the item is now meant to be contracted. The event_info parameter is the genlist item that was indicated to contract. It is the job of this callback to then delete the child items.
• "expand,request" - This is called when a user has indicated they want to expand a tree branch item. The callback should decide if the item can expand (has any children) and then call elm_genlist_item_expanded_set() appropriately to set the state. The event_info parameter is the genlist item that was indicated to expand.
• "contract,request" - This is called when a user has indicated they want to contract a tree branch item. The callback should decide if the item can contract (has any children) and then call elm_genlist_item_expanded_set() appropriately to set the state. The event_info parameter is the genlist item that was indicated to contract.
• "realized" - This is called when the item in the list is created as a real evas object. event_info parameter is the genlist item that was created.
• "unrealized" - This is called just before an item is unrealized. After this call content objects provided will be deleted and the item object itself delete or be put into a floating cache.
• "drag,start,up" - This is called when the item in the list has been dragged (not scrolled) up.
• "drag,start,down" - This is called when the item in the list has been dragged (not scrolled) down.
• "drag,start,left" - This is called when the item in the list has been dragged (not scrolled) left.
• "drag,start,right" - This is called when the item in the list has been dragged (not scrolled) right.
• "drag,stop" - This is called when the item in the list has stopped being dragged.
• "drag" - This is called when the item in the list is being dragged.
• "longpressed" - This is called when the item is pressed for a certain amount of time. By default it's 1 second. The event_info parameter is the longpressed genlist item.
• "scroll" - the content has been scrolled (moved) (since 1.13)
• "scroll,anim,start" - This is called when scrolling animation has started.
• "scroll,anim,stop" - This is called when scrolling animation has stopped.
• "scroll,drag,start" - This is called when dragging the content has started.
• "scroll,drag,stop" - This is called when dragging the content has stopped.
• "edge,top" - This is called when the genlist is scrolled until the top edge.
• "edge,bottom" - This is called when the genlist is scrolled until the bottom edge.
• "edge,left" - This is called when the genlist is scrolled until the left edge.
• "edge,right" - This is called when the genlist is scrolled until the right edge.
• "multi,swipe,left" - This is called when the genlist is multi-touch swiped left.
• "multi,swipe,right" - This is called when the genlist is multi-touch swiped right.
• "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
• "multi,swipe,down" - This is called when the genlist is multi-touch swiped down.
• "multi,pinch,out" - This is called when the genlist is multi-touch pinched out.
• "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
• "swipe" - This is called when the genlist is swiped.
• "moved" - This is called when a genlist item is moved by a user interaction in a reorder mode. The event_info parameter is the item that was moved.
• "moved,after" - This is called when a genlist item is moved after another item in reorder mode. The event_info parameter is the reordered item. To get the relative previous item, use elm_genlist_item_prev_get(). This signal is called along with "moved" signal.
• "moved,before" - This is called when a genlist item is moved before another item in reorder mode. The event_info parameter is the reordered item. To get the relative previous item, use elm_genlist_item_next_get(). This signal is called along with "moved" signal.
• "index,update" - This is called when a genlist item index is changed. Note that this callback is called while each item is being realized.
• "language,changed" - This is called when the program's language is changed. Call the elm_genlist_realized_items_update() if items text should be translated.
• "tree,effect,finished" - This is called when a genlist tree effect is finished.
• "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.
• "focused" - When the genlist has received focus. (since 1.8)
• "unfocused" - When the genlist has lost focus. (since 1.8)
• "item,focused" - When the genlist item has recieved focus. (since 1.10)
• "item,unfocused" - When the genlist item has lost focus. (since 1.10)

Supported elm_object_item common APIs

• elm_object_item_part_content_get
• elm_object_item_part_text_get
• elm_object_item_disabled_set
• elm_object_item_disabled_get
• elm_object_item_signal_emit

Unsupported elm_object_item common APIs due to the genlist concept. Genlist fills content/text according to the appropriate callback functions. Please use elm_genlist_item_update() or elm_genlist_item_fields_update() instead.

• elm_object_item_part_content_set
• elm_object_item_part_content_unset
• elm_object_item_part_text_set

Functions
Elm_Genlist_Item_Class *	elm_genlist_item_class_new (void)
	Create a new genlist item class in a given genlist widget.
void	elm_genlist_item_class_free (Elm_Genlist_Item_Class *itc)
	Remove an item class in a given genlist widget.
void	elm_genlist_item_class_ref (Elm_Genlist_Item_Class *itc)
	Increments object reference count for the item class.
void	elm_genlist_item_class_unref (Elm_Genlist_Item_Class *itc)
	Decrements object reference count for the item class.
Evas_Object *	elm_genlist_add (Evas_Object *parent)
	Adds a new genlist widget to the given parent Elementary (container) object.
void	elm_genlist_clear (Evas_Object *obj)
	Removes all items from a given genlist widget.
void	elm_genlist_multi_select_set (Evas_Object *obj, Eina_Bool multi)
	Enables or disables multi-selection in the genlist.
Eina_Bool	elm_genlist_multi_select_get (const Evas_Object *obj)
	Gets whether multi-selection in genlist is enabled or disabled.
void	elm_genlist_mode_set (Evas_Object *obj, Elm_List_Mode mode)
	Sets the horizontal stretching mode.
Elm_List_Mode	elm_genlist_mode_get (const Evas_Object *obj)
	Gets the horizontal stretching mode.
Elm_Object_Item *	elm_genlist_item_append (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data)
	Appends a new item to a given genlist widget.
Elm_Object_Item *	elm_genlist_item_prepend (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data)
	Prepends a new item to a given genlist widget.
Elm_Object_Item *	elm_genlist_item_insert_before (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *before, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data)
	Inserts an item before another in a genlist widget.
Elm_Object_Item *	elm_genlist_item_insert_after (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *after, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data)
	Inserts an item after another in a genlist widget.
Elm_Object_Item *	elm_genlist_item_sorted_insert (Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data)
	Inserts a new item into the sorted genlist object.
Elm_Object_Item *	elm_genlist_selected_item_get (const Evas_Object *obj)
	Gets the selected item in the genlist.
Eina_List *	elm_genlist_selected_items_get (const Evas_Object *obj)
	Gets a list of selected items in the genlist.
Eina_List *	elm_genlist_realized_items_get (const Evas_Object *obj)
	Gets a list of realized items in the genlist.
Elm_Object_Item *	elm_genlist_first_item_get (const Evas_Object *obj)
	Gets the first item in the genlist.
Elm_Object_Item *	elm_genlist_last_item_get (const Evas_Object *obj)
	Gets the last item in the genlist.
void	elm_genlist_realized_items_update (Evas_Object *obj)
	Updates the content of all the realized items.
unsigned int	elm_genlist_items_count (const Evas_Object *obj)
	Returns the number of items that are currently in a list.
void	elm_genlist_homogeneous_set (Evas_Object *obj, Eina_Bool homogeneous)
	Enables or disables the homogeneous mode.
Eina_Bool	elm_genlist_homogeneous_get (const Evas_Object *obj)
	Gets whether the homogeneous mode is enabled.
void	elm_genlist_block_count_set (Evas_Object *obj, int count)
	Sets the maximum number of items within an item block.
int	elm_genlist_block_count_get (const Evas_Object *obj)
	Gets the maximum number of items within an item block.
void	elm_genlist_longpress_timeout_set (Evas_Object *obj, double timeout)
	Sets the timeout in seconds for the longpress event.
double	elm_genlist_longpress_timeout_get (const Evas_Object *obj)
	Gets the timeout in seconds for the longpress event.
Elm_Object_Item *	elm_genlist_at_xy_item_get (const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret)
	Gets the item that is at the x, y canvas coordinates.
void	elm_genlist_reorder_mode_set (Evas_Object *obj, Eina_Bool reorder_mode)
	Sets the reorder mode.
Eina_Bool	elm_genlist_reorder_mode_get (const Evas_Object *obj)
	Gets the reorder mode.
void	elm_genlist_select_mode_set (Evas_Object *obj, Elm_Object_Select_Mode mode)
	Sets the genlist select mode.
Elm_Object_Select_Mode	elm_genlist_select_mode_get (const Evas_Object *obj)
	Gets the genlist select mode.
void	elm_genlist_highlight_mode_set (Evas_Object *obj, Eina_Bool highlight)
	Sets whether the genlist items should be highlighted when an item is selected.
Eina_Bool	elm_genlist_highlight_mode_get (const Evas_Object *obj)
	Gets whether the genlist items should be highlighted when an item is selected.
Elm_Object_Item *	elm_genlist_nth_item_get (const Evas_Object *obj, unsigned int nth)
	Gets the nth item in a given genlist widget, placed at position nth, in its internal items list.

---

Function Documentation