2 * @defgroup Genlist Genlist
4 * @image html img/widget/genlist/preview-00.png
5 * @image latex img/widget/genlist/preview-00.eps
6 * @image html img/genlist.png
7 * @image latex img/genlist.eps
9 * This widget aims to have more expansive list than the simple list in
10 * Elementary that could have more flexible items and allow many more entries
11 * while still being fast and low on memory usage. At the same time it was
12 * also made to be able to do tree structures. But the price to pay is more
13 * complexity when it comes to usage. If all you want is a simple list with
14 * icons and a single text, use the normal @ref List object.
16 * Genlist has a fairly large API, mostly because it's relatively complex,
17 * trying to be both expansive, powerful and efficient. First we will begin
18 * an overview on the theory behind genlist.
20 * @section Genlist_Item_Class Genlist item classes - creating items
22 * In order to have the ability to add and delete items on the fly, genlist
23 * implements a class (callback) system where the application provides a
24 * structure with information about that type of item (genlist may contain
25 * multiple different items with different classes, states and styles).
26 * Genlist will call the functions in this struct (methods) when an item is
27 * "realized" (i.e., created dynamically, while the user is scrolling the
28 * grid). All objects will simply be deleted when no longer needed with
29 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
31 * - @c item_style - This is a constant string and simply defines the name
32 * of the item style. It @b must be specified and the default should be @c
35 * - @c func - A struct with pointers to functions that will be called when
36 * an item is going to be actually created. All of them receive a @c data
37 * parameter that will point to the same data passed to
38 * elm_genlist_item_append() and related item creation functions, and a @c
39 * obj parameter that points to the genlist object itself.
41 * The function pointers inside @c func are @c text_get, @c content_get, @c
42 * state_get and @c del. The 3 first functions also receive a @c part
43 * parameter described below. A brief description of these functions follows:
45 * - @c text_get - The @c part parameter is the name string of one of the
46 * existing text parts in the Edje group implementing the item's theme.
47 * This function @b must return a strdup'()ed string, as the caller will
48 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
49 * - @c content_get - The @c part parameter is the name string of one of the
50 * existing (content) swallow parts in the Edje group implementing the item's
51 * theme. It must return @c NULL, when no content is desired, or a valid
52 * object handle, otherwise. The object will be deleted by the genlist on
53 * its deletion or when the item is "unrealized". See
54 * #Elm_Genlist_Item_Content_Get_Cb.
55 * - @c func.state_get - The @c part parameter is the name string of one of
56 * the state parts in the Edje group implementing the item's theme. Return
57 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
58 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
59 * and @c "elm" as "emission" and "source" arguments, respectively, when
60 * the state is true (the default is false), where @c XXX is the name of
61 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
62 * - @c func.del - This is intended for use when genlist items are deleted,
63 * so any data attached to the item (e.g. its data parameter on creation)
64 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
66 * available item styles:
68 * - default_style - The text part is a textblock
70 * @image html img/widget/genlist/preview-04.png
71 * @image latex img/widget/genlist/preview-04.eps
75 * @image html img/widget/genlist/preview-01.png
76 * @image latex img/widget/genlist/preview-01.eps
78 * - icon_top_text_bottom
80 * @image html img/widget/genlist/preview-02.png
81 * @image latex img/widget/genlist/preview-02.eps
85 * @image html img/widget/genlist/preview-03.png
86 * @image latex img/widget/genlist/preview-03.eps
88 * @section Genlist_Items Structure of items
90 * An item in a genlist can have 0 or more texts (they can be regular
91 * text or textblock Evas objects - that's up to the style to determine), 0
92 * or more contents (which are simply objects swallowed into the genlist item's
93 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
94 * behavior left to the user to define. The Edje part names for each of
95 * these properties will be looked up, in the theme file for the genlist,
96 * under the Edje (string) data items named @c "labels", @c "contents" and @c
97 * "states", respectively. For each of those properties, if more than one
98 * part is provided, they must have names listed separated by spaces in the
99 * data fields. For the default genlist item theme, we have @b one text
100 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
101 * "elm.swallow.end") and @b no state parts.
103 * A genlist item may be at one of several styles. Elementary provides one
104 * by default - "default", but this can be extended by system or application
105 * custom themes/overlays/extensions (see @ref Theme "themes" for more
108 * @section Genlist_Manipulation Editing and Navigating
110 * Items can be added by several calls. All of them return a @ref
111 * Elm_Genlist_Item handle that is an internal member inside the genlist.
112 * They all take a data parameter that is meant to be used for a handle to
113 * the applications internal data (eg the struct with the original item
114 * data). The parent parameter is the parent genlist item this belongs to if
115 * it is a tree or an indexed group, and NULL if there is no parent. The
116 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
117 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
118 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
119 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
120 * is set then this item is group index item that is displayed at the top
121 * until the next group comes. The func parameter is a convenience callback
122 * that is called when the item is selected and the data parameter will be
123 * the func_data parameter, obj be the genlist object and event_info will be
126 * elm_genlist_item_append() adds an item to the end of the list, or if
127 * there is a parent, to the end of all the child items of the parent.
128 * elm_genlist_item_prepend() is the same but adds to the beginning of
129 * the list or children list. elm_genlist_item_insert_before() inserts at
130 * item before another item and elm_genlist_item_insert_after() inserts after
131 * the indicated item.
133 * The application can clear the list with elm_genlist_clear() which deletes
134 * all the items in the list and elm_genlist_item_del() will delete a specific
135 * item. elm_genlist_item_subitems_clear() will clear all items that are
136 * children of the indicated parent item.
138 * To help inspect list items you can jump to the item at the top of the list
139 * with elm_genlist_first_item_get() which will return the item pointer, and
140 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
141 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
142 * and previous items respectively relative to the indicated item. Using
143 * these calls you can walk the entire item list/tree. Note that as a tree
144 * the items are flattened in the list, so elm_genlist_item_parent_get() will
145 * let you know which item is the parent (and thus know how to skip them if
148 * @section Genlist_Muti_Selection Multi-selection
150 * If the application wants multiple items to be able to be selected,
151 * elm_genlist_multi_select_set() can enable this. If the list is
152 * single-selection only (the default), then elm_genlist_selected_item_get()
153 * will return the selected item, if any, or NULL if none is selected. If the
154 * list is multi-select then elm_genlist_selected_items_get() will return a
155 * list (that is only valid as long as no items are modified (added, deleted,
156 * selected or unselected)).
158 * @section Genlist_Usage_Hints Usage hints
160 * There are also convenience functions. elm_genlist_item_genlist_get() will
161 * return the genlist object the item belongs to. elm_genlist_item_show()
162 * will make the scroller scroll to show that specific item so its visible.
163 * elm_genlist_item_data_get() returns the data pointer set by the item
164 * creation functions.
166 * If an item changes (state of boolean changes, text or contents change),
167 * then use elm_genlist_item_update() to have genlist update the item with
168 * the new state. Genlist will re-realize the item thus call the functions
169 * in the _Elm_Genlist_Item_Class for that item.
171 * To programmatically (un)select an item use elm_genlist_item_selected_set().
172 * To get its selected state use elm_genlist_item_selected_get(). Similarly
173 * to expand/contract an item and get its expanded state, use
174 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
175 * again to make an item disabled (unable to be selected and appear
176 * differently) use elm_genlist_item_disabled_set() to set this and
177 * elm_genlist_item_disabled_get() to get the disabled state.
179 * In general to indicate how the genlist should expand items horizontally to
180 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
181 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
182 * mode means that if items are too wide to fit, the scroller will scroll
183 * horizontally. Otherwise items are expanded to fill the width of the
184 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
185 * to the viewport width and limited to that size. This can be combined with
186 * a different style that uses edjes' ellipsis feature (cutting text off like
189 * Items will only call their selection func and callback when first becoming
190 * selected. Any further clicks will do nothing, unless you enable always
191 * select with elm_genlist_always_select_mode_set(). This means even if
192 * selected, every click will make the selected callbacks be called.
193 * elm_genlist_no_select_mode_set() will turn off the ability to select
194 * items entirely and they will neither appear selected nor call selected
195 * callback functions.
197 * Remember that you can create new styles and add your own theme augmentation
198 * per application with elm_theme_extension_add(). If you absolutely must
199 * have a specific style that overrides any theme the user or system sets up
200 * you can use elm_theme_overlay_add() to add such a file.
202 * @section Genlist_Implementation Implementation
204 * Evas tracks every object you create. Every time it processes an event
205 * (mouse move, down, up etc.) it needs to walk through objects and find out
206 * what event that affects. Even worse every time it renders display updates,
207 * in order to just calculate what to re-draw, it needs to walk through many
208 * many many objects. Thus, the more objects you keep active, the more
209 * overhead Evas has in just doing its work. It is advisable to keep your
210 * active objects to the minimum working set you need. Also remember that
211 * object creation and deletion carries an overhead, so there is a
212 * middle-ground, which is not easily determined. But don't keep massive lists
213 * of objects you can't see or use. Genlist does this with list objects. It
214 * creates and destroys them dynamically as you scroll around. It groups them
215 * into blocks so it can determine the visibility etc. of a whole block at
216 * once as opposed to having to walk the whole list. This 2-level list allows
217 * for very large numbers of items to be in the list (tests have used up to
218 * 2,000,000 items). Also genlist employs a queue for adding items. As items
219 * may be different sizes, every item added needs to be calculated as to its
220 * size and thus this presents a lot of overhead on populating the list, this
221 * genlist employs a queue. Any item added is queued and spooled off over
222 * time, actually appearing some time later, so if your list has many members
223 * you may find it takes a while for them to all appear, with your process
224 * consuming a lot of CPU while it is busy spooling.
226 * Genlist also implements a tree structure, but it does so with callbacks to
227 * the application, with the application filling in tree structures when
228 * requested (allowing for efficient building of a very deep tree that could
229 * even be used for file-management). See the above smart signal callbacks for
232 * @section Genlist_Smart_Events Genlist smart events
234 * Signals that you can add callbacks for are:
235 * - @c "activated" - The user has double-clicked or pressed
236 * (enter|return|spacebar) on an item. The @c event_info parameter is the
237 * item that was activated.
238 * - @c "clicked,double" - The user has double-clicked an item. The @c
239 * event_info parameter is the item that was double-clicked.
240 * - @c "selected" - This is called when a user has made an item selected.
241 * The event_info parameter is the genlist item that was selected.
242 * - @c "unselected" - This is called when a user has made an item
243 * unselected. The event_info parameter is the genlist item that was
245 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
246 * called and the item is now meant to be expanded. The event_info
247 * parameter is the genlist item that was indicated to expand. It is the
248 * job of this callback to then fill in the child items.
249 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
250 * called and the item is now meant to be contracted. The event_info
251 * parameter is the genlist item that was indicated to contract. It is the
252 * job of this callback to then delete the child items.
253 * - @c "expand,request" - This is called when a user has indicated they want
254 * to expand a tree branch item. The callback should decide if the item can
255 * expand (has any children) and then call elm_genlist_item_expanded_set()
256 * appropriately to set the state. The event_info parameter is the genlist
257 * item that was indicated to expand.
258 * - @c "contract,request" - This is called when a user has indicated they
259 * want to contract a tree branch item. The callback should decide if the
260 * item can contract (has any children) and then call
261 * elm_genlist_item_expanded_set() appropriately to set the state. The
262 * event_info parameter is the genlist item that was indicated to contract.
263 * - @c "realized" - This is called when the item in the list is created as a
264 * real evas object. event_info parameter is the genlist item that was
265 * created. The object may be deleted at any time, so it is up to the
266 * caller to not use the object pointer from elm_genlist_item_object_get()
267 * in a way where it may point to freed objects.
268 * - @c "unrealized" - This is called just before an item is unrealized.
269 * After this call content objects provided will be deleted and the item
270 * object itself delete or be put into a floating cache.
271 * - @c "drag,start,up" - This is called when the item in the list has been
272 * dragged (not scrolled) up.
273 * - @c "drag,start,down" - This is called when the item in the list has been
274 * dragged (not scrolled) down.
275 * - @c "drag,start,left" - This is called when the item in the list has been
276 * dragged (not scrolled) left.
277 * - @c "drag,start,right" - This is called when the item in the list has
278 * been dragged (not scrolled) right.
279 * - @c "drag,stop" - This is called when the item in the list has stopped
281 * - @c "drag" - This is called when the item in the list is being dragged.
282 * - @c "longpressed" - This is called when the item is pressed for a certain
283 * amount of time. By default it's 1 second.
284 * - @c "scroll,anim,start" - This is called when scrolling animation has
286 * - @c "scroll,anim,stop" - This is called when scrolling animation has
288 * - @c "scroll,drag,start" - This is called when dragging the content has
290 * - @c "scroll,drag,stop" - This is called when dragging the content has
292 * - @c "edge,top" - This is called when the genlist is scrolled until
294 * - @c "edge,bottom" - This is called when the genlist is scrolled
295 * until the bottom edge.
296 * - @c "edge,left" - This is called when the genlist is scrolled
297 * until the left edge.
298 * - @c "edge,right" - This is called when the genlist is scrolled
299 * until the right edge.
300 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
302 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
304 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
306 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
308 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
309 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
310 * multi-touch pinched in.
311 * - @c "swipe" - This is called when the genlist is swiped.
312 * - @c "moved" - This is called when a genlist item is moved.
313 * - @c "language,changed" - This is called when the program's language is
316 * @section Genlist_Examples Examples
318 * Here is a list of examples that use the genlist, trying to show some of
320 * - @ref genlist_example_01
321 * - @ref genlist_example_02
322 * - @ref genlist_example_03
323 * - @ref genlist_example_04
324 * - @ref genlist_example_05
328 * @addtogroup Genlist
333 * Defines if the item is of any special type (has subitems or it's the
334 * index of a group), or is just a simple item.
340 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
341 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
342 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
343 } Elm_Genlist_Item_Flags;
347 ELM_GENLIST_ITEM_FIELD_ALL = 0,
348 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
349 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
350 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
351 } Elm_Genlist_Item_Field_Flags;
352 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
353 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
354 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
355 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
356 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
359 * Text fetching class function for Elm_Gen_Item_Class.
360 * @param data The data passed in the item creation function
361 * @param obj The base widget object
362 * @param part The part name of the swallow
363 * @return The allocated (NOT stringshared) string to set as the text
365 typedef char *(*Elm_Genlist_Item_Text_Get_Cb)(void *data, Evas_Object *obj, const char *part);
368 * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
369 * @param data The data passed in the item creation function
370 * @param obj The base widget object
371 * @param part The part name of the swallow
372 * @return The content object to swallow
374 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)(void *data, Evas_Object *obj, const char *part);
377 * State fetching class function for Elm_Gen_Item_Class.
378 * @param data The data passed in the item creation function
379 * @param obj The base widget object
380 * @param part The part name of the swallow
381 * @return The hell if I know
383 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb)(void *data, Evas_Object *obj, const char *part);
386 * Deletion class function for Elm_Gen_Item_Class.
387 * @param data The data passed in the item creation function
388 * @param obj The base widget object
390 typedef void (*Elm_Genlist_Item_Del_Cb)(void *data, Evas_Object *obj);
393 * @struct _Elm_Genlist_Item_Class
395 * Genlist item class definition structs.
397 * This struct contains the style and fetching functions that will define the
398 * contents of each item.
400 * @see @ref Genlist_Item_Class
402 struct _Elm_Genlist_Item_Class
404 const char *item_style; /**< style of this class. */
405 struct Elm_Genlist_Item_Class_Func
407 Elm_Genlist_Item_Text_Get_Cb text_get; /**< Text fetching class function for genlist item classes.*/
408 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
409 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
410 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
413 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
415 * Add a new genlist widget to the given parent Elementary
418 * @param parent The parent object
419 * @return a new genlist widget handle or @c NULL, on errors
421 * This function inserts a new genlist widget on the canvas.
423 * @see elm_genlist_item_append()
424 * @see elm_genlist_item_del()
425 * @see elm_genlist_clear()
429 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
432 * Remove all items from a given genlist widget.
434 * @param obj The genlist object
436 * This removes (and deletes) all items in @p obj, leaving it empty.
438 * @see elm_genlist_item_del(), to remove just one item.
442 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
445 * Enable or disable multi-selection in the genlist
447 * @param obj The genlist object
448 * @param multi Multi-select enable/disable. Default is disabled.
450 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
451 * the list. This allows more than 1 item to be selected. To retrieve the list
452 * of selected items, use elm_genlist_selected_items_get().
454 * @see elm_genlist_selected_items_get()
455 * @see elm_genlist_multi_select_get()
459 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
462 * Gets if multi-selection in genlist is enabled or disabled.
464 * @param obj The genlist object
465 * @return Multi-select enabled/disabled
466 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
468 * @see elm_genlist_multi_select_set()
472 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
475 * This sets the horizontal stretching mode.
477 * @param obj The genlist object
478 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
480 * This sets the mode used for sizing items horizontally. Valid modes
481 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
482 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
483 * the scroller will scroll horizontally. Otherwise items are expanded
484 * to fill the width of the viewport of the scroller. If it is
485 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
486 * limited to that size.
488 * @see elm_genlist_horizontal_get()
492 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
495 * Gets the horizontal stretching mode.
497 * @param obj The genlist object
498 * @return The mode to use
499 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
501 * @see elm_genlist_horizontal_set()
505 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
508 * Set the always select mode.
510 * @param obj The genlist object
511 * @param always_select The always select mode (@c EINA_TRUE = on, @c
512 * EINA_FALSE = off). Default is @c EINA_FALSE.
514 * Items will only call their selection func and callback when first
515 * becoming selected. Any further clicks will do nothing, unless you
516 * enable always select with elm_genlist_always_select_mode_set().
517 * This means that, even if selected, every click will make the selected
518 * callbacks be called.
520 * @see elm_genlist_always_select_mode_get()
524 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
527 * Get the always select mode.
529 * @param obj The genlist object
530 * @return The always select mode
531 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
533 * @see elm_genlist_always_select_mode_set()
537 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
540 * Enable/disable the no select mode.
542 * @param obj The genlist object
543 * @param no_select The no select mode
544 * (EINA_TRUE = on, EINA_FALSE = off)
546 * This will turn off the ability to select items entirely and they
547 * will neither appear selected nor call selected callback functions.
549 * @see elm_genlist_no_select_mode_get()
553 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
556 * Gets whether the no select mode is enabled.
558 * @param obj The genlist object
559 * @return The no select mode
560 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
562 * @see elm_genlist_no_select_mode_set()
566 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
569 * Enable/disable compress mode.
571 * @param obj The genlist object
572 * @param compress The compress mode
573 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
575 * This will enable the compress mode where items are "compressed"
576 * horizontally to fit the genlist scrollable viewport width. This is
577 * special for genlist. Do not rely on
578 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
579 * work as genlist needs to handle it specially.
581 * @see elm_genlist_compress_mode_get()
585 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
588 * Get whether the compress mode is enabled.
590 * @param obj The genlist object
591 * @return The compress mode
592 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
594 * @see elm_genlist_compress_mode_set()
598 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
601 * Enable/disable height-for-width mode.
603 * @param obj The genlist object
604 * @param setting The height-for-width mode (@c EINA_TRUE = on,
605 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
607 * With height-for-width mode the item width will be fixed (restricted
608 * to a minimum of) to the list width when calculating its size in
609 * order to allow the height to be calculated based on it. This allows,
610 * for instance, text block to wrap lines if the Edje part is
611 * configured with "text.min: 0 1".
613 * @note This mode will make list resize slower as it will have to
614 * recalculate every item height again whenever the list width
617 * @note When height-for-width mode is enabled, it also enables
618 * compress mode (see elm_genlist_compress_mode_set()) and
619 * disables homogeneous (see elm_genlist_homogeneous_set()).
623 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
626 * Get whether the height-for-width mode is enabled.
628 * @param obj The genlist object
629 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
634 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
637 * Enable/disable horizontal and vertical bouncing effect.
639 * @param obj The genlist object
640 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
641 * EINA_FALSE = off). Default is @c EINA_FALSE.
642 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
643 * EINA_FALSE = off). Default is @c EINA_TRUE.
645 * This will enable or disable the scroller bouncing effect for the
646 * genlist. See elm_scroller_bounce_set() for details.
648 * @see elm_scroller_bounce_set()
649 * @see elm_genlist_bounce_get()
653 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
656 * Get whether the horizontal and vertical bouncing effect is enabled.
658 * @param obj The genlist object
659 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
661 * @param v_bounce Pointer to a bool to receive if the bounce vertically
664 * @see elm_genlist_bounce_set()
668 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
671 * Enable/disable homogeneous mode.
673 * @param obj The genlist object
674 * @param homogeneous Assume the items within the genlist are of the
675 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
678 * This will enable the homogeneous mode where items are of the same
679 * height and width so that genlist may do the lazy-loading at its
680 * maximum (which increases the performance for scrolling the list). This
681 * implies 'compressed' mode.
683 * @see elm_genlist_compress_mode_set()
684 * @see elm_genlist_homogeneous_get()
688 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
691 * Get whether the homogeneous mode is enabled.
693 * @param obj The genlist object
694 * @return Assume the items within the genlist are of the same height
695 * and width (EINA_TRUE = on, EINA_FALSE = off)
697 * @see elm_genlist_homogeneous_set()
701 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
704 * Set the maximum number of items within an item block
706 * @param obj The genlist object
707 * @param n Maximum number of items within an item block. Default is 32.
709 * This will configure the block count to tune to the target with
710 * particular performance matrix.
712 * A block of objects will be used to reduce the number of operations due to
713 * many objects in the screen. It can determine the visibility, or if the
714 * object has changed, it theme needs to be updated, etc. doing this kind of
715 * calculation to the entire block, instead of per object.
717 * The default value for the block count is enough for most lists, so unless
718 * you know you will have a lot of objects visible in the screen at the same
719 * time, don't try to change this.
721 * @see elm_genlist_block_count_get()
722 * @see @ref Genlist_Implementation
726 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
729 * Get the maximum number of items within an item block
731 * @param obj The genlist object
732 * @return Maximum number of items within an item block
734 * @see elm_genlist_block_count_set()
738 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
741 * Set the timeout in seconds for the longpress event.
743 * @param obj The genlist object
744 * @param timeout timeout in seconds. Default is 1.
746 * This option will change how long it takes to send an event "longpressed"
747 * after the mouse down signal is sent to the list. If this event occurs, no
748 * "clicked" event will be sent.
750 * @see elm_genlist_longpress_timeout_set()
754 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
757 * Get the timeout in seconds for the longpress event.
759 * @param obj The genlist object
760 * @return timeout in seconds
762 * @see elm_genlist_longpress_timeout_get()
766 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
769 * Append a new item in a given genlist widget.
771 * @param obj The genlist object
772 * @param itc The item class for the item
773 * @param data The item data
774 * @param parent The parent item, or NULL if none
775 * @param flags Item flags
776 * @param func Convenience function called when the item is selected
777 * @param func_data Data passed to @p func above.
778 * @return A handle to the item added or @c NULL if not possible
780 * This adds the given item to the end of the list or the end of
781 * the children list if the @p parent is given.
783 * @see elm_genlist_item_prepend()
784 * @see elm_genlist_item_insert_before()
785 * @see elm_genlist_item_insert_after()
786 * @see elm_genlist_item_del()
790 EAPI Elm_Genlist_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
793 * Prepend a new item in a given genlist widget.
795 * @param obj The genlist object
796 * @param itc The item class for the item
797 * @param data The item data
798 * @param parent The parent item, or NULL if none
799 * @param flags Item flags
800 * @param func Convenience function called when the item is selected
801 * @param func_data Data passed to @p func above.
802 * @return A handle to the item added or NULL if not possible
804 * This adds an item to the beginning of the list or beginning of the
805 * children of the parent if given.
807 * @see elm_genlist_item_append()
808 * @see elm_genlist_item_insert_before()
809 * @see elm_genlist_item_insert_after()
810 * @see elm_genlist_item_del()
814 EAPI Elm_Genlist_Item *elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
817 * Insert an item before another in a genlist widget
819 * @param obj The genlist object
820 * @param itc The item class for the item
821 * @param data The item data
822 * @param before The item to place this new one before.
823 * @param flags Item flags
824 * @param func Convenience function called when the item is selected
825 * @param func_data Data passed to @p func above.
826 * @return A handle to the item added or @c NULL if not possible
828 * This inserts an item before another in the list. It will be in the
829 * same tree level or group as the item it is inserted before.
831 * @see elm_genlist_item_append()
832 * @see elm_genlist_item_prepend()
833 * @see elm_genlist_item_insert_after()
834 * @see elm_genlist_item_del()
838 EAPI Elm_Genlist_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *before, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
841 * Insert an item after another in a genlist widget
843 * @param obj The genlist object
844 * @param itc The item class for the item
845 * @param data The item data
846 * @param after The item to place this new one after.
847 * @param flags Item flags
848 * @param func Convenience function called when the item is selected
849 * @param func_data Data passed to @p func above.
850 * @return A handle to the item added or @c NULL if not possible
852 * This inserts an item after another in the list. It will be in the
853 * same tree level or group as the item it is inserted after.
855 * @see elm_genlist_item_append()
856 * @see elm_genlist_item_prepend()
857 * @see elm_genlist_item_insert_before()
858 * @see elm_genlist_item_del()
862 EAPI Elm_Genlist_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *after, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
865 * Insert a new item into the sorted genlist object
867 * @param obj The genlist object
868 * @param itc The item class for the item
869 * @param data The item data
870 * @param parent The parent item, or NULL if none
871 * @param flags Item flags
872 * @param comp The function called for the sort
873 * @param func Convenience function called when item selected
874 * @param func_data Data passed to @p func above.
875 * @return A handle to the item added or NULL if not possible
879 EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
880 EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
882 /* operations to retrieve existing items */
884 * Get the selectd item in the genlist.
886 * @param obj The genlist object
887 * @return The selected item, or NULL if none is selected.
889 * This gets the selected item in the list (if multi-selection is enabled, only
890 * the item that was first selected in the list is returned - which is not very
891 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
894 * If no item is selected, NULL is returned.
896 * @see elm_genlist_selected_items_get()
900 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
903 * Get a list of selected items in the genlist.
905 * @param obj The genlist object
906 * @return The list of selected items, or NULL if none are selected.
908 * It returns a list of the selected items. This list pointer is only valid so
909 * long as the selection doesn't change (no items are selected or unselected, or
910 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
911 * pointers. The order of the items in this list is the order which they were
912 * selected, i.e. the first item in this list is the first item that was
913 * selected, and so on.
915 * @note If not in multi-select mode, consider using function
916 * elm_genlist_selected_item_get() instead.
918 * @see elm_genlist_multi_select_set()
919 * @see elm_genlist_selected_item_get()
923 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
926 * Get the mode item style of items in the genlist
927 * @param obj The genlist object
928 * @return The mode item style string, or NULL if none is specified
930 * This is a constant string and simply defines the name of the
931 * style that will be used for mode animations. It can be
932 * @c NULL if you don't plan to use Genlist mode. See
933 * elm_genlist_item_mode_set() for more info.
937 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
940 * Set the mode item style of items in the genlist
941 * @param obj The genlist object
942 * @param style The mode item style string, or NULL if none is desired
944 * This is a constant string and simply defines the name of the
945 * style that will be used for mode animations. It can be
946 * @c NULL if you don't plan to use Genlist mode. See
947 * elm_genlist_item_mode_set() for more info.
951 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
954 * Get a list of realized items in genlist
956 * @param obj The genlist object
957 * @return The list of realized items, nor NULL if none are realized.
959 * This returns a list of the realized items in the genlist. The list
960 * contains Elm_Genlist_Item pointers. The list must be freed by the
961 * caller when done with eina_list_free(). The item pointers in the
962 * list are only valid so long as those items are not deleted or the
963 * genlist is not deleted.
965 * @see elm_genlist_realized_items_update()
969 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
972 * Get the item that is at the x, y canvas coords.
974 * @param obj The gelinst object.
975 * @param x The input x coordinate
976 * @param y The input y coordinate
977 * @param posret The position relative to the item returned here
978 * @return The item at the coordinates or NULL if none
980 * This returns the item at the given coordinates (which are canvas
981 * relative, not object-relative). If an item is at that coordinate,
982 * that item handle is returned, and if @p posret is not NULL, the
983 * integer pointed to is set to a value of -1, 0 or 1, depending if
984 * the coordinate is on the upper portion of that item (-1), on the
985 * middle section (0) or on the lower part (1). If NULL is returned as
986 * an item (no item found there), then posret may indicate -1 or 1
987 * based if the coordinate is above or below all items respectively in
992 EAPI Elm_Genlist_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret) EINA_ARG_NONNULL(1);
995 * Get the first item in the genlist
997 * This returns the first item in the list.
999 * @param obj The genlist object
1000 * @return The first item, or NULL if none
1004 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1007 * Get the last item in the genlist
1009 * This returns the last item in the list.
1011 * @return The last item, or NULL if none
1015 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1018 * Set the scrollbar policy
1020 * @param obj The genlist object
1021 * @param policy_h Horizontal scrollbar policy.
1022 * @param policy_v Vertical scrollbar policy.
1024 * This sets the scrollbar visibility policy for the given genlist
1025 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
1026 * made visible if it is needed, and otherwise kept hidden.
1027 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
1028 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
1029 * respectively for the horizontal and vertical scrollbars. Default is
1030 * #ELM_SMART_SCROLLER_POLICY_AUTO
1032 * @see elm_genlist_scroller_policy_get()
1036 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
1039 * Get the scrollbar policy
1041 * @param obj The genlist object
1042 * @param policy_h Pointer to store the horizontal scrollbar policy.
1043 * @param policy_v Pointer to store the vertical scrollbar policy.
1045 * @see elm_genlist_scroller_policy_set()
1049 EAPI void elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
1052 * Get the @b next item in a genlist widget's internal list of items,
1053 * given a handle to one of those items.
1055 * @param item The genlist item to fetch next from
1056 * @return The item after @p item, or @c NULL if there's none (and
1059 * This returns the item placed after the @p item, on the container
1062 * @see elm_genlist_item_prev_get()
1066 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1069 * Get the @b previous item in a genlist widget's internal list of items,
1070 * given a handle to one of those items.
1072 * @param item The genlist item to fetch previous from
1073 * @return The item before @p item, or @c NULL if there's none (and
1076 * This returns the item placed before the @p item, on the container
1079 * @see elm_genlist_item_next_get()
1083 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1086 * Get the genlist object's handle which contains a given genlist
1089 * @param item The item to fetch the container from
1090 * @return The genlist (parent) object
1092 * This returns the genlist object itself that an item belongs to.
1096 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1099 * Get the parent item of the given item
1101 * @param it The item
1102 * @return The parent of the item or @c NULL if it has no parent.
1104 * This returns the item that was specified as parent of the item @p it on
1105 * elm_genlist_item_append() and insertion related functions.
1109 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1112 * Remove all sub-items (children) of the given item
1114 * @param it The item
1116 * This removes all items that are children (and their descendants) of the
1119 * @see elm_genlist_clear()
1120 * @see elm_genlist_item_del()
1124 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1127 * Set whether a given genlist item is selected or not
1129 * @param it The item
1130 * @param selected Use @c EINA_TRUE, to make it selected, @c
1131 * EINA_FALSE to make it unselected
1133 * This sets the selected state of an item. If multi selection is
1134 * not enabled on the containing genlist and @p selected is @c
1135 * EINA_TRUE, any other previously selected items will get
1136 * unselected in favor of this new one.
1138 * @see elm_genlist_item_selected_get()
1142 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
1145 * Get whether a given genlist item is selected or not
1147 * @param it The item
1148 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
1150 * @see elm_genlist_item_selected_set() for more details
1154 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1157 * Sets the expanded state of an item.
1159 * @param it The item
1160 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
1162 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
1165 * The theme will respond to this change visually, and a signal "expanded" or
1166 * "contracted" will be sent from the genlist with a pointer to the item that
1167 * has been expanded/contracted.
1169 * Calling this function won't show or hide any child of this item (if it is
1170 * a parent). You must manually delete and create them on the callbacks fo
1171 * the "expanded" or "contracted" signals.
1173 * @see elm_genlist_item_expanded_get()
1177 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
1180 * Get the expanded state of an item
1182 * @param it The item
1183 * @return The expanded state
1185 * This gets the expanded state of an item.
1187 * @see elm_genlist_item_expanded_set()
1191 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1194 * Get the depth of expanded item
1196 * @param it The genlist item object
1197 * @return The depth of expanded item
1201 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1204 * Set whether a given genlist item is disabled or not.
1206 * @param it The item
1207 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
1208 * to enable it back.
1210 * A disabled item cannot be selected or unselected. It will also
1211 * change its appearance, to signal the user it's disabled.
1213 * @see elm_genlist_item_disabled_get()
1217 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1220 * Get whether a given genlist item is disabled or not.
1222 * @param it The item
1223 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
1226 * @see elm_genlist_item_disabled_set() for more details
1230 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1233 * Sets the display only state of an item.
1235 * @param it The item
1236 * @param display_only @c EINA_TRUE if the item is display only, @c
1237 * EINA_FALSE otherwise.
1239 * A display only item cannot be selected or unselected. It is for
1240 * display only and not selecting or otherwise clicking, dragging
1241 * etc. by the user, thus finger size rules will not be applied to
1244 * It's good to set group index items to display only state.
1246 * @see elm_genlist_item_display_only_get()
1250 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
1253 * Get the display only state of an item
1255 * @param it The item
1256 * @return @c EINA_TRUE if the item is display only, @c
1257 * EINA_FALSE otherwise.
1259 * @see elm_genlist_item_display_only_set()
1263 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1266 * Show the portion of a genlist's internal list containing a given
1267 * item, immediately.
1269 * @param it The item to display
1271 * This causes genlist to jump to the given item @p it and show it (by
1272 * immediately scrolling to that position), if it is not fully visible.
1274 * @see elm_genlist_item_bring_in()
1275 * @see elm_genlist_item_top_show()
1276 * @see elm_genlist_item_middle_show()
1280 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1283 * Animatedly bring in, to the visible are of a genlist, a given
1286 * @param it The item to display
1288 * This causes genlist to jump to the given item @p it and show it (by
1289 * animatedly scrolling), if it is not fully visible. This may use animation
1290 * to do so and take a period of time
1292 * @see elm_genlist_item_show()
1293 * @see elm_genlist_item_top_bring_in()
1294 * @see elm_genlist_item_middle_bring_in()
1298 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1301 * Show the portion of a genlist's internal list containing a given
1302 * item, immediately.
1304 * @param it The item to display
1306 * This causes genlist to jump to the given item @p it and show it (by
1307 * immediately scrolling to that position), if it is not fully visible.
1309 * The item will be positioned at the top of the genlist viewport.
1311 * @see elm_genlist_item_show()
1312 * @see elm_genlist_item_top_bring_in()
1316 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1319 * Animatedly bring in, to the visible are of a genlist, a given
1322 * @param it The item
1324 * This causes genlist to jump to the given item @p it and show it (by
1325 * animatedly scrolling), if it is not fully visible. This may use animation
1326 * to do so and take a period of time
1328 * The item will be positioned at the top of the genlist viewport.
1330 * @see elm_genlist_item_bring_in()
1331 * @see elm_genlist_item_top_show()
1335 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1338 * Show the portion of a genlist's internal list containing a given
1339 * item, immediately.
1341 * @param it The item to display
1343 * This causes genlist to jump to the given item @p it and show it (by
1344 * immediately scrolling to that position), if it is not fully visible.
1346 * The item will be positioned at the middle of the genlist viewport.
1348 * @see elm_genlist_item_show()
1349 * @see elm_genlist_item_middle_bring_in()
1353 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1356 * Animatedly bring in, to the visible are of a genlist, a given
1359 * @param it The item
1361 * This causes genlist to jump to the given item @p it and show it (by
1362 * animatedly scrolling), if it is not fully visible. This may use animation
1363 * to do so and take a period of time
1365 * The item will be positioned at the middle of the genlist viewport.
1367 * @see elm_genlist_item_bring_in()
1368 * @see elm_genlist_item_middle_show()
1372 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1375 * Remove a genlist item from the its parent, deleting it.
1377 * @param item The item to be removed.
1378 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
1380 * @see elm_genlist_clear(), to remove all items in a genlist at
1385 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1388 * Return the data associated to a given genlist item
1390 * @param item The genlist item.
1391 * @return the data associated to this item.
1393 * This returns the @c data value passed on the
1394 * elm_genlist_item_append() and related item addition calls.
1396 * @see elm_genlist_item_append()
1397 * @see elm_genlist_item_data_set()
1401 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1404 * Set the data associated to a given genlist item
1406 * @param item The genlist item
1407 * @param data The new data pointer to set on it
1409 * This @b overrides the @c data value passed on the
1410 * elm_genlist_item_append() and related item addition calls. This
1411 * function @b won't call elm_genlist_item_update() automatically,
1412 * so you'd issue it afterwards if you want to hove the item
1413 * updated to reflect the that new data.
1415 * @see elm_genlist_item_data_get()
1419 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
1422 * Tells genlist to "orphan" contents fetchs by the item class
1424 * @param it The item
1426 * This instructs genlist to release references to contents in the item,
1427 * meaning that they will no longer be managed by genlist and are
1428 * floating "orphans" that can be re-used elsewhere if the user wants
1433 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1436 * Get the real Evas object created to implement the view of a
1437 * given genlist item
1439 * @param item The genlist item.
1440 * @return the Evas object implementing this item's view.
1442 * This returns the actual Evas object used to implement the
1443 * specified genlist item's view. This may be @c NULL, as it may
1444 * not have been created or may have been deleted, at any time, by
1445 * the genlist. <b>Do not modify this object</b> (move, resize,
1446 * show, hide, etc.), as the genlist is controlling it. This
1447 * function is for querying, emitting custom signals or hooking
1448 * lower level callbacks for events on that object. Do not delete
1449 * this object under any circumstances.
1451 * @see elm_genlist_item_data_get()
1455 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1458 * Update the contents of an item
1460 * @param it The item
1462 * This updates an item by calling all the item class functions again
1463 * to get the contents, texts and states. Use this when the original
1464 * item data has changed and the changes are desired to be reflected.
1466 * Use elm_genlist_realized_items_update() to update all already realized
1469 * @see elm_genlist_realized_items_update()
1473 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1476 * Promote an item to the top of the list
1478 * @param it The item
1482 EAPI void elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
1485 * Demote an item to the end of the list
1487 * @param it The item
1491 EAPI void elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
1494 * Update the part of an item
1496 * @param it The item
1497 * @param parts The name of item's part
1498 * @param itf The flags of item's part type
1500 * This updates an item's part by calling item's fetching functions again
1501 * to get the contents, texts and states. Use this when the original
1502 * item data has changed and the changes are desired to be reflected.
1503 * Second parts argument is used for globbing to match '*', '?', and '.'
1504 * It can be used at updating multi fields.
1506 * Use elm_genlist_realized_items_update() to update an item's all
1509 * @see elm_genlist_item_update()
1513 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
1516 * Update the item class of an item
1518 * @param it The item
1519 * @param itc The item class for the item
1521 * This sets another class fo the item, changing the way that it is
1522 * displayed. After changing the item class, elm_genlist_item_update() is
1523 * called on the item @p it.
1527 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
1528 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
1531 * Set the text to be shown in a given genlist item's tooltips.
1533 * @param item The genlist item
1534 * @param text The text to set in the content
1536 * This call will setup the text to be used as tooltip to that item
1537 * (analogous to elm_object_tooltip_text_set(), but being item
1538 * tooltips with higher precedence than object tooltips). It can
1539 * have only one tooltip at a time, so any previous tooltip data
1542 * In order to set a content or something else as a tooltip, look at
1543 * elm_genlist_item_tooltip_content_cb_set().
1547 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
1550 * Set the content to be shown in a given genlist item's tooltips
1552 * @param item The genlist item.
1553 * @param func The function returning the tooltip contents.
1554 * @param data What to provide to @a func as callback data/context.
1555 * @param del_cb Called when data is not needed anymore, either when
1556 * another callback replaces @p func, the tooltip is unset with
1557 * elm_genlist_item_tooltip_unset() or the owner @p item
1558 * dies. This callback receives as its first parameter the
1559 * given @p data, being @c event_info the item handle.
1561 * This call will setup the tooltip's contents to @p item
1562 * (analogous to elm_object_tooltip_content_cb_set(), but being
1563 * item tooltips with higher precedence than object tooltips). It
1564 * can have only one tooltip at a time, so any previous tooltip
1565 * content will get removed. @p func (with @p data) will be called
1566 * every time Elementary needs to show the tooltip and it should
1567 * return a valid Evas object, which will be fully managed by the
1568 * tooltip system, getting deleted when the tooltip is gone.
1570 * In order to set just a text as a tooltip, look at
1571 * elm_genlist_item_tooltip_text_set().
1575 EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Genlist_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
1578 * Unset a tooltip from a given genlist item
1580 * @param item genlist item to remove a previously set tooltip from.
1582 * This call removes any tooltip set on @p item. The callback
1583 * provided as @c del_cb to
1584 * elm_genlist_item_tooltip_content_cb_set() will be called to
1585 * notify it is not used anymore (and have resources cleaned, if
1588 * @see elm_genlist_item_tooltip_content_cb_set()
1592 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1595 * Set a different @b style for a given genlist item's tooltip.
1597 * @param item genlist item with tooltip set
1598 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
1599 * "default", @c "transparent", etc)
1601 * Tooltips can have <b>alternate styles</b> to be displayed on,
1602 * which are defined by the theme set on Elementary. This function
1603 * works analogously as elm_object_tooltip_style_set(), but here
1604 * applied only to genlist item objects. The default style for
1605 * tooltips is @c "default".
1607 * @note before you set a style you should define a tooltip with
1608 * elm_genlist_item_tooltip_content_cb_set() or
1609 * elm_genlist_item_tooltip_text_set()
1611 * @see elm_genlist_item_tooltip_style_get()
1615 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
1618 * Get the style set a given genlist item's tooltip.
1620 * @param item genlist item with tooltip already set on.
1621 * @return style the theme style in use, which defaults to
1622 * "default". If the object does not have a tooltip set,
1623 * then @c NULL is returned.
1625 * @see elm_genlist_item_tooltip_style_set() for more details
1629 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1632 * @brief Disable size restrictions on an object's tooltip
1633 * @param item The tooltip's anchor object
1634 * @param disable If EINA_TRUE, size restrictions are disabled
1635 * @return EINA_FALSE on failure, EINA_TRUE on success
1637 * This function allows a tooltip to expand beyond its parant window's canvas.
1638 * It will instead be limited only by the size of the display.
1640 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
1643 * @brief Retrieve size restriction state of an object's tooltip
1644 * @param item The tooltip's anchor object
1645 * @return If EINA_TRUE, size restrictions are disabled
1647 * This function returns whether a tooltip is allowed to expand beyond
1648 * its parant window's canvas.
1649 * It will instead be limited only by the size of the display.
1651 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
1654 * Set the type of mouse pointer/cursor decoration to be shown,
1655 * when the mouse pointer is over the given genlist widget item
1657 * @param item genlist item to customize cursor on
1658 * @param cursor the cursor type's name
1660 * This function works analogously as elm_object_cursor_set(), but
1661 * here the cursor's changing area is restricted to the item's
1662 * area, and not the whole widget's. Note that that item cursors
1663 * have precedence over widget cursors, so that a mouse over @p
1664 * item will always show cursor @p type.
1666 * If this function is called twice for an object, a previously set
1667 * cursor will be unset on the second call.
1669 * @see elm_object_cursor_set()
1670 * @see elm_genlist_item_cursor_get()
1671 * @see elm_genlist_item_cursor_unset()
1675 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
1678 * Get the type of mouse pointer/cursor decoration set to be shown,
1679 * when the mouse pointer is over the given genlist widget item
1681 * @param item genlist item with custom cursor set
1682 * @return the cursor type's name or @c NULL, if no custom cursors
1683 * were set to @p item (and on errors)
1685 * @see elm_object_cursor_get()
1686 * @see elm_genlist_item_cursor_set() for more details
1687 * @see elm_genlist_item_cursor_unset()
1691 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1694 * Unset any custom mouse pointer/cursor decoration set to be
1695 * shown, when the mouse pointer is over the given genlist widget
1696 * item, thus making it show the @b default cursor again.
1698 * @param item a genlist item
1700 * Use this call to undo any custom settings on this item's cursor
1701 * decoration, bringing it back to defaults (no custom style set).
1703 * @see elm_object_cursor_unset()
1704 * @see elm_genlist_item_cursor_set() for more details
1708 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1711 * Set a different @b style for a given custom cursor set for a
1714 * @param item genlist item with custom cursor set
1715 * @param style the <b>theme style</b> to use (e.g. @c "default",
1716 * @c "transparent", etc)
1718 * This function only makes sense when one is using custom mouse
1719 * cursor decorations <b>defined in a theme file</b> , which can
1720 * have, given a cursor name/type, <b>alternate styles</b> on
1721 * it. It works analogously as elm_object_cursor_style_set(), but
1722 * here applied only to genlist item objects.
1724 * @warning Before you set a cursor style you should have defined a
1725 * custom cursor previously on the item, with
1726 * elm_genlist_item_cursor_set()
1728 * @see elm_genlist_item_cursor_engine_only_set()
1729 * @see elm_genlist_item_cursor_style_get()
1733 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
1736 * Get the current @b style set for a given genlist item's custom
1739 * @param item genlist item with custom cursor set.
1740 * @return style the cursor style in use. If the object does not
1741 * have a cursor set, then @c NULL is returned.
1743 * @see elm_genlist_item_cursor_style_set() for more details
1747 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1750 * Set if the (custom) cursor for a given genlist item should be
1751 * searched in its theme, also, or should only rely on the
1754 * @param item item with custom (custom) cursor already set on
1755 * @param engine_only Use @c EINA_TRUE to have cursors looked for
1756 * only on those provided by the rendering engine, @c EINA_FALSE to
1757 * have them searched on the widget's theme, as well.
1759 * @note This call is of use only if you've set a custom cursor
1760 * for genlist items, with elm_genlist_item_cursor_set().
1762 * @note By default, cursors will only be looked for between those
1763 * provided by the rendering engine.
1767 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
1770 * Get if the (custom) cursor for a given genlist item is being
1771 * searched in its theme, also, or is only relying on the rendering
1774 * @param item a genlist item
1775 * @return @c EINA_TRUE, if cursors are being looked for only on
1776 * those provided by the rendering engine, @c EINA_FALSE if they
1777 * are being searched on the widget's theme, as well.
1779 * @see elm_genlist_item_cursor_engine_only_set(), for more details
1783 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
1786 * Get the index of the item. It is only valid once displayed.
1788 * @param item a genlist item
1789 * @return the position inside the list of item.
1793 EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
1796 * Update the contents of all realized items.
1798 * @param obj The genlist object.
1800 * This updates all realized items by calling all the item class functions again
1801 * to get the contents, texts and states. Use this when the original
1802 * item data has changed and the changes are desired to be reflected.
1804 * To update just one item, use elm_genlist_item_update().
1806 * @see elm_genlist_realized_items_get()
1807 * @see elm_genlist_item_update()
1811 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
1814 * Activate a genlist mode on an item
1816 * @param item The genlist item
1817 * @param mode Mode name
1818 * @param mode_set Boolean to define set or unset mode.
1820 * A genlist mode is a different way of selecting an item. Once a mode is
1821 * activated on an item, any other selected item is immediately unselected.
1822 * This feature provides an easy way of implementing a new kind of animation
1823 * for selecting an item, without having to entirely rewrite the item style
1824 * theme. However, the elm_genlist_selected_* API can't be used to get what
1825 * item is activate for a mode.
1827 * The current item style will still be used, but applying a genlist mode to
1828 * an item will select it using a different kind of animation.
1830 * The current active item for a mode can be found by
1831 * elm_genlist_mode_item_get().
1833 * The characteristics of genlist mode are:
1834 * - Only one mode can be active at any time, and for only one item.
1835 * - Genlist handles deactivating other items when one item is activated.
1836 * - A mode is defined in the genlist theme (edc), and more modes can easily
1838 * - A mode style and the genlist item style are different things. They
1839 * can be combined to provide a default style to the item, with some kind
1840 * of animation for that item when the mode is activated.
1842 * When a mode is activated on an item, a new view for that item is created.
1843 * The theme of this mode defines the animation that will be used to transit
1844 * the item from the old view to the new view. This second (new) view will be
1845 * active for that item while the mode is active on the item, and will be
1846 * destroyed after the mode is totally deactivated from that item.
1848 * @see elm_genlist_mode_get()
1849 * @see elm_genlist_mode_item_get()
1853 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
1856 * Get the last (or current) genlist mode used.
1858 * @param obj The genlist object
1860 * This function just returns the name of the last used genlist mode. It will
1861 * be the current mode if it's still active.
1863 * @see elm_genlist_item_mode_set()
1864 * @see elm_genlist_mode_item_get()
1868 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1871 * Get active genlist mode item
1873 * @param obj The genlist object
1874 * @return The active item for that current mode. Or @c NULL if no item is
1875 * activated with any mode.
1877 * This function returns the item that was activated with a mode, by the
1878 * function elm_genlist_item_mode_set().
1880 * @see elm_genlist_item_mode_set()
1881 * @see elm_genlist_mode_get()
1885 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1890 * @param obj The genlist object
1891 * @param reorder_mode The reorder mode
1892 * (EINA_TRUE = on, EINA_FALSE = off)
1896 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
1899 * Get the reorder mode
1901 * @param obj The genlist object
1902 * @return The reorder mode
1903 * (EINA_TRUE = on, EINA_FALSE = off)
1907 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);