Tizen Native API  5.5
Elm_Genlist_Item_Group

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 lis 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)
 Get the list of subitems of a given item.
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)
 Sets 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_Classelm_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)
 Get the item's decorate 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 Item's type.
void elm_genlist_item_subitems_clear (Elm_Genlist_Item *obj)
 Set whether a given genlist item is pinned or not.
void elm_genlist_item_promote (Elm_Genlist_Item *obj)
void elm_genlist_item_demote (Elm_Genlist_Item *obj)
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.

Enumeration Type Documentation

Defines the type of the item part Used while updating item's parts It can be used at updating multi fields.

Enumerator:
ELM_GENLIST_ITEM_FIELD_ALL 

Type all

ELM_GENLIST_ITEM_FIELD_TEXT 

Type text

ELM_GENLIST_ITEM_FIELD_CONTENT 

Type content

ELM_GENLIST_ITEM_FIELD_STATE 

Type state

Defines where to position the item in the genlist.

Enumerator:
ELM_GENLIST_ITEM_SCROLLTO_NONE 

Nothing will happen, Don't use this value.

ELM_GENLIST_ITEM_SCROLLTO_IN 

To the nearest viewport.

ELM_GENLIST_ITEM_SCROLLTO_TOP 

To the top of viewport.

ELM_GENLIST_ITEM_SCROLLTO_MIDDLE 

To the middle of viewport.

ELM_GENLIST_ITEM_SCROLLTO_BOTTOM 

To the bottom of viewport.

Defines if the item is of any special type (has subitems or it's the index of a group), or is just a simple item.

Enumerator:
ELM_GENLIST_ITEM_NONE 

Simple item.

ELM_GENLIST_ITEM_TREE 

This may be expanded and have child items.

ELM_GENLIST_ITEM_GROUP 

An index item of a group of items. this item can have child items.

ELM_GENLIST_ITEM_MAX 

Sentinel value to indicate last enum field during iteration


Function Documentation

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

Unset all contents fetched by the item class.

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:
[in]objThe object.
[out]lThe contents list to return.
Since :
2.3
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.

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.

Parameters:
[in]objThe object.
[in]typeThe position to bring in, the given item to. Elm_Genlist_Item_Scrollto_Type.
Since :
2.3
Examples:
genlist_example_04.c.
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.

Parameters:
[in]objThe object.
Returns:
The depth of expanded item.
Since :
2.3
Examples:
genlist_example_05.c.
Eina_Bool elm_genlist_item_expanded_get ( const Elm_Genlist_Item *  obj)

Get the expanded state of an item.

This gets the expanded state of an item.

Parameters:
[in]objThe object.
Returns:
The expanded state ($true expanded, false not expanded).
Since :
2.3
Examples:
genlist_example_05.c.
void elm_genlist_item_expanded_set ( Elm_Genlist_Item *  obj,
Eina_Bool  expanded 
)

Sets the expanded state of an item.

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.

Parameters:
[in]objThe object.
[in]expandedThe expanded state ($true expanded, false not expanded).
Since :
2.3
Examples:
genlist_example_05.c.
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.

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 part 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.

Parameters:
[in]objThe object.
[in]partsThe name of item's part.
[in]itfThe type of item's part type.
Since :
2.3
int elm_genlist_item_index_get ( const Elm_Genlist_Item *  obj)

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

The index start from 1.

Parameters:
[in]objThe object.
Returns:
The position inside the list of item.
Since :
2.3
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.

This returns the Genlist_Item_Class for the given item. It can be used to examine the function pointers and item_style.

Parameters:
[in]objThe object.
Returns:
Genlist Item class for the given item.
Since :
2.3
void elm_genlist_item_item_class_update ( Elm_Genlist_Item *  obj,
const Elm_Genlist_Item_Class itc 
)

Update the item class of an item.

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]objThe object.
[in]itcThe item class for the item.
Since :
2.3
Examples:
genlist_example_05.c.
Elm_Widget_Item* elm_genlist_item_next_get ( const Elm_Genlist_Item *  obj)

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

This returns the item placed after the item, on the container genlist.

If filter is set on genlist, this returns the filtered item placed after item in the list.

Note that parent / child relationship is not taken into account, the next visual item is always returned, could it be a parent, a child or a group item.

NULL is returned if called on the last item.

Parameters:
[in]objThe object.
Returns:
The item after item, or null if there's none (and on errors).
Since :
2.3
Examples:
genlist_example_04.c.
Elm_Widget_Item* elm_genlist_item_parent_get ( const Elm_Genlist_Item *  obj)

Get the parent item of the given item.

This returns the item that was specified as parent of the item it on elm_genlist_item_append and insertion related functions.

Parameters:
[in]objThe object.
Returns:
The parent of the item or null if it has no parent.
Since :
2.3
Examples:
genlist_example_05.c.
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.

This returns the item placed before the item, on the container genlist.

If filter is set on genlist, this returns the filtered item placed before item in the list.

Note that parent / child relationship is not taken into account, the previous visual item is always returned, could it be a parent, a child or a group item.

NULL is returned if called on the first item.

Parameters:
[in]objThe object.
Returns:
The item before item, or null if there's none (and on errors).
Since :
2.3
Examples:
genlist_example_04.c, and genlist_example_05.c.
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.

It's ELM_OBJECT_SELECT_MODE_MAX on failure.

Parameters:
[in]objThe object.
Returns:
The selected mode.
Since :
2.3
void elm_genlist_item_select_mode_set ( Elm_Genlist_Item *  obj,
Elm_Object_Select_Mode  mode 
)

Get the item's decorate mode.

This function just returns the name of the item's decorate mode.

Parameters:
[in]objThe object.
Returns:
Name of the item's decorate mode. Set the flip state of a given genlist item.

This function sets the flip state of a given genlist item. Flip mode overrides current item object. It can be used for on-the-fly item replace. Flip mode can be used with/without decorate mode.

Parameters:
[in]objThe object.
[in]flipThe flip mode. Get the flip state of a given genlist item.

This function returns the flip state of a given genlist item. If the parameter is invalid, it returns false.

Parameters:
[in]objThe object.
Returns:
The flip mode. Set the genlist item's select mode.

ELM_OBJECT_SELECT_MODE_DEFAULT means that 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 means that even if selected, every click will make the selected callbacks be called.

ELM_OBJECT_SELECT_MODE_NONE 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 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.

Parameters:
[in]objThe object.
[in]modeThe selected mode.
Since :
2.3
Examples:
genlist_example_04.c.
Eina_Bool elm_genlist_item_selected_get ( const Elm_Genlist_Item *  obj)

Get whether a given genlist item is selected or not.

Parameters:
[in]objThe object.
Returns:
The selected state ($true selected, false not selected).
Since :
2.3
void elm_genlist_item_selected_set ( Elm_Genlist_Item *  obj,
Eina_Bool  selected 
)

Get the list of subitems of a given item.

This returns the list of subitems that an item possesses. It cannot be changed.

Parameters:
[in]objThe object.
Returns:
The list of subitems, null on error.
Since (EFL) :
1.9 Set whether a given genlist item is selected or not

This sets the selected state of an item. If multi selection is not enabled on the containing genlist and selected is true, any other previously selected items will get unselected in favor of this new one.

Parameters:
[in]objThe object.
[in]selectedThe selected state ($true selected, false not selected).
Since :
2.3
Examples:
genlist_example_04.c, and genlist_example_05.c.
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.

This causes genlist to jump to the given item it and show it (by jumping to that position), if it is not fully visible.

Parameters:
[in]objThe object.
[in]typeThe position to bring in, the given item to. Elm_Genlist_Item_Scrollto_Type.
Since :
2.3
Examples:
genlist_example_04.c.
void elm_genlist_item_subitems_clear ( Elm_Genlist_Item *  obj)

Set whether a given genlist item is pinned or not.

This sets a genlist item as pinned so that it will be always available in the viewport available for user interaction. Group items cannot be pinned. Also when a new item is pinned, the current pinned item will get unpinned. Item pinning cannot be done in reorder mode too.

Parameters:
[in]objThe object.
[in]pinThe item pin state state ($true pin item, false unpin item). Get whether a given genlist item is pinned or not.
[in]objThe object.
Returns:
The item pin state state ($true pin item, false unpin item). Get the number of subitems of a given item.

This returns the number of subitems that an item possesses.

Parameters:
[in]objThe object.
Returns:
The number of subitems, 0 on error.
Since (EFL) :
1.9 Remove all sub-items (children) of the given item.

This removes all items that are children (and their descendants) of the given item it.

Parameters:
[in]objThe object.
Since :
2.3
Examples:
genlist_example_05.c.
Elm_Genlist_Item_Type elm_genlist_item_type_get ( const Elm_Genlist_Item *  obj)

Get the Item's type.

This function returns the item's type. Normally the item's type. If it failed, return value is ELM_GENLIST_ITEM_MAX.

Parameters:
[in]objThe object.
Returns:
Item type.
Since :
2.3
void elm_genlist_item_update ( Elm_Genlist_Item *  obj)

Update all the contents of an item.

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.

Note:
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.
Parameters:
[in]objThe object.
Since :
2.3
Examples:
genlist_example_04.c, and genlist_example_05.c.