Tizen Native API  3.0
Functions
Genlist Item
Genlist (Generic list)

Functions

Elm_Widget_Item * elm_genlist_item_prev_get (const Elm_Genlist_Item *obj)
 Get the previous item in a genlist widget's internal list of items, given a handle to one of those items.
Elm_Widget_Item * elm_genlist_item_next_get (const Elm_Genlist_Item *obj)
 Get the next item in a genlist widget's internal list of items, given a handle to one of those items.
Elm_Widget_Item * elm_genlist_item_parent_get (const Elm_Genlist_Item *obj)
 Get the parent item of the given item.
void elm_genlist_item_selected_set (Elm_Genlist_Item *obj, Eina_Bool selected)
 Set whether a given genlist item is selected or not.
Eina_Bool elm_genlist_item_selected_get (const Elm_Genlist_Item *obj)
 Get whether a given genlist item is selected or not.
void elm_genlist_item_expanded_set (Elm_Genlist_Item *obj, Eina_Bool expanded)
 Set the expanded state of an item.
Eina_Bool elm_genlist_item_expanded_get (const Elm_Genlist_Item *obj)
 Get the expanded state of an item.
int elm_genlist_item_expanded_depth_get (const Elm_Genlist_Item *obj)
 Get the depth of expanded item.
const Elm_Genlist_Item_Class * elm_genlist_item_item_class_get (const Elm_Genlist_Item *obj)
 Get the Genlist Item class for the given Genlist Item.
int elm_genlist_item_index_get (const Elm_Genlist_Item *obj)
 Get the index of the item. It is only valid once displayed.
void elm_genlist_item_select_mode_set (Elm_Genlist_Item *obj, Elm_Object_Select_Mode mode)
 Set the genlist item's select mode.
Elm_Object_Select_Mode elm_genlist_item_select_mode_get (const Elm_Genlist_Item *obj)
 Get the genlist item's select mode.
Elm_Genlist_Item_Type elm_genlist_item_type_get (const Elm_Genlist_Item *obj)
 Get the type of item.
void elm_genlist_item_subitems_clear (Elm_Genlist_Item *obj)
 Remove all sub-items (children) of the given item.
void elm_genlist_item_promote (Elm_Genlist_Item *obj)
 Promote an item to the top of the list.
void elm_genlist_item_demote (Elm_Genlist_Item *obj)
 Demote an item to the end of the list.
void elm_genlist_item_show (Elm_Genlist_Item *obj, Elm_Genlist_Item_Scrollto_Type type)
 Show the portion of a genlist's internal list containing a given item, immediately.
void elm_genlist_item_bring_in (Elm_Genlist_Item *obj, Elm_Genlist_Item_Scrollto_Type type)
 Animatedly bring in, to the visible area of a genlist, a given item on it.
void elm_genlist_item_all_contents_unset (Elm_Genlist_Item *obj, Eina_List **l)
 Unset all contents fetched by the item class.
void elm_genlist_item_update (Elm_Genlist_Item *obj)
 Update all the contents of an item.
void elm_genlist_item_fields_update (Elm_Genlist_Item *obj, const char *parts, Elm_Genlist_Item_Field_Type itf)
 Update the part of an item.
void elm_genlist_item_item_class_update (Elm_Genlist_Item *obj, const Elm_Genlist_Item_Class *itc)
 Update the item class of an item.

Function Documentation

void elm_genlist_item_all_contents_unset ( Elm_Genlist_Item *  obj,
Eina_List **  l 
)

Unset all contents fetched by the item class.

Since :
2.3
Remarks:
This instructs genlist to release references to contents in the item, meaning that they will no longer be managed by genlist and are floating "orphans" that can be re-used elsewhere if the user wants to.
Parameters:
[out]lThe contents list to return.
void elm_genlist_item_bring_in ( Elm_Genlist_Item *  obj,
Elm_Genlist_Item_Scrollto_Type  type 
)

Animatedly bring in, to the visible area of a genlist, a given item on it.

Since :
2.3
Remarks:
This causes genlist to jump to the given item it and show it (by animatedly scrolling), if it is not fully visible. This may use animation and take a some time to do so.
See also:
elm_genlist_item_show()
Parameters:
[in]typeThe position to bring in, the given item to. \Elm_Genlist_Item_Scrollto_Type.
void elm_genlist_item_demote ( Elm_Genlist_Item *  obj)

Demote an item to the end of the list.

Since :
2.3
int elm_genlist_item_expanded_depth_get ( const Elm_Genlist_Item *  obj)

Get the depth of expanded item.

Since :
2.3
Returns:
The depth of expanded item.
Eina_Bool elm_genlist_item_expanded_get ( const Elm_Genlist_Item *  obj)

Get the expanded state of an item.

Since :
2.3
Remarks:
This gets the expanded state of an item.
See also:
elm_genlist_item_expanded_set()
Returns:
The expanded state (@true expanded, not expanded).
void elm_genlist_item_expanded_set ( Elm_Genlist_Item *  obj,
Eina_Bool  expanded 
)

Set the expanded state of an item.

Since :
2.3
Remarks:
This function flags the item of type #ELM_GENLIST_ITEM_TREE as expanded or not.
The theme will respond to this change visually, and a signal "expanded" or "contracted" will be sent from the genlist with a pointer to the item that has been expanded/contracted.
Calling this function won't show or hide any child of this item (if it is a parent). You must manually delete and create them on the callbacks of the "expanded" or "contracted" signals.
See also:
elm_genlist_item_expanded_get()
Parameters:
[in]expandedThe expanded state (@true expanded, not expanded).
void elm_genlist_item_fields_update ( Elm_Genlist_Item *  obj,
const char *  parts,
Elm_Genlist_Item_Field_Type  itf 
)

Update the part of an item.

Since :
2.3
Remarks:
This updates an item's part by calling item's fetching functions again to get the contents, texts and states. Use this when the original item data has changed and the changes are desired to be reflected. Second parts argument is used for globbing to match '*', '?', and '.' It can be used at updating multi fields.
Use elm_genlist_realized_items_update() to update an item's all property.
See also:
elm_genlist_item_update()
Parameters:
[in]itfThe type of item's part type.
int elm_genlist_item_index_get ( const Elm_Genlist_Item *  obj)

Get the index of the item. It is only valid once displayed.

Since :
2.3
Returns:
*return the position inside the list of item.
const Elm_Genlist_Item_Class* elm_genlist_item_item_class_get ( const Elm_Genlist_Item *  obj)

Get the Genlist Item class for the given Genlist Item.

Since :
2.3
Remarks:
This returns the Genlist_Item_Class for the given item. It can be used to examine the function pointers and item_style.
Returns:
Genlist Item class for the given item
void elm_genlist_item_item_class_update ( Elm_Genlist_Item *  obj,
const Elm_Genlist_Item_Class *  itc 
)

Update the item class of an item.

Since :
2.3
Remarks:
This sets another class of the item, changing the way that it is displayed. After changing the item class, elm_genlist_item_update() is called on the item it.
Parameters:
[in]itcThe item class for the item.
Elm_Widget_Item* elm_genlist_item_next_get ( const Elm_Genlist_Item *  obj)

Get the next item in a genlist widget's internal list of items, given a handle to one of those items.

Since :
2.3
Remarks:
This returns the item placed after the item, on the container genlist.
See also:
elm_genlist_item_prev_get()
Returns:
The item after , or if there's none (and on errors).
Elm_Widget_Item* elm_genlist_item_parent_get ( const Elm_Genlist_Item *  obj)

Get the parent item of the given item.

Since :
2.3
Remarks:
This returns the item that was specified as parent of the item it on elm_genlist_item_append() and insertion related functions.
Returns:
The parent of the item or if it has no parent.
Elm_Widget_Item* elm_genlist_item_prev_get ( const Elm_Genlist_Item *  obj)

Get the previous item in a genlist widget's internal list of items, given a handle to one of those items.

Since :
2.3
Remarks:
This returns the item placed before the item, on the container genlist.
See also:
elm_genlist_item_next_get()
Returns:
The item before , or if there's none (and on errors).
void elm_genlist_item_promote ( Elm_Genlist_Item *  obj)

Promote an item to the top of the list.

Since :
2.3
Elm_Object_Select_Mode elm_genlist_item_select_mode_get ( const Elm_Genlist_Item *  obj)

Get the genlist item's select mode.

Since :
2.3 *return The select mode (If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)
See also:
elm_genlist_item_select_mode_set()
Returns:
The selected mode.
void elm_genlist_item_select_mode_set ( Elm_Genlist_Item *  obj,
Elm_Object_Select_Mode  mode 
)

Set the genlist item's select mode.

Since :
2.3
Remarks:
elm_genlist_item_select_mode_set() changes item's select mode.
  • ELM_OBJECT_SELECT_MODE_DEFAULT : The item 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 the item entirely and they will neither appear selected nor call selected callback functions. - ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY : This will apply no-finger-size rule with ELM_OBJECT_SELECT_MODE_NONE. No-finger-size rule makes an item can be smaller than lower limit. Clickable objects should be bigger than human touch point device (your finger) for some touch or small screen devices. So it is enabled, the item can be shrink than predefined finger-size value. And the item will be updated.
See also:
elm_genlist_item_select_mode_get()
Parameters:
[in]modeThe selected mode.
Eina_Bool elm_genlist_item_selected_get ( const Elm_Genlist_Item *  obj)

Get whether a given genlist item is selected or not.

Since :
2.3 *return EINA_TRUE, if it's selected, EINA_FALSE otherwise
See also:
elm_genlist_item_selected_set() for more details
Returns:
The selected state (@true selected, not selected).
void elm_genlist_item_selected_set ( Elm_Genlist_Item *  obj,
Eina_Bool  selected 
)

Set whether a given genlist item is selected or not.

Since :
2.3
Remarks:
Use EINA_TRUE, to make it selected, EINA_FALSE to make it unselected
This sets the selected state of an item. If multi selection is not enabled on the containing genlist and selected is EINA_TRUE, any other previously selected items will get unselected in favor of this new one.
See also:
elm_genlist_item_selected_get()
Parameters:
[in]selectedThe selected state (@true selected, not selected).
void elm_genlist_item_show ( Elm_Genlist_Item *  obj,
Elm_Genlist_Item_Scrollto_Type  type 
)

Show the portion of a genlist's internal list containing a given item, immediately.

Since :
2.3
Remarks:
This causes genlist to jump to the given item it and show it (by jumping to that position), if it is not fully visible.
See also:
elm_genlist_item_bring_in()
Parameters:
[in]typeThe position to bring in, the given item to. \Elm_Genlist_Item_Scrollto_Type.
void elm_genlist_item_subitems_clear ( Elm_Genlist_Item *  obj)

Remove all sub-items (children) of the given item.

Since :
2.3
Remarks:
This removes all items that are children (and their descendants) of the given item it.
See also:
elm_genlist_clear()
elm_object_item_del()
Elm_Genlist_Item_Type elm_genlist_item_type_get ( const Elm_Genlist_Item *  obj)

Get the type of item.

Since :
2.3 *return The item type.
Remarks:
This function returns the item's type. Normally the item's type. If it failed, return value is ELM_GENLIST_ITEM_MAX
Returns:
Item type.
void elm_genlist_item_update ( Elm_Genlist_Item *  obj)

Update all the contents of an item.

Since :
2.3
Remarks:
This updates an item by calling all the item class functions again to get the contents, texts and states. Use this when the original item data has changed and the changes are desired to be reflected.
Use elm_genlist_realized_items_update() to update all already realized items.
This also updates internal genlist item object(edje_object as of now). So when this is called between mouse down and mouse up, mouse up event will be ignored because edje_object is deleted and created again by this API. If you want to avoid this, please use elm_genlist_item_fields_update.
See also:
elm_genlist_realized_items_update()