Functions
Gengrid (Generic grid)

Functions

EOAPI void elm_obj_gengrid_align_set (double align_x, double align_y)
 Set the items grid's alignment within a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_align_get (double *align_x, double *align_y)
 Get the items grid's alignment values within a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_filled_set (Eina_Bool fill)
 Set how the items grid's filled within a given gengrid widget. More...
 
EOAPI Eina_Bool elm_obj_gengrid_filled_get (void)
 Get how the items grid's filled within a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_multi_select_set (Eina_Bool multi)
 Enable or disable multi-selection in a given gengrid widget. More...
 
EOAPI Eina_Bool elm_obj_gengrid_multi_select_get (void)
 Get whether multi-selection is enabled or disabled for a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_group_item_size_set (Evas_Coord w, Evas_Coord h)
 Set the size for the group items of a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_group_item_size_get (Evas_Coord *w, Evas_Coord *h)
 Get the size set for the group items of a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_select_mode_set (Elm_Object_Select_Mode mode)
 Set the gengrid select mode. More...
 
EOAPI Elm_Object_Select_Mode elm_obj_gengrid_select_mode_get (void)
 Get the gengrid select mode. More...
 
EOAPI void elm_obj_gengrid_reorder_mode_set (Eina_Bool reorder_mode)
 Set whether a given gengrid widget is or not able have items reordered. More...
 
EOAPI Eina_Bool elm_obj_gengrid_reorder_mode_get (void)
 Get whether a given gengrid widget is or not able have items reordered. More...
 
EOAPI void elm_obj_gengrid_item_size_set (Evas_Coord w, Evas_Coord h)
 Set the size for the items of a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_item_size_get (Evas_Coord *w, Evas_Coord *h)
 Get the size set for the items of a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_multi_select_mode_set (Elm_Object_Multi_Select_Mode mode)
 Set the gengrid multi select mode. More...
 
EOAPI Elm_Object_Multi_Select_Mode elm_obj_gengrid_multi_select_mode_get (void)
 Get the gengrid multi select mode. More...
 
EOAPI void elm_obj_gengrid_horizontal_set (Eina_Bool horizontal)
 Set the direction in which a given gengrid widget will expand while placing its items. More...
 
EOAPI Eina_Bool elm_obj_gengrid_horizontal_get (void)
 Get for what direction a given gengrid widget will expand while placing its items. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_selected_item_get (void)
 Get the selected item in a given gengrid widget. More...
 
EOAPI Eina_List * elm_obj_gengrid_realized_items_get (void)
 Get a list of realized items in gengrid. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_first_item_get (void)
 Get the first item in a given gengrid widget. More...
 
EOAPI const Eina_List * elm_obj_gengrid_selected_items_get (void)
 Get a list of selected items in a given gengrid. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_last_item_get (void)
 Get the last item in a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_wheel_disabled_set (Eina_Bool disabled)
 Enable or disable mouse wheel to be used to scroll the gengrid. More...
 
EOAPI Eina_Bool elm_obj_gengrid_wheel_disabled_get (void)
 Get a value whether mouse wheel is enabled or not. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_insert_before (const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data)
 Insert an item before another in a gengrid widget. More...
 
EOAPI void elm_obj_gengrid_realized_items_update (void)
 Update the contents of all realized items. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_insert_after (const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data)
 Insert an item after another in a gengrid widget. More...
 
EOAPI unsigned int elm_obj_gengrid_items_count (void)
 Return how many items are currently in a list. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_at_xy_item_get (Evas_Coord x, Evas_Coord y, int *xposret, int *yposret)
 Get the item that is at the x, y canvas coords. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_append (const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data)
 Append a new item in a given gengrid widget. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_prepend (const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data)
 Prepend a new item in a given gengrid widget. More...
 
EOAPI void elm_obj_gengrid_clear (void)
 Remove all items from a given gengrid widget. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_sorted_insert (const Elm_Gengrid_Item_Class *itc, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data)
 Insert an item in a gengrid widget using a user-defined sort function. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_search_by_text_item_get (Elm_Object_Item *item_to_search_from, const char *part_name, const char *pattern, Elm_Glob_Match_Flags flags)
 Get gengrid item by given string. More...
 
Elm_Object_Itemelm_gengrid::item_insert_before (const Elm_Gengrid_Item_Class *itc_, const void *data_, Elm_Object_Item *relative_, Evas_Smart_Cb func_, const void *func_data_) const
 Insert an item before another in a gengrid widget. More...
 
void elm_gengrid::realized_items_update () const
 Update the contents of all realized items. More...
 
Elm_Object_Itemelm_gengrid::item_insert_after (const Elm_Gengrid_Item_Class *itc_, const void *data_, Elm_Object_Item *relative_, Evas_Smart_Cb func_, const void *func_data_) const
 Insert an item after another in a gengrid widget. More...
 
unsigned int elm_gengrid::items_count () const
 Return how many items are currently in a list. More...
 
Elm_Object_Itemelm_gengrid::at_xy_item_get (Evas_Coord x_, Evas_Coord y_, int *xposret_, int *yposret_) const
 Get the item that is at the x, y canvas coords. More...
 
Elm_Object_Itemelm_gengrid::item_append (const Elm_Gengrid_Item_Class *itc_, const void *data_, Evas_Smart_Cb func_, const void *func_data_) const
 Append a new item in a given gengrid widget. More...
 
Elm_Object_Itemelm_gengrid::item_prepend (const Elm_Gengrid_Item_Class *itc_, const void *data_, Evas_Smart_Cb func_, const void *func_data_) const
 Prepend a new item in a given gengrid widget. More...
 
void elm_gengrid::clear () const
 Remove all items from a given gengrid widget. More...
 
Elm_Object_Itemelm_gengrid::item_sorted_insert (const Elm_Gengrid_Item_Class *itc_, const void *data_, Eina_Compare_Cb comp_, Evas_Smart_Cb func_, const void *func_data_) const
 Insert an item in a gengrid widget using a user-defined sort function. More...
 
Elm_Object_Itemelm_gengrid::search_by_text_item_get (Elm_Object_Item *item_to_search_from_, std::string part_name_, std::string pattern_, Elm_Glob_Match_Flags flags_) const
 Get gengrid item by given string. More...
 
void elm_gengrid::align_get (double *align_x_, double *align_y_) const
 Get the items grid's alignment values within a given gengrid widget. More...
 
void elm_gengrid::align_set (double align_x_, double align_y_) const
 Get the items grid's alignment values within a given gengrid widget. More...
 
bool elm_gengrid::filled_get () const
 Get how the items grid's filled within a given gengrid widget. More...
 
void elm_gengrid::filled_set (bool fill_) const
 Get how the items grid's filled within a given gengrid widget. More...
 
bool elm_gengrid::multi_select_get () const
 Get whether multi-selection is enabled or disabled for a given gengrid widget. More...
 
void elm_gengrid::multi_select_set (bool multi_) const
 Get whether multi-selection is enabled or disabled for a given gengrid widget. More...
 
void elm_gengrid::group_item_size_get (Evas_Coord *w_, Evas_Coord *h_) const
 Get the size set for the group items of a given gengrid widget. More...
 
void elm_gengrid::group_item_size_set (Evas_Coord w_, Evas_Coord h_) const
 Get the size set for the group items of a given gengrid widget. More...
 
Elm_Object_Select_Mode elm_gengrid::select_mode_get () const
 Get the gengrid select mode. More...
 
void elm_gengrid::select_mode_set (Elm_Object_Select_Mode mode_) const
 Get the gengrid select mode. More...
 
bool elm_gengrid::reorder_mode_get () const
 Get whether a given gengrid widget is or not able have items reordered. More...
 
void elm_gengrid::reorder_mode_set (bool reorder_mode_) const
 Get whether a given gengrid widget is or not able have items reordered. More...
 
void elm_gengrid::item_size_get (Evas_Coord *w_, Evas_Coord *h_) const
 Get the size set for the items of a given gengrid widget. More...
 
void elm_gengrid::item_size_set (Evas_Coord w_, Evas_Coord h_) const
 Get the size set for the items of a given gengrid widget. More...
 
Elm_Object_Multi_Select_Mode elm_gengrid::multi_select_mode_get () const
 Get the gengrid multi select mode. More...
 
void elm_gengrid::multi_select_mode_set (Elm_Object_Multi_Select_Mode mode_) const
 Get the gengrid multi select mode. More...
 
bool elm_gengrid::horizontal_get () const
 Get for what direction a given gengrid widget will expand while placing its items. More...
 
void elm_gengrid::horizontal_set (bool horizontal_) const
 Get for what direction a given gengrid widget will expand while placing its items. More...
 
Elm_Object_Itemelm_gengrid::selected_item_get () const
 Get the selected item in a given gengrid widget. More...
 
Eina_List * elm_gengrid::realized_items_get () const
 Get a list of realized items in gengrid. More...
 
Elm_Object_Itemelm_gengrid::first_item_get () const
 Get the first item in a given gengrid widget. More...
 
const Eina_List * elm_gengrid::selected_items_get () const
 Get a list of selected items in a given gengrid. More...
 
Elm_Object_Itemelm_gengrid::last_item_get () const
 Get the last item in a given gengrid widget. More...
 
bool elm_gengrid::wheel_disabled_get () const
 Get a value whether mouse wheel is enabled or not. More...
 
void elm_gengrid::wheel_disabled_set (bool disabled_) const
 Get a value whether mouse wheel is enabled or not. More...
 
void elm_gengrid_align_set (Elm_Gengrid *obj, double align_x, double align_y)
 Set the items grid's alignment within a given gengrid widget. More...
 
void elm_gengrid_align_get (const Elm_Gengrid *obj, double *align_x, double *align_y)
 Get the items grid's alignment values within a given gengrid widget. More...
 
void elm_gengrid_filled_set (Elm_Gengrid *obj, Eina_Bool fill)
 Set how the items grid's filled within a given gengrid widget. More...
 
Eina_Bool elm_gengrid_filled_get (const Elm_Gengrid *obj)
 Get how the items grid's filled within a given gengrid widget. More...
 
void elm_gengrid_multi_select_set (Elm_Gengrid *obj, Eina_Bool multi)
 Enable or disable multi-selection in a given gengrid widget. More...
 
Eina_Bool elm_gengrid_multi_select_get (const Elm_Gengrid *obj)
 Get whether multi-selection is enabled or disabled for a given gengrid widget. More...
 
void elm_gengrid_group_item_size_set (Elm_Gengrid *obj, Evas_Coord w, Evas_Coord h)
 Set the size for the group items of a given gengrid widget. More...
 
void elm_gengrid_group_item_size_get (const Elm_Gengrid *obj, Evas_Coord *w, Evas_Coord *h)
 Get the size set for the group items of a given gengrid widget. More...
 
void elm_gengrid_select_mode_set (Elm_Gengrid *obj, Elm_Object_Select_Mode mode)
 Set the gengrid select mode. More...
 
Elm_Object_Select_Mode elm_gengrid_select_mode_get (const Elm_Gengrid *obj)
 Get the gengrid select mode. More...
 
void elm_gengrid_reorder_mode_set (Elm_Gengrid *obj, Eina_Bool reorder_mode)
 Set whether a given gengrid widget is or not able have items reordered. More...
 
Eina_Bool elm_gengrid_reorder_mode_get (const Elm_Gengrid *obj)
 Get whether a given gengrid widget is or not able have items reordered. More...
 
void elm_gengrid_item_size_set (Elm_Gengrid *obj, Evas_Coord w, Evas_Coord h)
 Set the size for the items of a given gengrid widget. More...
 
void elm_gengrid_item_size_get (const Elm_Gengrid *obj, Evas_Coord *w, Evas_Coord *h)
 Get the size set for the items of a given gengrid widget. More...
 
void elm_gengrid_multi_select_mode_set (Elm_Gengrid *obj, Elm_Object_Multi_Select_Mode mode)
 Set the gengrid multi select mode. More...
 
Elm_Object_Multi_Select_Mode elm_gengrid_multi_select_mode_get (const Elm_Gengrid *obj)
 Get the gengrid multi select mode. More...
 
void elm_gengrid_horizontal_set (Elm_Gengrid *obj, Eina_Bool horizontal)
 Set the direction in which a given gengrid widget will expand while placing its items. More...
 
Eina_Bool elm_gengrid_horizontal_get (const Elm_Gengrid *obj)
 Get for what direction a given gengrid widget will expand while placing its items. More...
 
Elm_Object_Itemelm_gengrid_selected_item_get (const Elm_Gengrid *obj)
 Get the selected item in a given gengrid widget. More...
 
Eina_List * elm_gengrid_realized_items_get (const Elm_Gengrid *obj)
 Get a list of realized items in gengrid. More...
 
Elm_Object_Itemelm_gengrid_first_item_get (const Elm_Gengrid *obj)
 Get the first item in a given gengrid widget. More...
 
const Eina_List * elm_gengrid_selected_items_get (const Elm_Gengrid *obj)
 Get a list of selected items in a given gengrid. More...
 
Elm_Object_Itemelm_gengrid_last_item_get (const Elm_Gengrid *obj)
 Get the last item in a given gengrid widget. More...
 
void elm_gengrid_wheel_disabled_set (Elm_Gengrid *obj, Eina_Bool disabled)
 Enable or disable mouse wheel to be used to scroll the gengrid. More...
 
Eina_Bool elm_gengrid_wheel_disabled_get (const Elm_Gengrid *obj)
 Get a value whether mouse wheel is enabled or not. More...
 
Elm_Object_Itemelm_gengrid_item_insert_before (Elm_Gengrid *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data)
 Insert an item before another in a gengrid widget. More...
 
void elm_gengrid_realized_items_update (Elm_Gengrid *obj)
 Update the contents of all realized items. More...
 
Elm_Object_Itemelm_gengrid_item_insert_after (Elm_Gengrid *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data)
 Insert an item after another in a gengrid widget. More...
 
unsigned int elm_gengrid_items_count (const Elm_Gengrid *obj)
 Return how many items are currently in a list. More...
 
Elm_Object_Itemelm_gengrid_at_xy_item_get (const Elm_Gengrid *obj, Evas_Coord x, Evas_Coord y, int *xposret, int *yposret)
 Get the item that is at the x, y canvas coords. More...
 
Elm_Object_Itemelm_gengrid_item_append (Elm_Gengrid *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data)
 Append a new item in a given gengrid widget. More...
 
Elm_Object_Itemelm_gengrid_item_prepend (Elm_Gengrid *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data)
 Prepend a new item in a given gengrid widget. More...
 
void elm_gengrid_clear (Elm_Gengrid *obj)
 Remove all items from a given gengrid widget. More...
 
Elm_Object_Itemelm_gengrid_item_sorted_insert (Elm_Gengrid *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data)
 Insert an item in a gengrid widget using a user-defined sort function. More...
 
Elm_Object_Itemelm_gengrid_search_by_text_item_get (Elm_Gengrid *obj, Elm_Object_Item *item_to_search_from, const char *part_name, const char *pattern, Elm_Glob_Match_Flags flags)
 Get gengrid item by given string. More...
 
Elm_Gengrid_Item_Classelm_gengrid_item_class_new (void)
 Add a new gengrid item class in a given gengrid widget. More...
 
void elm_gengrid_item_class_free (Elm_Gengrid_Item_Class *itc)
 Remove an item class in a given gengrid widget. More...
 
void elm_gengrid_item_class_ref (Elm_Gengrid_Item_Class *itc)
 Increments object reference count for the item class. More...
 
void elm_gengrid_item_class_unref (Elm_Gengrid_Item_Class *itc)
 Decrements object reference count for the item class. More...
 
void elm_gengrid_item_tooltip_text_set (Elm_Object_Item *it, const char *text)
 Set the text to be shown in a given gengrid item's tooltips. More...
 
void elm_gengrid_item_tooltip_content_cb_set (Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb)
 Set the content to be shown in a given gengrid item's tooltip. More...
 
void elm_gengrid_item_tooltip_unset (Elm_Object_Item *it)
 Unset a tooltip from a given gengrid item. More...
 
void elm_gengrid_item_tooltip_style_set (Elm_Object_Item *it, const char *style)
 Set a different style for a given gengrid item's tooltip. More...
 
const char * elm_gengrid_item_tooltip_style_get (const Elm_Object_Item *it)
 Get the style set a given gengrid item's tooltip. More...
 
void elm_gengrid_item_cursor_set (Elm_Object_Item *it, const char *cursor)
 Set the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given gengrid widget item. More...
 
const char * elm_gengrid_item_cursor_get (const Elm_Object_Item *it)
 Get the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given gengrid widget item. More...
 
void elm_gengrid_item_cursor_unset (Elm_Object_Item *it)
 Unset any custom mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given gengrid widget item, thus making it show the default cursor again. More...
 
void elm_gengrid_item_cursor_style_set (Elm_Object_Item *it, const char *style)
 Set a different style for a given custom cursor set for a gengrid item. More...
 
const char * elm_gengrid_item_cursor_style_get (const Elm_Object_Item *it)
 Get the current style set for a given gengrid item's custom cursor. More...
 
void elm_gengrid_item_cursor_engine_only_set (Elm_Object_Item *it, Eina_Bool engine_only)
 Set if the (custom) cursor for a given gengrid item should be searched in its theme, also, or should only rely on the rendering engine. More...
 
Eina_Bool elm_gengrid_item_cursor_engine_only_get (const Elm_Object_Item *it)
 Get if the (custom) cursor for a given gengrid item is being searched in its theme, also, or is only relying on the rendering engine. More...
 
void elm_gengrid_item_pos_get (const Elm_Object_Item *it, unsigned int *x, unsigned int *y)
 Get a given gengrid item's position, relative to the whole gengrid's grid area. More...
 
void elm_gengrid_item_select_mode_set (Elm_Object_Item *it, Elm_Object_Select_Mode mode)
 Set the gengrid item's select mode. More...
 
Elm_Object_Select_Mode elm_gengrid_item_select_mode_get (const Elm_Object_Item *it)
 Get the gengrid item's select mode. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_prev_get (void)
 Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items. More...
 
EOAPI Elm_Object_Itemelm_obj_gengrid_item_next_get (void)
 Get the next item in a gengrid widget's internal list of items, given a handle to one of those items. More...
 
EOAPI void elm_obj_gengrid_item_selected_set (Eina_Bool selected)
 Set whether a given gengrid item is selected or not. More...
 
EOAPI Eina_Bool elm_obj_gengrid_item_selected_get (void)
 Get whether a given gengrid item is selected or not. More...
 
EOAPI const Elm_Gengrid_Item_Classelm_obj_gengrid_item_class_get (void)
 Get the Gengrid Item class for the given Gengrid Item. More...
 
EOAPI int elm_obj_gengrid_item_index_get (void)
 Get the index of the item. More...
 
EOAPI void elm_obj_gengrid_item_pos_get (unsigned int *x, unsigned int *y)
 Get a given gengrid item's position, relative to the whole gengrid's grid area. More...
 
EOAPI void elm_obj_gengrid_item_select_mode_set (Elm_Object_Select_Mode mode)
 Set the gengrid item's select mode. More...
 
EOAPI Elm_Object_Select_Mode elm_obj_gengrid_item_select_mode_get (void)
 Get the gengrid item's select mode. More...
 
EOAPI void elm_obj_gengrid_item_show (Elm_Gengrid_Item_Scrollto_Type type)
 Show the portion of a gengrid's internal grid containing a given item, immediately. More...
 
EOAPI void elm_obj_gengrid_item_bring_in (Elm_Gengrid_Item_Scrollto_Type type)
 Animatedly bring in, to the visible area of a gengrid, a given item on it. More...
 
EOAPI void elm_obj_gengrid_item_update (void)
 Update the contents of a given gengrid item. More...
 
EOAPI void elm_obj_gengrid_item_fields_update (const char *parts, Elm_Gengrid_Item_Field_Type itf)
 Update the part of an item. More...
 
EOAPI void elm_obj_gengrid_item_class_update (const Elm_Gengrid_Item_Class *itc)
 Update the item class of a gengrid item. More...
 
Elm_Object_Itemelm_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. More...
 
Elm_Object_Itemelm_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. More...
 
void elm_gengrid_item_selected_set (Elm_Gengrid_Item *obj, Eina_Bool selected)
 Set whether a given gengrid item is selected or not. More...
 
Eina_Bool elm_gengrid_item_selected_get (const Elm_Gengrid_Item *obj)
 Get whether a given gengrid item is selected or not. More...
 
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. More...
 
int elm_gengrid_item_index_get (const Elm_Gengrid_Item *obj)
 Get the index of the item. More...
 
void elm_gengrid_item_show (Elm_Gengrid_Item *obj, Elm_Gengrid_Item_Scrollto_Type type)
 Show the portion of a gengrid's internal grid containing a given item, immediately. More...
 
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. More...
 
void elm_gengrid_item_update (Elm_Gengrid_Item *obj)
 Update the contents of a given gengrid item. More...
 
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. More...
 
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. More...
 
Evas_Object * elm_gengrid_add (Evas_Object *parent)
 Add a new gengrid widget to the given parent Elementary (container) object. More...
 
EINA_DEPRECATED void elm_gengrid_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_gengrid_scroller_policy_get (const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v)
 Get the scrollbar policy. More...
 
EINA_DEPRECATED void elm_gengrid_bounce_set (Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
 Enable or disable bouncing effect for a given gengrid widget. More...
 
EINA_DEPRECATED void elm_gengrid_bounce_get (const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
 Get whether bouncing effects are enabled or disabled, for a given gengrid widget, on each axis. More...
 
void elm_gengrid_reorder_mode_start (Evas_Object *obj, Ecore_Pos_Map tween_mode)
 Enable the gengrid widget mode reordered with keys. More...
 
void elm_gengrid_reorder_mode_stop (Evas_Object *obj)
 Stop the gengrid widget mode reorder. More...
 
void elm_gengrid_reorder_type_set (Evas_Object *obj, Elm_Gengrid_Reorder_Type type)
 Set the reorder type. More...
 

Detailed Description

gengrid_inheritance_tree.png

This widget aims to position objects in a grid layout while actually creating and rendering only the visible ones, using the same idea as the genlist: the user defines a class for each item, specifying functions that will be called at object creation, deletion, etc. When those items are selected by the user, a callback function is issued. Users may interact with a gengrid via the mouse (by clicking on items to select them and clicking on the grid's viewport and swiping to pan the whole view) or via the keyboard, navigating through item with the arrow keys.

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

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

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

Gengrid layouts

Gengrid may layout its items in one of two possible layouts:

When in "horizontal mode", items will be placed in columns, from top to bottom and, when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally, making for horizontal scrolling. When in "vertical mode" , though, items will be placed in rows, from left to right and, when the space for a row is filled, another one is started below, thus expanding the grid vertically (and making for vertical scrolling).

Gengrid items

An item in a gengrid 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 gengrid 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 gengrid, under the Edje (string) data items named "texts", "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 gengrid item theme, we have one text part ("elm.text"), two content parts ("elm.swallow.icon" and "elm.swallow.end") and no state parts.

A gengrid 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).

Gengrid item classes

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

Usage hints

If the user wants to have multiple items selected at the same time, elm_gengrid_multi_select_set() will permit it. If the gengrid is single-selection only (the default), then elm_gengrid_select_item_get() will return the selected item or NULL, if none is selected. If the gengrid is under multi-selection, then elm_gengrid_selected_items_get() will return a list (that is only valid as long as no items are modified (added, deleted, selected or unselected) of child items on a gengrid.

If an item changes (internal (boolean) state, text or content changes), then use elm_gengrid_item_update() to have gengrid update the item with the new state. A gengrid will re-"realize" the item, thus calling the functions in the #Elm_Gengrid_Item_Class set for that item.

To programmatically (un)select an item, use elm_gengrid_item_selected_set(). To get its selected state use elm_gengrid_item_selected_get(). 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.

Grid cells will only have their selection smart callbacks called when firstly getting selected. Any further clicks will do nothing, unless you enable the "always select mode", with elm_gengrid_select_mode_set() as ELM_OBJECT_SELECT_MODE_ALWAYS, thus making every click to issue selection callbacks. elm_gengrid_select_mode_set() as ELM_OBJECT_SELECT_MODE_NONE will turn off the ability to select items entirely in the widget and they will neither appear selected nor call the selection smart callbacks.

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.

Gengrid smart events

This widget emits the following signals, besides the ones sent from Layout:

Supported elm_object common APIs

Supported elm_object_item common APIs

Unsupported elm_object_item common APIs due to the gengrid concept. Gengrid fills content/text according to the appropriate callback functions. Please use elm_gengrid_item_update() instead.

List of gengrid examples:

Function Documentation

void elm_gengrid::align_get ( double *  align_x_,
double *  align_y_ 
) const
inline

Get the items grid's alignment values within a given gengrid widget.

Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
align_xAlignment in the horizontal axis (0 <= align_x <= 1).
align_yAlignment in the vertical axis (0 <= align_y <= 1).

References elm_obj_gengrid_align_get().

void elm_gengrid::align_set ( double  align_x_,
double  align_y_ 
) const
inline

Get the items grid's alignment values within a given gengrid widget.

Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
align_xAlignment in the horizontal axis (0 <= align_x <= 1).
align_yAlignment in the vertical axis (0 <= align_y <= 1).

References elm_obj_gengrid_align_set().

Elm_Object_Item* elm_gengrid::at_xy_item_get ( Evas_Coord  x_,
Evas_Coord  y_,
int *  xposret_,
int *  yposret_ 
) const
inline

Get the item that is at the x, y canvas coords.

Returns
The item at the coordinates or NULL if none

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 xposret is not NULL, the integer pointed to is set to a value of -1, 0 or 1, depending if the coordinate is on the left portion of that item (-1), on the middle section (0) or on the right part (1). if yposret 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 gengrid.

Parameters
xThe input x coordinate
yThe input y coordinate
[out]xposretThe position relative to the item returned here
[out]yposretThe position relative to the item returned here

References elm_obj_gengrid_at_xy_item_get().

void elm_gengrid::clear ( ) const
inline

Remove all items from a given gengrid widget.

This removes (and deletes) all items in obj, leaving it empty.

See also
elm_object_item_del(), to remove just one item.

References elm_obj_gengrid_clear().

Evas_Object* elm_gengrid_add ( Evas_Object *  parent)

Add a new gengrid widget to the given parent Elementary (container) object.

Parameters
parentThe parent object
Returns
a new gengrid widget handle or NULL, on errors

This function inserts a new gengrid widget on the canvas.

See also
elm_gengrid_item_size_set()
elm_gengrid_group_item_size_set()
elm_gengrid_horizontal_set()
elm_gengrid_item_append()
elm_object_item_del()
elm_gengrid_clear()
void elm_gengrid_align_get ( const Elm_Gengrid *  obj,
double *  align_x,
double *  align_y 
)

Get the items grid's alignment values within a given gengrid widget.

Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
[out]align_xAlignment in the horizontal axis (0 <= align_x <= 1).
[out]align_yAlignment in the vertical axis (0 <= align_y <= 1).

References elm_obj_gengrid_align_get().

void elm_gengrid_align_set ( Elm_Gengrid *  obj,
double  align_x,
double  align_y 
)

Set the items grid's alignment within a given gengrid widget.

This sets the alignment of the whole grid of items of a gengrid within its given viewport. By default, those values are both 0.5, meaning that the gengrid will have its items grid placed exactly in the middle of its viewport.

Note
If given alignment values are out of the cited ranges, they'll be changed to the nearest boundary values on the valid ranges.
See also
elm_gengrid_align_get()
Parameters
[in]align_xAlignment in the horizontal axis (0 <= align_x <= 1).
[in]align_yAlignment in the vertical axis (0 <= align_y <= 1).

References elm_obj_gengrid_align_set().

Elm_Object_Item* elm_gengrid_at_xy_item_get ( const Elm_Gengrid *  obj,
Evas_Coord  x,
Evas_Coord  y,
int *  xposret,
int *  yposret 
)

Get the item that is at the x, y canvas coords.

Returns
The item at the coordinates or NULL if none

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 xposret is not NULL, the integer pointed to is set to a value of -1, 0 or 1, depending if the coordinate is on the left portion of that item (-1), on the middle section (0) or on the right part (1). if yposret 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 gengrid.

Parameters
[in]xThe input x coordinate
[in]yThe input y coordinate
[out]xposretThe position relative to the item returned here
[out]yposretThe position relative to the item returned here

References elm_obj_gengrid_at_xy_item_get().

EINA_DEPRECATED void elm_gengrid_bounce_get ( const Evas_Object *  obj,
Eina_Bool *  h_bounce,
Eina_Bool *  v_bounce 
)

Get whether bouncing effects are enabled or disabled, for a given gengrid widget, on each axis.

Parameters
objThe gengrid object
h_bouncePointer to a variable where to store the horizontal bouncing flag.
v_bouncePointer to a variable where to store the vertical bouncing flag.
Deprecated:
Use elm_scroller_bounce_get() instead.
See also
elm_scroller_bounce_get()

References elm_interface_scrollable_bounce_allow_get().

EINA_DEPRECATED void elm_gengrid_bounce_set ( Evas_Object *  obj,
Eina_Bool  h_bounce,
Eina_Bool  v_bounce 
)

Enable or disable bouncing effect for a given gengrid widget.

Parameters
objThe gengrid object
h_bounceEINA_TRUE, to enable horizontal bouncing, EINA_FALSE to disable it
v_bounceEINA_TRUE, to enable vertical bouncing, EINA_FALSE to disable it

The bouncing effect occurs whenever one reaches the gengrid's edge's while panning it – it will scroll past its limits a little bit and return to the edge again, in a animated for, automatically.

Note
By default, gengrids have bouncing enabled on both axis
Deprecated:
Use elm_scroller_bounce_set() instead.
See also
elm_scroller_bounce_set()

References elm_interface_scrollable_bounce_allow_set().

void elm_gengrid_clear ( Elm_Gengrid *  obj)

Remove all items from a given gengrid widget.

This removes (and deletes) all items in obj, leaving it empty.

See also
elm_object_item_del(), to remove just one item.

References elm_obj_gengrid_clear().

Eina_Bool elm_gengrid_filled_get ( const Elm_Gengrid *  obj)

Get how the items grid's filled within a given gengrid widget.

Returns
EINA_TRUE, if filled is on, EINA_FALSE if it's off
Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details

References elm_obj_gengrid_filled_get().

void elm_gengrid_filled_set ( Elm_Gengrid *  obj,
Eina_Bool  fill 
)

Set how the items grid's filled within a given gengrid widget.

This sets the fill state of the whole grid of items of a gengrid within its given viewport. By default, this value is false, meaning that if the first line of items grid's isn't filled, the items are centered with the alignment

See also
elm_gengrid_filled_get()
Parameters
[in]fillFilled if True

References elm_obj_gengrid_filled_set().

Elm_Object_Item* elm_gengrid_first_item_get ( const Elm_Gengrid *  obj)

Get the first item in a given gengrid widget.

Returns
The first item's handle or NULL, if there are no items in obj (and on errors)

This returns the first item in the obj's internal list of items.

See also
elm_gengrid_last_item_get()

References elm_obj_gengrid_first_item_get().

void elm_gengrid_group_item_size_get ( const Elm_Gengrid *  obj,
Evas_Coord *  w,
Evas_Coord *  h 
)

Get the size set for the group items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_group_item_size_get() for more details
Parameters
[out]wThe group items' width.
[out]hThe group items' height.

References elm_obj_gengrid_group_item_size_get().

void elm_gengrid_group_item_size_set ( Elm_Gengrid *  obj,
Evas_Coord  w,
Evas_Coord  h 
)

Set the size for the group items of a given gengrid widget.

A gengrid, after creation, has still no information on the size to give to each of its cells. So, you most probably will end up with squares one finger wide, the default size. Use this function to force a custom size for you group items, making them as big as you wish.

See also
elm_gengrid_group_item_size_get()
Parameters
[in]wThe group items' width.
[in]hThe group items' height.

References elm_obj_gengrid_group_item_size_set().

Eina_Bool elm_gengrid_horizontal_get ( const Elm_Gengrid *  obj)

Get for what direction a given gengrid widget will expand while placing its items.

Returns
EINA_TRUE, if obj is set to expand horizontally, EINA_FALSE if it's set to expand vertically.
See also
elm_gengrid_horizontal_set() for more details

References elm_obj_gengrid_horizontal_get().

void elm_gengrid_horizontal_set ( Elm_Gengrid *  obj,
Eina_Bool  horizontal 
)

Set the direction in which a given gengrid widget will expand while placing its items.

When in "horizontal mode" (EINA_TRUE), items will be placed in columns, from top to bottom and, when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. When in "vertical mode" (EINA_FALSE), though, items will be placed in rows, from left to right and, when the space for a row is filled, another one is started below, thus expanding the grid vertically.

Note
By default, gengrid is in vertical mode, EINA_FALSE.
See also
elm_gengrid_horizontal_get()
Parameters
[in]horizontalEINA_TRUE to make the gengrid expand horizontally, EINA_FALSE to expand vertically.

References elm_obj_gengrid_horizontal_set().

Elm_Object_Item* elm_gengrid_item_append ( Elm_Gengrid *  obj,
const Elm_Gengrid_Item_Class itc,
const void *  data,
Evas_Smart_Cb  func,
const void *  func_data 
)

Append a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the beginning of the gengrid.

See also
elm_gengrid_item_prepend()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

References elm_obj_gengrid_item_append().

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.

See also
elm_gengrid_item_show()
Parameters
[in]typeWhere to position the item in the viewport.

References elm_obj_gengrid_item_bring_in().

void elm_gengrid_item_class_free ( Elm_Gengrid_Item_Class itc)

Remove an item class in a given gengrid widget.

Parameters
itcThe itc to be removed.

This removes item class from the gengrid widget. Whenever it has no more references to it, item class is going to be freed. Otherwise it just decreases its reference count.

See also
elm_gengrid_item_class_new()
elm_gengrid_item_class_ref()
elm_gengrid_item_class_unref()

References elm_gengrid_item_class_unref().

Referenced by elm_gengrid_item_class_unref().

Elm_Gengrid_Item_Class* elm_gengrid_item_class_new ( void  )

Add a new gengrid item class in a given gengrid widget.

Returns
New allocated a gengrid item class.

This adds gengrid item class for the gengrid widget. When adding an item, gengrid_item_{append, prepend, insert} function needs item class of the item. Given callback parameters are used at retrieving {text, content} of added item. Set as NULL if it's not used. If there's no available memory, return can be NULL.

See also
elm_gengrid_item_class_free()
elm_gengrid_item_append()
void elm_gengrid_item_class_ref ( Elm_Gengrid_Item_Class itc)

Increments object reference count for the item class.

Parameters
itcThe given item class object to reference

This API just increases its reference count for item class management.

See also
elm_gengrid_item_class_unref()
void elm_gengrid_item_class_unref ( Elm_Gengrid_Item_Class itc)

Decrements object reference count for the item class.

Parameters
itcThe given item class object to reference

This API just decreases its reference count for item class management. Reference count can't be less than 0.

See also
elm_gengrid_item_class_ref()
elm_gengrid_item_class_free()

References elm_gengrid_item_class_free().

Referenced by elm_gengrid_item_class_free().

Eina_Bool elm_gengrid_item_cursor_engine_only_get ( const Elm_Object_Item it)

Get if the (custom) cursor for a given gengrid item is being searched in its theme, also, or is only relying on the rendering engine.

Parameters
ita gengrid item
Returns
EINA_TRUE, if cursors are being looked for only on those provided by the rendering engine, EINA_FALSE if they are being searched on the widget's theme, as well.
See also
elm_gengrid_item_cursor_engine_only_set(), for more details

References elm_wdg_item_cursor_engine_only_get().

void elm_gengrid_item_cursor_engine_only_set ( Elm_Object_Item it,
Eina_Bool  engine_only 
)

Set if the (custom) cursor for a given gengrid item should be searched in its theme, also, or should only rely on the rendering engine.

Parameters
ititem with custom (custom) cursor already set on
engine_onlyUse EINA_TRUE to have cursors looked for only on those provided by the rendering engine, EINA_FALSE to have them searched on the widget's theme, as well.
Note
This call is of use only if you've set a custom cursor for gengrid items, with elm_gengrid_item_cursor_set().
By default, cursors will only be looked for between those provided by the rendering engine.

References elm_wdg_item_cursor_engine_only_set().

const char* elm_gengrid_item_cursor_get ( const Elm_Object_Item it)

Get the type of mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given gengrid widget item.

Parameters
itgengrid item with custom cursor set
Returns
the cursor type's name or NULL, if no custom cursors were set to item (and on errors)
See also
elm_object_cursor_get()
elm_gengrid_item_cursor_set() for more details
elm_gengrid_item_cursor_unset()

References elm_wdg_item_cursor_get().

void elm_gengrid_item_cursor_set ( Elm_Object_Item it,
const char *  cursor 
)

Set the type of mouse pointer/cursor decoration to be shown, when the mouse pointer is over the given gengrid widget item.

Parameters
itgengrid item to customize cursor on
cursorthe cursor type's name

This function works analogously as elm_object_cursor_set(), but here the cursor's changing area is restricted to the item's area, and not the whole widget's. Note that that item cursors have precedence over widget cursors, so that a mouse over item will always show cursor type.

If this function is called twice for an object, a previously set cursor will be unset on the second call.

See also
elm_object_cursor_set()
elm_gengrid_item_cursor_get()
elm_gengrid_item_cursor_unset()

References elm_wdg_item_cursor_set().

const char* elm_gengrid_item_cursor_style_get ( const Elm_Object_Item it)

Get the current style set for a given gengrid item's custom cursor.

Parameters
itgengrid item with custom cursor set.
Returns
style the cursor style in use. If the object does not have a cursor set, then NULL is returned.
See also
elm_gengrid_item_cursor_style_set() for more details

References elm_wdg_item_cursor_style_get().

void elm_gengrid_item_cursor_style_set ( Elm_Object_Item it,
const char *  style 
)

Set a different style for a given custom cursor set for a gengrid item.

Parameters
itgengrid item with custom cursor set
stylethe theme style to use (e.g. "default", "transparent", etc)

This function only makes sense when one is using custom mouse cursor decorations defined in a theme file , which can have, given a cursor name/type, alternate styles on it. It works analogously as elm_object_cursor_style_set(), but here applied only to gengrid item objects.

Warning
Before you set a cursor style you should have defined a custom cursor previously on the item, with elm_gengrid_item_cursor_set()
See also
elm_gengrid_item_cursor_engine_only_set()
elm_gengrid_item_cursor_style_get()

References elm_wdg_item_cursor_style_set().

void elm_gengrid_item_cursor_unset ( Elm_Object_Item it)

Unset any custom mouse pointer/cursor decoration set to be shown, when the mouse pointer is over the given gengrid widget item, thus making it show the default cursor again.

Parameters
ita gengrid item

Use this call to undo any custom settings on this item's cursor decoration, bringing it back to defaults (no custom style set).

See also
elm_object_cursor_unset()
elm_gengrid_item_cursor_set() for more details

References elm_wdg_item_cursor_unset().

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.

See also
elm_gengrid_iitem_update()
Since
1.15
Parameters
[in]partsThe name of item's part
[in]itfThe type of item's part type

References elm_obj_gengrid_item_fields_update().

int elm_gengrid_item_index_get ( const Elm_Gengrid_Item *  obj)

Get the index of the item.

It is only valid once displayed.

References elm_obj_gengrid_item_index_get().

Elm_Object_Item* elm_gengrid_item_insert_after ( Elm_Gengrid *  obj,
const Elm_Gengrid_Item_Class itc,
const void *  data,
Elm_Object_Item relative,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item after another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item after another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]relativeThe item to place this new one after.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

References elm_obj_gengrid_item_insert_after().

Elm_Object_Item* elm_gengrid_item_insert_before ( Elm_Gengrid *  obj,
const Elm_Gengrid_Item_Class itc,
const void *  data,
Elm_Object_Item relative,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item before another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item before another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]relativeThe item to place this new one before.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

References elm_obj_gengrid_item_insert_before().

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.

References elm_obj_gengrid_item_class_get().

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]itcThe gengrid item class describing the function pointers and the item style.

References elm_obj_gengrid_item_class_update().

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

See also
elm_gengrid_item_prev_get()

References elm_obj_gengrid_item_next_get().

void elm_gengrid_item_pos_get ( const Elm_Object_Item it,
unsigned int *  x,
unsigned int *  y 
)

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

Parameters
itThe Gengrid item.
xPointer to variable to store the item's row number.
yPointer to variable to store the item's column number.

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

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

Parameters
[out]xPointer to variable to store the item's row number.
[out]yPointer to variable to store the item's column number.
Examples:
gengrid_example.c.

References elm_obj_gengrid_item_pos_get().

Elm_Object_Item* elm_gengrid_item_prepend ( Elm_Gengrid *  obj,
const Elm_Gengrid_Item_Class itc,
const void *  data,
Evas_Smart_Cb  func,
const void *  func_data 
)

Prepend a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the end of the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

References elm_obj_gengrid_item_prepend().

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

See also
elm_gengrid_item_next_get()

References elm_obj_gengrid_item_prev_get().

Elm_Object_Select_Mode elm_gengrid_item_select_mode_get ( const Elm_Object_Item it)

Get the gengrid item's select mode.

Parameters
itThe gengrid item object
Returns
The select mode (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
See also
elm_gengrid_item_select_mode_set()

(If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)

See also
elm_gengrid_item_select_mode_set()

References elm_obj_gengrid_item_select_mode_get().

void elm_gengrid_item_select_mode_set ( Elm_Object_Item it,
Elm_Object_Select_Mode  mode 
)

Set the gengrid item's select mode.

Parameters
itThe gengrid item object
modeThe select mode

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.
See also
elm_gengrid_item_select_mode_get()

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.
See also
elm_gengrid_item_select_mode_get()
Parameters
[in]modeThe selected mode

References elm_obj_gengrid_item_select_mode_set().

Eina_Bool elm_gengrid_item_selected_get ( const Elm_Gengrid_Item *  obj)

Get whether a given gengrid item is selected or not.

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

See also
elm_gengrid_item_selected_set() for more details

References elm_obj_gengrid_item_selected_get().

void elm_gengrid_item_selected_set ( Elm_Gengrid_Item *  obj,
Eina_Bool  selected 
)

Set whether a given gengrid item is selected or not.

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

See also
elm_gengrid_item_selected_get()
Parameters
[in]selectedthe selected state (EINA_TRUE selected, EINA_FALSE not selected)

References elm_obj_gengrid_item_selected_set().

void elm_gengrid_item_show ( Elm_Gengrid_Item *  obj,
Elm_Gengrid_Item_Scrollto_Type  type 
)

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.

See also
elm_gengrid_item_bring_in()
Parameters
[in]typeWhere to position the item in the viewport.

References elm_obj_gengrid_item_show().

void elm_gengrid_item_size_get ( const Elm_Gengrid *  obj,
Evas_Coord *  w,
Evas_Coord *  h 
)

Get the size set for the items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_item_size_get() for more details
Parameters
[out]wThe items' width.
[out]hThe items' height.

References elm_obj_gengrid_item_size_get().

void elm_gengrid_item_size_set ( Elm_Gengrid *  obj,
Evas_Coord  w,
Evas_Coord  h 
)

Set the size for the items of a given gengrid widget.

A gengrid, after creation, has still no information on the size to give to each of its cells. So, you most probably will end up with squares one finger wide, the default size. Use this function to force a custom size for you items, making them as big as you wish.

See also
elm_gengrid_item_size_get()
Parameters
[in]wThe items' width.
[in]hThe items' height.

References elm_obj_gengrid_item_size_set().

Elm_Object_Item* elm_gengrid_item_sorted_insert ( Elm_Gengrid *  obj,
const Elm_Gengrid_Item_Class itc,
const void *  data,
Eina_Compare_Cb  comp,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item in a gengrid widget using a user-defined sort function.

Returns
A handle to the item added or NULL, on errors.

This inserts an item in the gengrid based on user defined comparison function. The two arguments passed to the function func are gengrid item handles to compare.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_data_get()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]compUser defined comparison function that defines the sort order based on gengrid item and its data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

References elm_obj_gengrid_item_sorted_insert().

void elm_gengrid_item_tooltip_content_cb_set ( Elm_Object_Item it,
Elm_Tooltip_Item_Content_Cb  func,
const void *  data,
Evas_Smart_Cb  del_cb 
)

Set the content to be shown in a given gengrid item's tooltip.

Parameters
itThe gengrid item.
funcThe function returning the tooltip contents.
dataWhat to provide to func as callback data/context.
del_cbCalled when data is not needed anymore, either when another callback replaces func, the tooltip is unset with elm_gengrid_item_tooltip_unset() or the owner item dies. This callback receives as its first parameter the given data, being event_info the item handle.

This call will setup the tooltip's contents to item (analogous to elm_object_tooltip_content_cb_set(), but being item tooltips with higher precedence than object tooltips). It can have only one tooltip at a time, so any previous tooltip content will get removed. func (with data) will be called every time Elementary needs to show the tooltip and it should return a valid Evas object, which will be fully managed by the tooltip system, getting deleted when the tooltip is gone.

In order to set just a text as a tooltip, look at elm_gengrid_item_tooltip_text_set().

References elm_wdg_item_tooltip_content_cb_set().

const char* elm_gengrid_item_tooltip_style_get ( const Elm_Object_Item it)

Get the style set a given gengrid item's tooltip.

Parameters
itgengrid item with tooltip already set on.
Returns
style the theme style in use, which defaults to "default". If the object does not have a tooltip set, then NULL is returned.
See also
elm_gengrid_item_tooltip_style_set() for more details

References elm_wdg_item_tooltip_style_get().

void elm_gengrid_item_tooltip_style_set ( Elm_Object_Item it,
const char *  style 
)

Set a different style for a given gengrid item's tooltip.

Parameters
itgengrid item with tooltip set
stylethe theme style to use on tooltips (e.g. "default", "transparent", etc)

Tooltips can have alternate styles to be displayed on, which are defined by the theme set on Elementary. This function works analogously as elm_object_tooltip_style_set(), but here applied only to gengrid item objects. The default style for tooltips is "default".

Note
before you set a style you should define a tooltip with elm_gengrid_item_tooltip_content_cb_set() or elm_gengrid_item_tooltip_text_set()
See also
elm_gengrid_item_tooltip_style_get()

References elm_wdg_item_tooltip_style_set().

void elm_gengrid_item_tooltip_text_set ( Elm_Object_Item it,
const char *  text 
)

Set the text to be shown in a given gengrid item's tooltips.

Parameters
itThe gengrid item
textThe text to set in the content

This call will setup the text to be used as tooltip to that item (analogous to elm_object_tooltip_text_set(), but being item tooltips with higher precedence than object tooltips). It can have only one tooltip at a time, so any previous tooltip data will get removed.

In order to set a content or something else as a tooltip, look at elm_gengrid_item_tooltip_content_cb_set().

References elm_wdg_item_tooltip_text_set().

void elm_gengrid_item_tooltip_unset ( Elm_Object_Item it)

Unset a tooltip from a given gengrid item.

Parameters
itgengrid item to remove a previously set tooltip from.

This call removes any tooltip set on item. The callback provided as del_cb to elm_gengrid_item_tooltip_content_cb_set() will be called to notify it is not used anymore (and have resources cleaned, if need be).

See also
elm_gengrid_item_tooltip_content_cb_set()

References elm_wdg_item_tooltip_unset().

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.

References elm_obj_gengrid_item_update().

unsigned int elm_gengrid_items_count ( const Elm_Gengrid *  obj)

Return how many items are currently in a list.

Returns
The total number of list items in the list

This behavior is O(1) and includes items which may or may not be realized.

References elm_obj_gengrid_items_count().

Elm_Object_Item* elm_gengrid_last_item_get ( const Elm_Gengrid *  obj)

Get the last item in a given gengrid widget.

Returns
The last item's handle or NULL, if there are no items in obj (and on errors)

This returns the last item in the obj's internal list of items.

See also
elm_gengrid_first_item_get()

References elm_obj_gengrid_last_item_get().

Eina_Bool elm_gengrid_multi_select_get ( const Elm_Gengrid *  obj)

Get whether multi-selection is enabled or disabled for a given gengrid widget.

Returns
EINA_TRUE, if multi-selection is enabled, EINA_FALSE otherwise
See also
elm_gengrid_multi_select_set() for more details

References elm_obj_gengrid_multi_select_get().

Elm_Object_Multi_Select_Mode elm_gengrid_multi_select_mode_get ( const Elm_Gengrid *  obj)

Get the gengrid multi select mode.

Returns
The multi select mode (If getting mode fails, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_set()
Since
1.8

References elm_obj_gengrid_multi_select_mode_get().

void elm_gengrid_multi_select_mode_set ( Elm_Gengrid *  obj,
Elm_Object_Multi_Select_Mode  mode 
)

Set the gengrid multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked.
  • #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_get()
Since
1.8
Parameters
[in]modeThe multi select mode

References elm_obj_gengrid_multi_select_mode_set().

void elm_gengrid_multi_select_set ( Elm_Gengrid *  obj,
Eina_Bool  multi 
)

Enable or disable multi-selection in a given gengrid widget.

Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously. When it is enabled, a sequence of clicks on different items will make them all selected, progressively. A click on an already selected item will unselect it. If interacting via the keyboard, multi-selection is enabled while holding the "Shift" key.

Note
By default, multi-selection is disabled on gengrids
See also
elm_gengrid_multi_select_get()
Parameters
[in]multiEINA_TRUE, to enable multi-selection, EINA_FALSE to disable it.

References elm_obj_gengrid_multi_select_set().

Eina_List* elm_gengrid_realized_items_get ( const Elm_Gengrid *  obj)

Get a list of realized items in gengrid.

Returns
The list of realized items, nor NULL if none are realized.

This returns a list of the realized items in the gengrid. The list contains gengrid item pointers. The list must be freed by the caller when done with eina_list_free(). The item pointers in the list are only valid so long as those items are not deleted or the gengrid is not deleted.

See also
elm_gengrid_realized_items_update()

References elm_obj_gengrid_realized_items_get().

void elm_gengrid_realized_items_update ( Elm_Gengrid *  obj)

Update the contents of all realized items.

This updates all realized items 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.

To update just one item, use elm_gengrid_item_update().

See also
elm_gengrid_realized_items_get()
elm_gengrid_item_update()

References elm_obj_gengrid_realized_items_update().

Eina_Bool elm_gengrid_reorder_mode_get ( const Elm_Gengrid *  obj)

Get whether a given gengrid widget is or not able have items reordered.

Returns
EINA_TRUE, if reordering is on, EINA_FALSE if it's off
See also
elm_gengrid_reorder_mode_set() for more details

References elm_obj_gengrid_reorder_mode_get().

void elm_gengrid_reorder_mode_set ( Elm_Gengrid *  obj,
Eina_Bool  reorder_mode 
)

Set whether a given gengrid widget is or not able have items reordered.

If a gengrid is set to allow reordering, a click held for more than 0.5 over a given item will highlight it specially, signaling the gengrid has entered the reordering state. From that time on, the user will be able to, while still holding the mouse button down, move the item freely in the gengrid's viewport, replacing to said item to the locations it goes to. The replacements will be animated and, whenever the user releases the mouse button, the item being replaced gets a new definitive place in the grid.

See also
elm_gengrid_reorder_mode_get()
Parameters
[in]reorder_modeUse EINA_TRUE to turn reordering on, EINA_FALSE to turn it off

References elm_obj_gengrid_reorder_mode_set().

void elm_gengrid_reorder_mode_start ( Evas_Object *  obj,
Ecore_Pos_Map  tween_mode 
)

Enable the gengrid widget mode reordered with keys.

Parameters
objThe gengrid object
tween_modePosition mappings for animation
See also
_Ecore_Map_Pos
elm_gengrid_reorder_mode_stop()
Since
1.10
void elm_gengrid_reorder_mode_stop ( Evas_Object *  obj)

Stop the gengrid widget mode reorder.

Parameters
objThe gengrid object
See also
elm_gengrid_reorder_mode_start()
Since
1.10
void elm_gengrid_reorder_type_set ( Evas_Object *  obj,
Elm_Gengrid_Reorder_Type  type 
)

Set the reorder type.

Parameters
objThe gengrid object
typeElm_Gengrid_Reorder_Type value
See also
Elm_Gengrid_Reorder_Type
Since
1.11
EINA_DEPRECATED void elm_gengrid_scroller_policy_get ( const Evas_Object *  obj,
Elm_Scroller_Policy *  policy_h,
Elm_Scroller_Policy *  policy_v 
)

Get the scrollbar policy.

Parameters
objThe gengrid object
policy_hPointer to store the horizontal scrollbar policy.
policy_vPointer to store the vertical scrollbar policy.
Deprecated:
Use elm_scroller_policy_get() instead.
See also
elm_scroller_policy_get()
elm_gengrid_scroller_policy_set()

References elm_interface_scrollable_policy_get().

EINA_DEPRECATED void elm_gengrid_scroller_policy_set ( Evas_Object *  obj,
Elm_Scroller_Policy  policy_h,
Elm_Scroller_Policy  policy_v 
)

Set the scrollbar policy.

Parameters
objThe gengrid object
policy_hHorizontal scrollbar policy.
policy_vVertical scrollbar policy.

This sets the scrollbar visibility policy for the given gengrid 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. Default is #ELM_SCROLLER_POLICY_AUTO.

Deprecated:
Use elm_scroller_policy_set() instead.
See also
elm_scroller_policy_set()
elm_gengrid_scroller_policy_get()

References elm_interface_scrollable_policy_set().

Elm_Object_Item* elm_gengrid_search_by_text_item_get ( Elm_Gengrid *  obj,
Elm_Object_Item item_to_search_from,
const char *  part_name,
const char *  pattern,
Elm_Glob_Match_Flags  flags 
)

Get gengrid item by given string.

Returns
Pointer to the gengrid item which matches search_string in case of success, otherwise returns NULL.

It takes pointer to the gengrid item that will be used to start search from it.

This function uses globs (like "*.jpg") for searching and takes search flags as last parameter That is a bitfield with values to be ored together or 0 for no flags.

Since
1.11
Parameters
[in]item_to_search_fromPointer to item to start search from. If NULL search will be started from the first item of the gengrid.
[in]part_nameName of the TEXT part of gengrid item to search string in.
[in]patternThe search pattern.
[in]flagsSearch flags

References elm_obj_gengrid_search_by_text_item_get().

Elm_Object_Select_Mode elm_gengrid_select_mode_get ( const Elm_Gengrid *  obj)

Get the gengrid select mode.

Returns
The select mode (If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX)
See also
elm_gengrid_select_mode_set()

References elm_obj_gengrid_select_mode_get().

void elm_gengrid_select_mode_set ( Elm_Gengrid *  obj,
Elm_Object_Select_Mode  mode 
)

Set the gengrid select mode.

elm_gengrid_select_mode_set() changes item select mode in the gengrid widget.

  • #ELM_OBJECT_SELECT_MODE_DEFAULT : Items 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 items entirely and they will neither appear selected nor call selected callback functions.
See also
elm_gengrid_select_mode_get()
Parameters
[in]modeThe select mode

References elm_obj_gengrid_select_mode_set().

Elm_Object_Item* elm_gengrid_selected_item_get ( const Elm_Gengrid *  obj)

Get the selected item in a given gengrid widget.

Returns
The selected item's handle or NULL, if none is selected at the moment (and on errors)

This returns the selected item in obj. If multi selection is enabled on obj (

See also
elm_gengrid_multi_select_set()), only the first item in the list is selected, which might not be very useful. For that case, see elm_gengrid_selected_items_get().

References elm_obj_gengrid_selected_item_get().

const Eina_List* elm_gengrid_selected_items_get ( const Elm_Gengrid *  obj)

Get a list of selected items in a given gengrid.

Returns
The list of selected items or NULL, if none is selected at the moment (and on errors)

This returns a list of the selected items, in the order that they appear in the grid. This list is only valid as long as no more items are selected or unselected (or unselected implicitly by deletion). The list contains Gengrid item pointers as data, naturally.

See also
elm_gengrid_selected_item_get()

References elm_obj_gengrid_selected_items_get().

Eina_Bool elm_gengrid_wheel_disabled_get ( const Elm_Gengrid *  obj)

Get a value whether mouse wheel is enabled or not.

Returns
EINA_TRUE means gengrid wheel is disabled. EINA_FALSE indicates it is enabled.

Mouse wheel can be used for the user to scroll up and down the gengrid.

See also
elm_gengrid_wheel_disabled_set()

References elm_obj_gengrid_wheel_disabled_get().

void elm_gengrid_wheel_disabled_set ( Elm_Gengrid *  obj,
Eina_Bool  disabled 
)

Enable or disable mouse wheel to be used to scroll the gengrid.

Mouse wheel can be used for the user to scroll up and down the gengrid.

Wheel is enabled by default.

See also
elm_gengrid_wheel_disabled_get()
Parameters
[in]disabledUse EINA_TRUE to disable mouse wheel or EINA_FALSE to enable it.

References elm_obj_gengrid_wheel_disabled_set().

EOAPI void elm_obj_gengrid_align_get ( double *  align_x,
double *  align_y 
)

Get the items grid's alignment values within a given gengrid widget.

Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
[out]align_xAlignment in the horizontal axis (0 <= align_x <= 1).
[out]align_yAlignment in the vertical axis (0 <= align_y <= 1).

Referenced by elm_gengrid::align_get(), and elm_gengrid_align_get().

EOAPI void elm_obj_gengrid_align_set ( double  align_x,
double  align_y 
)

Set the items grid's alignment within a given gengrid widget.

This sets the alignment of the whole grid of items of a gengrid within its given viewport. By default, those values are both 0.5, meaning that the gengrid will have its items grid placed exactly in the middle of its viewport.

Note
If given alignment values are out of the cited ranges, they'll be changed to the nearest boundary values on the valid ranges.
See also
elm_gengrid_align_get()
Parameters
[in]align_xAlignment in the horizontal axis (0 <= align_x <= 1).
[in]align_yAlignment in the vertical axis (0 <= align_y <= 1).

Referenced by elm_gengrid::align_set(), and elm_gengrid_align_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_at_xy_item_get ( Evas_Coord  x,
Evas_Coord  y,
int *  xposret,
int *  yposret 
)

Get the item that is at the x, y canvas coords.

Returns
The item at the coordinates or NULL if none

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 xposret is not NULL, the integer pointed to is set to a value of -1, 0 or 1, depending if the coordinate is on the left portion of that item (-1), on the middle section (0) or on the right part (1). if yposret 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 gengrid.

Parameters
[in]xThe input x coordinate
[in]yThe input y coordinate
[out]xposretThe position relative to the item returned here
[out]yposretThe position relative to the item returned here

Referenced by elm_gengrid::at_xy_item_get(), and elm_gengrid_at_xy_item_get().

EOAPI void elm_obj_gengrid_clear ( void  )

Remove all items from a given gengrid widget.

This removes (and deletes) all items in obj, leaving it empty.

See also
elm_object_item_del(), to remove just one item.

Referenced by elm_gengrid::clear(), and elm_gengrid_clear().

EOAPI Eina_Bool elm_obj_gengrid_filled_get ( void  )

Get how the items grid's filled within a given gengrid widget.

Returns
EINA_TRUE, if filled is on, EINA_FALSE if it's off
Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details

Referenced by elm_gengrid_filled_get(), and elm_gengrid::filled_get().

EOAPI void elm_obj_gengrid_filled_set ( Eina_Bool  fill)

Set how the items grid's filled within a given gengrid widget.

This sets the fill state of the whole grid of items of a gengrid within its given viewport. By default, this value is false, meaning that if the first line of items grid's isn't filled, the items are centered with the alignment

See also
elm_gengrid_filled_get()
Parameters
[in]fillFilled if True

Referenced by elm_gengrid_filled_set(), and elm_gengrid::filled_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_first_item_get ( void  )

Get the first item in a given gengrid widget.

Returns
The first item's handle or NULL, if there are no items in obj (and on errors)

This returns the first item in the obj's internal list of items.

See also
elm_gengrid_last_item_get()

Referenced by elm_gengrid_first_item_get(), and elm_gengrid::first_item_get().

EOAPI void elm_obj_gengrid_group_item_size_get ( Evas_Coord *  w,
Evas_Coord *  h 
)

Get the size set for the group items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_group_item_size_get() for more details
Parameters
[out]wThe group items' width.
[out]hThe group items' height.

Referenced by elm_gengrid_group_item_size_get(), and elm_gengrid::group_item_size_get().

EOAPI void elm_obj_gengrid_group_item_size_set ( Evas_Coord  w,
Evas_Coord  h 
)

Set the size for the group items of a given gengrid widget.

A gengrid, after creation, has still no information on the size to give to each of its cells. So, you most probably will end up with squares one finger wide, the default size. Use this function to force a custom size for you group items, making them as big as you wish.

See also
elm_gengrid_group_item_size_get()
Parameters
[in]wThe group items' width.
[in]hThe group items' height.

Referenced by elm_gengrid_group_item_size_set(), and elm_gengrid::group_item_size_set().

EOAPI Eina_Bool elm_obj_gengrid_horizontal_get ( void  )

Get for what direction a given gengrid widget will expand while placing its items.

Returns
EINA_TRUE, if obj is set to expand horizontally, EINA_FALSE if it's set to expand vertically.
See also
elm_gengrid_horizontal_set() for more details

Referenced by elm_gengrid_horizontal_get(), and elm_gengrid::horizontal_get().

EOAPI void elm_obj_gengrid_horizontal_set ( Eina_Bool  horizontal)

Set the direction in which a given gengrid widget will expand while placing its items.

When in "horizontal mode" (EINA_TRUE), items will be placed in columns, from top to bottom and, when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. When in "vertical mode" (EINA_FALSE), though, items will be placed in rows, from left to right and, when the space for a row is filled, another one is started below, thus expanding the grid vertically.

Note
By default, gengrid is in vertical mode, EINA_FALSE.
See also
elm_gengrid_horizontal_get()
Parameters
[in]horizontalEINA_TRUE to make the gengrid expand horizontally, EINA_FALSE to expand vertically.

Referenced by elm_gengrid_horizontal_set(), and elm_gengrid::horizontal_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_append ( const Elm_Gengrid_Item_Class itc,
const void *  data,
Evas_Smart_Cb  func,
const void *  func_data 
)

Append a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the beginning of the gengrid.

See also
elm_gengrid_item_prepend()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

Referenced by elm_gengrid_item_append(), and elm_gengrid::item_append().

EOAPI void elm_obj_gengrid_item_bring_in ( 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.

See also
elm_gengrid_item_show()
Parameters
[in]typeWhere to position the item in the viewport.

Referenced by elm_gengrid_item_bring_in().

EOAPI const Elm_Gengrid_Item_Class* elm_obj_gengrid_item_class_get ( void  )

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.

Referenced by elm_gengrid_item_item_class_get().

EOAPI void elm_obj_gengrid_item_class_update ( 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]itcThe gengrid item class describing the function pointers and the item style.

Referenced by elm_gengrid_item_item_class_update().

EOAPI void elm_obj_gengrid_item_fields_update ( 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.

See also
elm_gengrid_iitem_update()
Since
1.15
Parameters
[in]partsThe name of item's part
[in]itfThe type of item's part type

Referenced by elm_gengrid_item_fields_update().

EOAPI int elm_obj_gengrid_item_index_get ( void  )

Get the index of the item.

It is only valid once displayed.

Referenced by elm_gengrid_item_index_get().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_insert_after ( const Elm_Gengrid_Item_Class itc,
const void *  data,
Elm_Object_Item relative,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item after another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item after another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]relativeThe item to place this new one after.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

Referenced by elm_gengrid_item_insert_after(), and elm_gengrid::item_insert_after().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_insert_before ( const Elm_Gengrid_Item_Class itc,
const void *  data,
Elm_Object_Item relative,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item before another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item before another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]relativeThe item to place this new one before.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

Referenced by elm_gengrid_item_insert_before(), and elm_gengrid::item_insert_before().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_next_get ( void  )

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.

See also
elm_gengrid_item_prev_get()

Referenced by elm_gengrid_item_next_get().

EOAPI void elm_obj_gengrid_item_pos_get ( 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
[out]xPointer to variable to store the item's row number.
[out]yPointer to variable to store the item's column number.

Referenced by elm_gengrid_item_pos_get().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_prepend ( const Elm_Gengrid_Item_Class itc,
const void *  data,
Evas_Smart_Cb  func,
const void *  func_data 
)

Prepend a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the end of the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

Referenced by elm_gengrid_item_prepend(), and elm_gengrid::item_prepend().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_prev_get ( void  )

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.

See also
elm_gengrid_item_next_get()

Referenced by elm_gengrid_item_prev_get().

EOAPI Elm_Object_Select_Mode elm_obj_gengrid_item_select_mode_get ( void  )

Get the gengrid item's select mode.

(If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)

See also
elm_gengrid_item_select_mode_set()

Referenced by elm_gengrid_item_select_mode_get().

EOAPI void elm_obj_gengrid_item_select_mode_set ( Elm_Object_Select_Mode  mode)

Set the gengrid item's select mode.

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.
See also
elm_gengrid_item_select_mode_get()
Parameters
[in]modeThe selected mode

Referenced by elm_gengrid_item_select_mode_set().

EOAPI Eina_Bool elm_obj_gengrid_item_selected_get ( void  )

Get whether a given gengrid item is selected or not.

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

See also
elm_gengrid_item_selected_set() for more details

Referenced by elm_gengrid_item_selected_get().

EOAPI void elm_obj_gengrid_item_selected_set ( Eina_Bool  selected)

Set whether a given gengrid item is selected or not.

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

See also
elm_gengrid_item_selected_get()
Parameters
[in]selectedthe selected state (EINA_TRUE selected, EINA_FALSE not selected)

Referenced by elm_gengrid_item_selected_set().

EOAPI void elm_obj_gengrid_item_show ( Elm_Gengrid_Item_Scrollto_Type  type)

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.

See also
elm_gengrid_item_bring_in()
Parameters
[in]typeWhere to position the item in the viewport.

Referenced by elm_gengrid_item_show().

EOAPI void elm_obj_gengrid_item_size_get ( Evas_Coord *  w,
Evas_Coord *  h 
)

Get the size set for the items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_item_size_get() for more details
Parameters
[out]wThe items' width.
[out]hThe items' height.

Referenced by elm_gengrid_item_size_get(), and elm_gengrid::item_size_get().

EOAPI void elm_obj_gengrid_item_size_set ( Evas_Coord  w,
Evas_Coord  h 
)

Set the size for the items of a given gengrid widget.

A gengrid, after creation, has still no information on the size to give to each of its cells. So, you most probably will end up with squares one finger wide, the default size. Use this function to force a custom size for you items, making them as big as you wish.

See also
elm_gengrid_item_size_get()
Parameters
[in]wThe items' width.
[in]hThe items' height.

Referenced by elm_gengrid_item_size_set(), and elm_gengrid::item_size_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_item_sorted_insert ( const Elm_Gengrid_Item_Class itc,
const void *  data,
Eina_Compare_Cb  comp,
Evas_Smart_Cb  func,
const void *  func_data 
)

Insert an item in a gengrid widget using a user-defined sort function.

Returns
A handle to the item added or NULL, on errors.

This inserts an item in the gengrid based on user defined comparison function. The two arguments passed to the function func are gengrid item handles to compare.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_data_get()
elm_object_item_del()
Parameters
[in]itcThe item class for the item.
[in]dataThe item data.
[in]compUser defined comparison function that defines the sort order based on gengrid item and its data.
[in]funcConvenience function called when the item is selected.
[in]func_dataData to be passed to func.

Referenced by elm_gengrid_item_sorted_insert(), and elm_gengrid::item_sorted_insert().

EOAPI void elm_obj_gengrid_item_update ( void  )

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.

Referenced by elm_gengrid_item_update().

EOAPI unsigned int elm_obj_gengrid_items_count ( void  )

Return how many items are currently in a list.

Returns
The total number of list items in the list

This behavior is O(1) and includes items which may or may not be realized.

Referenced by elm_gengrid_items_count(), and elm_gengrid::items_count().

EOAPI Elm_Object_Item* elm_obj_gengrid_last_item_get ( void  )

Get the last item in a given gengrid widget.

Returns
The last item's handle or NULL, if there are no items in obj (and on errors)

This returns the last item in the obj's internal list of items.

See also
elm_gengrid_first_item_get()

Referenced by elm_gengrid_last_item_get(), and elm_gengrid::last_item_get().

EOAPI Eina_Bool elm_obj_gengrid_multi_select_get ( void  )

Get whether multi-selection is enabled or disabled for a given gengrid widget.

Returns
EINA_TRUE, if multi-selection is enabled, EINA_FALSE otherwise
See also
elm_gengrid_multi_select_set() for more details

Referenced by elm_gengrid_multi_select_get(), and elm_gengrid::multi_select_get().

EOAPI Elm_Object_Multi_Select_Mode elm_obj_gengrid_multi_select_mode_get ( void  )

Get the gengrid multi select mode.

Returns
The multi select mode (If getting mode fails, it returns #ELM_OBJECT_MULTI_SELECT_MODE_MAX)
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_set()
Since
1.8

Referenced by elm_gengrid_multi_select_mode_get(), and elm_gengrid::multi_select_mode_get().

EOAPI void elm_obj_gengrid_multi_select_mode_set ( Elm_Object_Multi_Select_Mode  mode)

Set the gengrid multi select mode.

  • #ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT : select/unselect items whenever each item is clicked.
  • #ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL : Only one item will be selected although multi-selection is enabled, if clicked without pressing control key. This mode is only available with multi-selection.
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_get()
Since
1.8
Parameters
[in]modeThe multi select mode

Referenced by elm_gengrid_multi_select_mode_set(), and elm_gengrid::multi_select_mode_set().

EOAPI void elm_obj_gengrid_multi_select_set ( Eina_Bool  multi)

Enable or disable multi-selection in a given gengrid widget.

Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously. When it is enabled, a sequence of clicks on different items will make them all selected, progressively. A click on an already selected item will unselect it. If interacting via the keyboard, multi-selection is enabled while holding the "Shift" key.

Note
By default, multi-selection is disabled on gengrids
See also
elm_gengrid_multi_select_get()
Parameters
[in]multiEINA_TRUE, to enable multi-selection, EINA_FALSE to disable it.

Referenced by elm_gengrid_multi_select_set(), and elm_gengrid::multi_select_set().

EOAPI Eina_List* elm_obj_gengrid_realized_items_get ( void  )

Get a list of realized items in gengrid.

Returns
The list of realized items, nor NULL if none are realized.

This returns a list of the realized items in the gengrid. The list contains gengrid item pointers. The list must be freed by the caller when done with eina_list_free(). The item pointers in the list are only valid so long as those items are not deleted or the gengrid is not deleted.

See also
elm_gengrid_realized_items_update()

Referenced by elm_gengrid_realized_items_get(), and elm_gengrid::realized_items_get().

EOAPI void elm_obj_gengrid_realized_items_update ( void  )

Update the contents of all realized items.

This updates all realized items 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.

To update just one item, use elm_gengrid_item_update().

See also
elm_gengrid_realized_items_get()
elm_gengrid_item_update()

Referenced by elm_gengrid_realized_items_update(), and elm_gengrid::realized_items_update().

EOAPI Eina_Bool elm_obj_gengrid_reorder_mode_get ( void  )

Get whether a given gengrid widget is or not able have items reordered.

Returns
EINA_TRUE, if reordering is on, EINA_FALSE if it's off
See also
elm_gengrid_reorder_mode_set() for more details

Referenced by elm_gengrid_reorder_mode_get(), and elm_gengrid::reorder_mode_get().

EOAPI void elm_obj_gengrid_reorder_mode_set ( Eina_Bool  reorder_mode)

Set whether a given gengrid widget is or not able have items reordered.

If a gengrid is set to allow reordering, a click held for more than 0.5 over a given item will highlight it specially, signaling the gengrid has entered the reordering state. From that time on, the user will be able to, while still holding the mouse button down, move the item freely in the gengrid's viewport, replacing to said item to the locations it goes to. The replacements will be animated and, whenever the user releases the mouse button, the item being replaced gets a new definitive place in the grid.

See also
elm_gengrid_reorder_mode_get()
Parameters
[in]reorder_modeUse EINA_TRUE to turn reordering on, EINA_FALSE to turn it off

Referenced by elm_gengrid_reorder_mode_set(), and elm_gengrid::reorder_mode_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_search_by_text_item_get ( Elm_Object_Item item_to_search_from,
const char *  part_name,
const char *  pattern,
Elm_Glob_Match_Flags  flags 
)

Get gengrid item by given string.

Returns
Pointer to the gengrid item which matches search_string in case of success, otherwise returns NULL.

It takes pointer to the gengrid item that will be used to start search from it.

This function uses globs (like "*.jpg") for searching and takes search flags as last parameter That is a bitfield with values to be ored together or 0 for no flags.

Since
1.11
Parameters
[in]item_to_search_fromPointer to item to start search from. If NULL search will be started from the first item of the gengrid.
[in]part_nameName of the TEXT part of gengrid item to search string in.
[in]patternThe search pattern.
[in]flagsSearch flags

Referenced by elm_gengrid_search_by_text_item_get(), and elm_gengrid::search_by_text_item_get().

EOAPI Elm_Object_Select_Mode elm_obj_gengrid_select_mode_get ( void  )

Get the gengrid select mode.

Returns
The select mode (If getting mode fails, it returns #ELM_OBJECT_SELECT_MODE_MAX)
See also
elm_gengrid_select_mode_set()

Referenced by elm_gengrid_select_mode_get(), and elm_gengrid::select_mode_get().

EOAPI void elm_obj_gengrid_select_mode_set ( Elm_Object_Select_Mode  mode)

Set the gengrid select mode.

elm_gengrid_select_mode_set() changes item select mode in the gengrid widget.

  • #ELM_OBJECT_SELECT_MODE_DEFAULT : Items 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 items entirely and they will neither appear selected nor call selected callback functions.
See also
elm_gengrid_select_mode_get()
Parameters
[in]modeThe select mode

Referenced by elm_gengrid_select_mode_set(), and elm_gengrid::select_mode_set().

EOAPI Elm_Object_Item* elm_obj_gengrid_selected_item_get ( void  )

Get the selected item in a given gengrid widget.

Returns
The selected item's handle or NULL, if none is selected at the moment (and on errors)

This returns the selected item in obj. If multi selection is enabled on obj (

See also
elm_gengrid_multi_select_set()), only the first item in the list is selected, which might not be very useful. For that case, see elm_gengrid_selected_items_get().

Referenced by elm_gengrid_selected_item_get(), and elm_gengrid::selected_item_get().

EOAPI const Eina_List* elm_obj_gengrid_selected_items_get ( void  )

Get a list of selected items in a given gengrid.

Returns
The list of selected items or NULL, if none is selected at the moment (and on errors)

This returns a list of the selected items, in the order that they appear in the grid. This list is only valid as long as no more items are selected or unselected (or unselected implicitly by deletion). The list contains Gengrid item pointers as data, naturally.

See also
elm_gengrid_selected_item_get()

Referenced by elm_gengrid_selected_items_get(), and elm_gengrid::selected_items_get().

EOAPI Eina_Bool elm_obj_gengrid_wheel_disabled_get ( void  )

Get a value whether mouse wheel is enabled or not.

Returns
EINA_TRUE means gengrid wheel is disabled. EINA_FALSE indicates it is enabled.

Mouse wheel can be used for the user to scroll up and down the gengrid.

See also
elm_gengrid_wheel_disabled_set()

Referenced by elm_gengrid_wheel_disabled_get(), and elm_gengrid::wheel_disabled_get().

EOAPI void elm_obj_gengrid_wheel_disabled_set ( Eina_Bool  disabled)

Enable or disable mouse wheel to be used to scroll the gengrid.

Mouse wheel can be used for the user to scroll up and down the gengrid.

Wheel is enabled by default.

See also
elm_gengrid_wheel_disabled_get()
Parameters
[in]disabledUse EINA_TRUE to disable mouse wheel or EINA_FALSE to enable it.

Referenced by elm_gengrid_wheel_disabled_set(), and elm_gengrid::wheel_disabled_set().

bool elm_gengrid::filled_get ( ) const
inline

Get how the items grid's filled within a given gengrid widget.

Returns
EINA_TRUE, if filled is on, EINA_FALSE if it's off
Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
fillFilled if True

References elm_obj_gengrid_filled_get().

void elm_gengrid::filled_set ( bool  fill_) const
inline

Get how the items grid's filled within a given gengrid widget.

Returns
EINA_TRUE, if filled is on, EINA_FALSE if it's off
Note
Use NULL pointers on the alignment values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_align_set() for more details
Parameters
fillFilled if True

References elm_obj_gengrid_filled_set().

Elm_Object_Item* elm_gengrid::first_item_get ( ) const
inline

Get the first item in a given gengrid widget.

Returns
The first item's handle or NULL, if there are no items in obj (and on errors)

This returns the first item in the obj's internal list of items.

See also
elm_gengrid_last_item_get()

References elm_obj_gengrid_first_item_get().

void elm_gengrid::group_item_size_get ( Evas_Coord *  w_,
Evas_Coord *  h_ 
) const
inline

Get the size set for the group items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_group_item_size_get() for more details
Parameters
wThe group items' width.
hThe group items' height.

References elm_obj_gengrid_group_item_size_get().

void elm_gengrid::group_item_size_set ( Evas_Coord  w_,
Evas_Coord  h_ 
) const
inline

Get the size set for the group items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_group_item_size_get() for more details
Parameters
wThe group items' width.
hThe group items' height.

References elm_obj_gengrid_group_item_size_set().

bool elm_gengrid::horizontal_get ( ) const
inline

Get for what direction a given gengrid widget will expand while placing its items.

Returns
EINA_TRUE, if obj is set to expand horizontally, EINA_FALSE if it's set to expand vertically.
See also
elm_gengrid_horizontal_set() for more details
Parameters
horizontalEINA_TRUE to make the gengrid expand horizontally, EINA_FALSE to expand vertically.

References elm_obj_gengrid_horizontal_get().

void elm_gengrid::horizontal_set ( bool  horizontal_) const
inline

Get for what direction a given gengrid widget will expand while placing its items.

Returns
EINA_TRUE, if obj is set to expand horizontally, EINA_FALSE if it's set to expand vertically.
See also
elm_gengrid_horizontal_set() for more details
Parameters
horizontalEINA_TRUE to make the gengrid expand horizontally, EINA_FALSE to expand vertically.

References elm_obj_gengrid_horizontal_set().

Elm_Object_Item* elm_gengrid::item_append ( const Elm_Gengrid_Item_Class itc_,
const void *  data_,
Evas_Smart_Cb  func_,
const void *  func_data_ 
) const
inline

Append a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the beginning of the gengrid.

See also
elm_gengrid_item_prepend()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
itcThe item class for the item.
dataThe item data.
funcConvenience function called when the item is selected.
func_dataData to be passed to func.

References elm_obj_gengrid_item_append().

Elm_Object_Item* elm_gengrid::item_insert_after ( const Elm_Gengrid_Item_Class itc_,
const void *  data_,
Elm_Object_Item relative_,
Evas_Smart_Cb  func_,
const void *  func_data_ 
) const
inline

Insert an item after another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item after another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
itcThe item class for the item.
dataThe item data.
relativeThe item to place this new one after.
funcConvenience function called when the item is selected.
func_dataData to be passed to func.

References elm_obj_gengrid_item_insert_after().

Elm_Object_Item* elm_gengrid::item_insert_before ( const Elm_Gengrid_Item_Class itc_,
const void *  data_,
Elm_Object_Item relative_,
Evas_Smart_Cb  func_,
const void *  func_data_ 
) const
inline

Insert an item before another in a gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This inserts an item before another in the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
itcThe item class for the item.
dataThe item data.
relativeThe item to place this new one before.
funcConvenience function called when the item is selected.
func_dataData to be passed to func.

References elm_obj_gengrid_item_insert_before().

Elm_Object_Item* elm_gengrid::item_prepend ( const Elm_Gengrid_Item_Class itc_,
const void *  data_,
Evas_Smart_Cb  func_,
const void *  func_data_ 
) const
inline

Prepend a new item in a given gengrid widget.

Returns
A handle to the item added or NULL, on errors.

This adds an item to the end of the gengrid.

See also
elm_gengrid_item_append()
elm_gengrid_item_insert_before()
elm_gengrid_item_insert_after()
elm_object_item_del()
Parameters
itcThe item class for the item.
dataThe item data.
funcConvenience function called when the item is selected.
func_dataData to be passed to func.

References elm_obj_gengrid_item_prepend().

void elm_gengrid::item_size_get ( Evas_Coord *  w_,
Evas_Coord *  h_ 
) const
inline

Get the size set for the items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_item_size_get() for more details
Parameters
wThe items' width.
hThe items' height.

References elm_obj_gengrid_item_size_get().

void elm_gengrid::item_size_set ( Evas_Coord  w_,
Evas_Coord  h_ 
) const
inline

Get the size set for the items of a given gengrid widget.

Note
Use NULL pointers on the size values you're not interested in: they'll be ignored by the function.
See also
elm_gengrid_item_size_get() for more details
Parameters
wThe items' width.
hThe items' height.

References elm_obj_gengrid_item_size_set().

Elm_Object_Item* elm_gengrid::item_sorted_insert ( const Elm_Gengrid_Item_Class itc_,
const void *  data_,
Eina_Compare_Cb  comp_,
Evas_Smart_Cb  func_,
const void *  func_data_ 
) const
inline

Insert an item in a gengrid widget using a user-defined sort function.

Returns
A handle to the item added or NULL, on errors.

This inserts an item in the gengrid based on user defined comparison function. The two arguments passed to the function func are gengrid item handles to compare.

See also
elm_gengrid_item_append()
elm_gengrid_item_prepend()
elm_gengrid_item_insert_after()
elm_object_item_data_get()
elm_object_item_del()
Parameters
itcThe item class for the item.
dataThe item data.
compUser defined comparison function that defines the sort order based on gengrid item and its data.
funcConvenience function called when the item is selected.
func_dataData to be passed to func.

References elm_obj_gengrid_item_sorted_insert().

unsigned int elm_gengrid::items_count ( ) const
inline

Return how many items are currently in a list.

Returns
The total number of list items in the list

This behavior is O(1) and includes items which may or may not be realized.

References elm_obj_gengrid_items_count().

Elm_Object_Item* elm_gengrid::last_item_get ( ) const
inline

Get the last item in a given gengrid widget.

Returns
The last item's handle or NULL, if there are no items in obj (and on errors)

This returns the last item in the obj's internal list of items.

See also
elm_gengrid_first_item_get()

References elm_obj_gengrid_last_item_get().

bool elm_gengrid::multi_select_get ( ) const
inline

Get whether multi-selection is enabled or disabled for a given gengrid widget.

Returns
EINA_TRUE, if multi-selection is enabled, EINA_FALSE otherwise
See also
elm_gengrid_multi_select_set() for more details
Parameters
multiEINA_TRUE, to enable multi-selection, EINA_FALSE to disable it.

References elm_obj_gengrid_multi_select_get().

Elm_Object_Multi_Select_Mode elm_gengrid::multi_select_mode_get ( ) const
inline

Get the gengrid multi select mode.

Returns
The multi select mode (If getting mode is failed, it returns ELM_OBJECT_MULTI_SELECT_MODE_MAX)
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_set()
Since
1.8
Parameters
modeThe multi select mode

References elm_obj_gengrid_multi_select_mode_get().

void elm_gengrid::multi_select_mode_set ( Elm_Object_Multi_Select_Mode  mode_) const
inline

Get the gengrid multi select mode.

Returns
The multi select mode (If getting mode is failed, it returns ELM_OBJECT_MULTI_SELECT_MODE_MAX)
See also
elm_gengrid_multi_select_set()
elm_gengrid_multi_select_mode_set()
Since
1.8
Parameters
modeThe multi select mode

References elm_obj_gengrid_multi_select_mode_set().

void elm_gengrid::multi_select_set ( bool  multi_) const
inline

Get whether multi-selection is enabled or disabled for a given gengrid widget.

Returns
EINA_TRUE, if multi-selection is enabled, EINA_FALSE otherwise
See also
elm_gengrid_multi_select_set() for more details
Parameters
multiEINA_TRUE, to enable multi-selection, EINA_FALSE to disable it.

References elm_obj_gengrid_multi_select_set().

Eina_List* elm_gengrid::realized_items_get ( ) const
inline

Get a list of realized items in gengrid.

Returns
The list of realized items, nor NULL if none are realized.

This returns a list of the realized items in the gengrid. The list contains gengrid item pointers. The list must be freed by the caller when done with eina_list_free(). The item pointers in the list are only valid so long as those items are not deleted or the gengrid is not deleted.

See also
elm_gengrid_realized_items_update()

References elm_obj_gengrid_realized_items_get().

void elm_gengrid::realized_items_update ( ) const
inline

Update the contents of all realized items.

This updates all realized items 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.

To update just one item, use elm_gengrid_item_update().

See also
elm_gengrid_realized_items_get()
elm_gengrid_item_update()

References elm_obj_gengrid_realized_items_update().

bool elm_gengrid::reorder_mode_get ( ) const
inline

Get whether a given gengrid widget is or not able have items reordered.

Returns
EINA_TRUE, if reordering is on, EINA_FALSE if it's off
See also
elm_gengrid_reorder_mode_set() for more details
Parameters
reorder_modeUse EINA_TRUE to turn reordering on, EINA_FALSE to turn it off

References elm_obj_gengrid_reorder_mode_get().

void elm_gengrid::reorder_mode_set ( bool  reorder_mode_) const
inline

Get whether a given gengrid widget is or not able have items reordered.

Returns
EINA_TRUE, if reordering is on, EINA_FALSE if it's off
See also
elm_gengrid_reorder_mode_set() for more details
Parameters
reorder_modeUse EINA_TRUE to turn reordering on, EINA_FALSE to turn it off

References elm_obj_gengrid_reorder_mode_set().

Elm_Object_Item* elm_gengrid::search_by_text_item_get ( Elm_Object_Item item_to_search_from_,
std::string  part_name_,
std::string  pattern_,
Elm_Glob_Match_Flags  flags_ 
) const
inline

Get gengrid item by given string.

Returns
Pointer to the gengrid item which matches search_string in case of success, otherwise returns NULL.

It takes pointer to the gengrid item that will be used to start search from it.

This function uses globs (like "*.jpg") for searching and takes search flags as last parameter That is a bitfield with values to be ored together or 0 for no flags.

Since
1.11
Parameters
item_to_search_fromPointer to item to start search from. If NULL search will be started from the first item of the gengrid.
part_nameName of the TEXT part of gengrid item to search string in.
patternThe search pattern.
flagsSearch flags

References elm_obj_gengrid_search_by_text_item_get().

Elm_Object_Select_Mode elm_gengrid::select_mode_get ( ) const
inline

Get the gengrid select mode.

Returns
The select mode (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
See also
elm_gengrid_select_mode_set()
Parameters
modeThe select mode

References elm_obj_gengrid_select_mode_get().

void elm_gengrid::select_mode_set ( Elm_Object_Select_Mode  mode_) const
inline

Get the gengrid select mode.

Returns
The select mode (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
See also
elm_gengrid_select_mode_set()
Parameters
modeThe select mode

References elm_obj_gengrid_select_mode_set().

Elm_Object_Item* elm_gengrid::selected_item_get ( ) const
inline

Get the selected item in a given gengrid widget.

Returns
The selected item's handle or NULL, if none is selected at the moment (and on errors)

This returns the selected item in obj. If multi selection is enabled on obj (

See also
elm_gengrid_multi_select_set()), only the first item in the list is selected, which might not be very useful. For that case, see elm_gengrid_selected_items_get().

References elm_obj_gengrid_selected_item_get().

const Eina_List* elm_gengrid::selected_items_get ( ) const
inline

Get a list of selected items in a given gengrid.

Returns
The list of selected items or NULL, if none is selected at the moment (and on errors)

This returns a list of the selected items, in the order that they appear in the grid. This list is only valid as long as no more items are selected or unselected (or unselected implicitly by deletion). The list contains Gengrid item pointers as data, naturally.

See also
elm_gengrid_selected_item_get()

References elm_obj_gengrid_selected_items_get().

bool elm_gengrid::wheel_disabled_get ( ) const
inline

Get a value whether mouse wheel is enabled or not.

Returns
EINA_TRUE means gengrid wheel is disabled. EINA_FALSE indicates it is enabled.

Mouse wheel can be used for the user to scroll up and down the gengrid.

See also
elm_gengrid_wheel_disabled_set()
Parameters
disabledUse EINA_TRUE to disable mouse wheel or EINA_FALSE to enable it.

References elm_obj_gengrid_wheel_disabled_get().

void elm_gengrid::wheel_disabled_set ( bool  disabled_) const
inline

Get a value whether mouse wheel is enabled or not.

Returns
EINA_TRUE means gengrid wheel is disabled. EINA_FALSE indicates it is enabled.

Mouse wheel can be used for the user to scroll up and down the gengrid.

See also
elm_gengrid_wheel_disabled_set()
Parameters
disabledUse EINA_TRUE to disable mouse wheel or EINA_FALSE to enable it.

References elm_obj_gengrid_wheel_disabled_set().