Tizen Native API  5.5
Elm_Gengrid_Item_Group

Functions

Elm_Widget_Item * elm_gengrid_item_prev_get (const Elm_Gengrid_Item *obj)
 Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items.
Elm_Widget_Item * elm_gengrid_item_next_get (const Elm_Gengrid_Item *obj)
 Get the next item in a gengrid widget's internal list of items, given a handle to one of those items.
void elm_gengrid_item_selected_set (Elm_Gengrid_Item *obj, Eina_Bool selected)
 Control whether a given gengrid item is selected or not.
Eina_Bool elm_gengrid_item_selected_get (const Elm_Gengrid_Item *obj)
 Control whether a given gengrid item is selected or not.
const Elm_Gengrid_Item_Classelm_gengrid_item_item_class_get (const Elm_Gengrid_Item *obj)
 Get the Gengrid Item class for the given Gengrid Item.
int elm_gengrid_item_index_get (const Elm_Gengrid_Item *obj)
 Get the index of the item. It is only valid once displayed.
void elm_gengrid_item_pos_get (const Elm_Gengrid_Item *obj, unsigned int *x, unsigned int *y)
 Get a given gengrid item's position, relative to the whole gengrid's grid area.
void elm_gengrid_item_select_mode_set (Elm_Gengrid_Item *obj, Elm_Object_Select_Mode mode)
 Control the gengrid item's select mode.
Elm_Object_Select_Mode elm_gengrid_item_select_mode_get (const Elm_Gengrid_Item *obj)
 Control the gengrid item's select mode.
void elm_gengrid_item_show (Elm_Gengrid_Item *obj, Elm_Gengrid_Item_Scrollto_Type type)
 Custom size mode for non-homogeneous gengrid.
void elm_gengrid_item_bring_in (Elm_Gengrid_Item *obj, Elm_Gengrid_Item_Scrollto_Type type)
 Animatedly bring in, to the visible area of a gengrid, a given item on it.
void elm_gengrid_item_update (Elm_Gengrid_Item *obj)
 Update the contents of a given gengrid item.
void elm_gengrid_item_fields_update (Elm_Gengrid_Item *obj, const char *parts, Elm_Gengrid_Item_Field_Type itf)
 Update the part of an item.
void elm_gengrid_item_item_class_update (Elm_Gengrid_Item *obj, const Elm_Gengrid_Item_Class *itc)
 Update the item class of a gengrid item.
void elm_gengrid_item_all_contents_unset (Elm_Gengrid_Item *obj, Eina_List **l)
 Unset all contents fetched by the item class.

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_GENGRID_ITEM_FIELD_ALL 

Type all

ELM_GENGRID_ITEM_FIELD_TEXT 

Type text

ELM_GENGRID_ITEM_FIELD_CONTENT 

Type content

ELM_GENGRID_ITEM_FIELD_STATE 

Type state

Defines where to position the item in the genlist.

Enumerator:
ELM_GENGRID_ITEM_SCROLLTO_NONE 

No scrollto.

ELM_GENGRID_ITEM_SCROLLTO_IN 

To the nearest viewport.

ELM_GENGRID_ITEM_SCROLLTO_TOP 

To the top of viewport.

ELM_GENGRID_ITEM_SCROLLTO_MIDDLE 

To the middle of viewport.

ELM_GENGRID_ITEM_SCROLLTO_BOTTOM 

To the bottom of viewport.


Function Documentation

void elm_gengrid_item_all_contents_unset ( Elm_Gengrid_Item *  obj,
Eina_List **  l 
)

Unset all contents fetched by the item class.

This instructs gengrid to release references to contents in the item, meaning that they will no longer be managed by gengrid 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 (EFL) :
1.18
Since :
2.4
void elm_gengrid_item_bring_in ( Elm_Gengrid_Item *  obj,
Elm_Gengrid_Item_Scrollto_Type  type 
)

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

This causes gengrid to jump to the given item and show it (by scrolling), if it is not fully visible. This will use animation to do so and take a period of time to complete.

Parameters:
[in]objThe object.
[in]typeWhere to position the item in the viewport.
Since :
2.3
Examples:
gengrid_example.c, and index_example_02.c.
void elm_gengrid_item_fields_update ( Elm_Gengrid_Item *  obj,
const char *  parts,
Elm_Gengrid_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 parts argument is used for globbing to match '*', '?', and '.' It can be used at updating multi fields.

Use elm_gengrid_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 (EFL) :
1.15
Since :
2.4
int elm_gengrid_item_index_get ( const Elm_Gengrid_Item *  obj)

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

Parameters:
[in]objThe object.
Returns:
The position inside the list of item.
Since :
2.3
const Elm_Gengrid_Item_Class* elm_gengrid_item_item_class_get ( const Elm_Gengrid_Item *  obj)

Get the Gengrid Item class for the given Gengrid Item.

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

Parameters:
[in]objThe object.
Returns:
Gengrid Item class for the given item
Since :
2.3
void elm_gengrid_item_item_class_update ( Elm_Gengrid_Item *  obj,
const Elm_Gengrid_Item_Class itc 
)

Update the item class of a gengrid item.

This sets another class of the item, changing the way that it is displayed. After changing the item class, elm_gengrid_item_update() is called on the item it.

Parameters:
[in]objThe object.
[in]itcThe gengrid item class describing the function pointers and the item style.
Since :
2.3
Elm_Widget_Item* elm_gengrid_item_next_get ( const Elm_Gengrid_Item *  obj)

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

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

Parameters:
[in]objThe object.
Returns:
The item after item, or NULL if there's none (and on errors)
Since :
2.3
void elm_gengrid_item_pos_get ( const Elm_Gengrid_Item *  obj,
unsigned int *  x,
unsigned int *  y 
)

Get a given gengrid item's position, relative to the whole gengrid's grid area.

This returns the "logical" position of the item within the gengrid. For example, $(0, 1) would stand for first row, second column.

Parameters:
[in]objThe object.
[out]xPointer to variable to store the item's row number.
[out]yPointer to variable to store the item's column number.
Since :
2.3
Elm_Widget_Item* elm_gengrid_item_prev_get ( const Elm_Gengrid_Item *  obj)

Get the previous item in a gengrid 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 gengrid.

Parameters:
[in]objThe object.
Returns:
The item before item, or NULL if there's none (and on errors)
Since :
2.3
Elm_Object_Select_Mode elm_gengrid_item_select_mode_get ( const Elm_Gengrid_Item *  obj)

Control the gengrid item's select mode.

(If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)

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

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

Control the gengrid item's select mode.

(If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)

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

Parameters:
[in]objThe object.
[in]modeThe selected mode
Since :
2.3
Eina_Bool elm_gengrid_item_selected_get ( const Elm_Gengrid_Item *  obj)

Control whether a given gengrid item is selected or not.

This API returns true for all the items selected in multi-select mode as well.

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

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

Control whether a given gengrid item is selected or not.

This API returns true for all the items selected in multi-select mode as well.

This sets the selected state of an item. If multi-selection is not enabled on the containing gengrid 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:
gengrid_example.c.
void elm_gengrid_item_show ( Elm_Gengrid_Item *  obj,
Elm_Gengrid_Item_Scrollto_Type  type 
)

Custom size mode for non-homogeneous gengrid.

Resize dimensions of a gengrid item.

In case of a horizontal grid, only the widths only be resized and in case of vertical only the heights can be resized. Item size should be set by elm_gengrid_item_size_set() beforehand.

The values set by elm_gengrid_item_size_set() will be used for the dimension that remains fixed.

Parameters:
[in]objThe object.
[in]wThe item's width.
[in]hThe item's height.
Since (EFL) :
1.19 Custom size mode for non-homogeneous gengrid.

Get the dimensions of a gengrid item.

Gives the dimensions set with elm_gengrid_item_custom_size_set(). If the item has not been modified values set with elm_gengrid_item_size_set() are obtained.

Parameters:
[in]objThe object.
[out]wThe item's width.
[out]hThe item's height.
Since (EFL) :
1.19 Show the portion of a gengrid's internal grid containing a given item, immediately.

This causes gengrid to redraw its viewport's contents to the region containing the given item item, if it is not fully visible.

Parameters:
[in]objThe object.
[in]typeWhere to position the item in the viewport.
Since :
2.3
Examples:
gengrid_example.c.
void elm_gengrid_item_update ( Elm_Gengrid_Item *  obj)

Update the contents of a given gengrid 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 you want the changes to be reflected.

Parameters:
[in]objThe object.
Since :
2.3