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
34 * - @c mode_item_style - This is a constant string and simply defines the name
35 * of the mode item style. It is used to specify mode item style. It can be
36 * used to set sweep mode.
37 * - @c edit_item_style - This is a constant string and simply defines the name
38 * of the edit item style. It is used to specify edit item style. It can be
39 * used to set selection, checking and deletion mode.
40 * - @c func - A struct with pointers to functions that will be called when
41 * an item is going to be actually created. All of them receive a @c data
42 * parameter that will point to the same data passed to
43 * elm_genlist_item_append() and related item creation functions, and an @c
44 * obj parameter that points to the genlist object itself.
46 * The function pointers inside @c func are @c text_get, @c content_get, @c
47 * state_get and @c del. The 3 first functions also receive a @c part
48 * parameter described below. A brief description of these functions follows:
50 * - @c text_get - The @c part parameter is the name string of one of the
51 * existing text parts in the Edje group implementing the item's theme.
52 * This function @b must return a strdup'()ed string, as the caller will
53 * free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
54 * - @c content_get - The @c part parameter is the name string of one of the
55 * existing (content) swallow parts in the Edje group implementing the item's
56 * theme. It must return @c NULL, when no content is desired, or a valid
57 * object handle, otherwise. The object will be deleted by the genlist on
58 * its deletion or when the item is "unrealized". See
59 * #Elm_Genlist_Item_Content_Get_Cb.
60 * - @c func.state_get - The @c part parameter is the name string of one of
61 * the state parts in the Edje group implementing the item's theme. Return
62 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
63 * emit a signal to its theming Edje object with @c "elm,state,xxx,active"
64 * and @c "elm" as "emission" and "source" arguments, respectively, when
65 * the state is true (the default is false), where @c xxx is the name of
66 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
67 * - @c func.del - This is intended for use when genlist items are deleted,
68 * so any data attached to the item (e.g. its data parameter on creation)
69 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
71 * available item styles:
73 * - default_style - The text part is a textblock
75 * @image html img/widget/genlist/preview-04.png
76 * @image latex img/widget/genlist/preview-04.eps
80 * @image html img/widget/genlist/preview-01.png
81 * @image latex img/widget/genlist/preview-01.eps
83 * - icon_top_text_bottom
85 * @image html img/widget/genlist/preview-02.png
86 * @image latex img/widget/genlist/preview-02.eps
90 * @image html img/widget/genlist/preview-03.png
91 * @image latex img/widget/genlist/preview-03.eps
93 * @section Genlist_Items Structure of items
95 * An item in a genlist can have 0 or more texts (they can be regular
96 * text or textblock Evas objects - that's up to the style to determine), 0
97 * or more contents (which are simply objects swallowed into the genlist item's
98 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
99 * behavior left to the user to define. The Edje part names for each of
100 * these properties will be looked up, in the theme file for the genlist,
101 * under the Edje (string) data items named @c "labels", @c "contents" and @c
102 * "states", respectively. For each of those properties, if more than one
103 * part is provided, they must have names listed separated by spaces in the
104 * data fields. For the default genlist item theme, we have @b one text
105 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
106 * "elm.swallow.end") and @b no state parts.
108 * A genlist item may be at one of several styles. Elementary provides one
109 * by default - "default", but this can be extended by system or application
110 * custom themes/overlays/extensions (see @ref Theme "themes" for more
113 * @section Genlist_Manipulation Editing and Navigating
115 * Items can be added by several calls. All of them return a @ref
116 * Elm_Object_Item handle that is an internal member inside the genlist.
117 * They all take a data parameter that is meant to be used for a handle to
118 * the applications internal data (eg. the struct with the original item
119 * data). The parent parameter is the parent genlist item this belongs to if
120 * it is a tree or an indexed group, and NULL if there is no parent. The
121 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
122 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
123 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
124 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
125 * is set then this item is group index item that is displayed at the top
126 * until the next group comes. The func parameter is a convenience callback
127 * that is called when the item is selected and the data parameter will be
128 * the func_data parameter, obj be the genlist object and event_info will be
131 * elm_genlist_item_append() adds an item to the end of the list, or if
132 * there is a parent, to the end of all the child items of the parent.
133 * elm_genlist_item_prepend() is the same but adds to the beginning of
134 * the list or children list. elm_genlist_item_insert_before() inserts at
135 * item before another item and elm_genlist_item_insert_after() inserts after
136 * the indicated item.
138 * The application can clear the list with elm_genlist_clear() which deletes
139 * all the items in the list and elm_object_item_del() will delete a specific
140 * item. elm_genlist_item_subitems_clear() will clear all items that are
141 * children of the indicated parent item.
143 * To help inspect list items you can jump to the item at the top of the list
144 * with elm_genlist_first_item_get() which will return the item pointer, and
145 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
146 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
147 * and previous items respectively relative to the indicated item. Using
148 * these calls you can walk the entire item list/tree. Note that as a tree
149 * the items are flattened in the list, so elm_genlist_item_parent_get() will
150 * let you know which item is the parent (and thus know how to skip them if
153 * @section Genlist_Multi_Selection Multi-selection
155 * If the application wants multiple items to be able to be selected,
156 * elm_genlist_multi_select_set() can enable this. If the list is
157 * single-selection only (the default), then elm_genlist_selected_item_get()
158 * will return the selected item, if any, or NULL if none is selected. If the
159 * list is multi-select then elm_genlist_selected_items_get() will return a
160 * list (that is only valid as long as no items are modified (added, deleted,
161 * selected or unselected)).
163 * @section Genlist_Usage_Hints Usage hints
165 * There are also convenience functions. elm_object_item_widget_get() will
166 * return the genlist object the item belongs to. elm_genlist_item_show()
167 * will make the scroller scroll to show that specific item so its visible.
168 * elm_object_item_data_get() returns the data pointer set by the item
169 * creation functions.
171 * If an item changes (state of boolean changes, text or contents change),
172 * then use elm_genlist_item_update() to have genlist update the item with
173 * the new state. Genlist will re-realize the item and thus call the functions
174 * in the _Elm_Genlist_Item_Class for that item.
176 * To programmatically (un)select an item use elm_genlist_item_selected_set().
177 * To get its selected state use elm_genlist_item_selected_get(). Similarly
178 * to expand/contract an item and get its expanded state, use
179 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
180 * again to make an item disabled (unable to be selected and appear
181 * differently) use elm_object_item_disabled_set() to set this and
182 * elm_object_item_disabled_get() to get the disabled state.
184 * In general to indicate how the genlist should expand items horizontally to
185 * fill the list area, use elm_genlist_mode_set(). Valid modes are
186 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
187 * mode means that if items are too wide to fit, the scroller will scroll
188 * horizontally. Otherwise items are expanded to fill the width of the
189 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
190 * to the viewport width and limited to that size. This can be combined with
191 * a different style that uses edjes' ellipsis feature (cutting text off like
194 * Items will only call their selection func and callback when first becoming
195 * selected. Any further clicks will do nothing, unless you enable always
196 * select with elm_genlist_always_select_mode_set(). This means even if
197 * selected, every click will make the selected callbacks be called.
198 * elm_genlist_no_select_mode_set() will turn off the ability to select
199 * items entirely and they will neither appear selected nor call selected
200 * callback functions.
202 * Remember that you can create new styles and add your own theme augmentation
203 * per application with elm_theme_extension_add(). If you absolutely must
204 * have a specific style that overrides any theme the user or system sets up
205 * you can use elm_theme_overlay_add() to add such a file.
207 * @section Genlist_Implementation Implementation
209 * Evas tracks every object you create. Every time it processes an event
210 * (mouse move, down, up etc.) it needs to walk through objects and find out
211 * what event that affects. Even worse every time it renders display updates,
212 * in order to just calculate what to re-draw, it needs to walk through many
213 * many many objects. Thus, the more objects you keep active, the more
214 * overhead Evas has in just doing its work. It is advisable to keep your
215 * active objects to the minimum working set you need. Also remember that
216 * object creation and deletion carries an overhead, so there is a
217 * middle-ground, which is not easily determined. But don't keep massive lists
218 * of objects you can't see or use. Genlist does this with list objects. It
219 * creates and destroys them dynamically as you scroll around. It groups them
220 * into blocks so it can determine the visibility etc. of a whole block at
221 * once as opposed to having to walk the whole list. This 2-level list allows
222 * for very large numbers of items to be in the list (tests have used up to
223 * 2,000,000 items). Also genlist employs a queue for adding items. As items
224 * may be different sizes, every item added needs to be calculated as to its
225 * size and thus this presents a lot of overhead on populating the list, this
226 * genlist employs a queue. Any item added is queued and spooled off over
227 * time, actually appearing some time later, so if your list has many members
228 * you may find it takes a while for them to all appear, with your process
229 * consuming a lot of CPU while it is busy spooling.
231 * Genlist also implements a tree structure, but it does so with callbacks to
232 * the application, with the application filling in tree structures when
233 * requested (allowing for efficient building of a very deep tree that could
234 * even be used for file-management). See the above smart signal callbacks for
237 * @section Genlist_Smart_Events Genlist smart events
239 * Signals that you can add callbacks for are:
240 * - @c "activated" - The user has double-clicked or pressed
241 * (enter|return|spacebar) on an item. The @c event_info parameter is the
242 * item that was activated.
243 * - @c "clicked,double" - The user has double-clicked an item. The @c
244 * event_info parameter is the item that was double-clicked.
245 * - @c "selected" - This is called when a user has made an item selected.
246 * The event_info parameter is the genlist item that was selected.
247 * - @c "unselected" - This is called when a user has made an item
248 * unselected. The event_info parameter is the genlist item that was
250 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
251 * called and the item is now meant to be expanded. The event_info
252 * parameter is the genlist item that was indicated to expand. It is the
253 * job of this callback to then fill in the child items.
254 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
255 * called and the item is now meant to be contracted. The event_info
256 * parameter is the genlist item that was indicated to contract. It is the
257 * job of this callback to then delete the child items.
258 * - @c "expand,request" - This is called when a user has indicated they want
259 * to expand a tree branch item. The callback should decide if the item can
260 * expand (has any children) and then call elm_genlist_item_expanded_set()
261 * appropriately to set the state. The event_info parameter is the genlist
262 * item that was indicated to expand.
263 * - @c "contract,request" - This is called when a user has indicated they
264 * want to contract a tree branch item. The callback should decide if the
265 * item can contract (has any children) and then call
266 * elm_genlist_item_expanded_set() appropriately to set the state. The
267 * event_info parameter is the genlist item that was indicated to contract.
268 * - @c "realized" - This is called when the item in the list is created as a
269 * real evas object. event_info parameter is the genlist item that was
271 * - @c "unrealized" - This is called just before an item is unrealized.
272 * After this call content objects provided will be deleted and the item
273 * object itself delete or be put into a floating cache.
274 * - @c "drag,start,up" - This is called when the item in the list has been
275 * dragged (not scrolled) up.
276 * - @c "drag,start,down" - This is called when the item in the list has been
277 * dragged (not scrolled) down.
278 * - @c "drag,start,left" - This is called when the item in the list has been
279 * dragged (not scrolled) left.
280 * - @c "drag,start,right" - This is called when the item in the list has
281 * been dragged (not scrolled) right.
282 * - @c "drag,stop" - This is called when the item in the list has stopped
284 * - @c "drag" - This is called when the item in the list is being dragged.
285 * - @c "longpressed" - This is called when the item is pressed for a certain
286 * amount of time. By default it's 1 second. The event_info parameter is the
287 * longpressed genlist item.
288 * - @c "scroll,anim,start" - This is called when scrolling animation has
290 * - @c "scroll,anim,stop" - This is called when scrolling animation has
292 * - @c "scroll,drag,start" - This is called when dragging the content has
294 * - @c "scroll,drag,stop" - This is called when dragging the content has
296 * - @c "edge,top" - This is called when the genlist is scrolled until
298 * - @c "edge,bottom" - This is called when the genlist is scrolled
299 * until the bottom edge.
300 * - @c "edge,left" - This is called when the genlist is scrolled
301 * until the left edge.
302 * - @c "edge,right" - This is called when the genlist is scrolled
303 * until the right edge.
304 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
306 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
308 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
310 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
312 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
313 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
314 * multi-touch pinched in.
315 * - @c "swipe" - This is called when the genlist is swiped.
316 * - @c "moved" - This is called when a genlist item is moved.
317 * - @c "language,changed" - This is called when the program's language is
320 * Supported elm_object common APIs
321 * @li elm_object_signal_emit()
323 * Supported elm_object_item common APIs
324 * @li elm_object_item_part_content_get()
325 * @li elm_object_item_part_content_set()
326 * @li elm_object_item_part_content_unset()
327 * @li elm_object_item_part_text_set()
328 * @li elm_object_item_part_text_get()
329 * @li elm_object_item_disabled_set()
330 * @li elm_object_item_disabled_get()
332 * @section Genlist_Examples Examples
334 * Here is a list of examples that use the genlist, trying to show some of
336 * - @ref genlist_example_01
337 * - @ref genlist_example_02
338 * - @ref genlist_example_03
339 * - @ref genlist_example_04
340 * - @ref genlist_example_05
344 * @addtogroup Genlist
348 #define ELM_GENLIST_ITEM_CLASS_VERSION ELM_GEN_ITEM_CLASS_VERSION
349 #define ELM_GENLIST_ITEM_CLASS_HEADER ELM_GEN_ITEM_CLASS_HEADER
352 * Defines if the item is of any special type (has subitems or it's the
353 * index of a group), or is just a simple item.
359 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
360 //XXX: ELM_GENLIST_ITEM_TREE
361 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
362 ELM_GENLIST_ITEM_GROUP = (1 << 1), /**< index of a group of items */
364 ELM_GENLIST_ITEM_MAX = (1 << 2)
365 } Elm_Genlist_Item_Type;
369 ELM_GENLIST_ITEM_FIELD_ALL = 0,
370 ELM_GENLIST_ITEM_FIELD_TEXT = (1 << 0),
371 ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
372 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
373 } Elm_Genlist_Item_Field_Type;
377 ELM_GENLIST_ITEM_SCROLLTO_NONE = 0, /**< no scrollto */
378 ELM_GENLIST_ITEM_SCROLLTO_IN = (1 << 0), /**< show, bring in */
379 ELM_GENLIST_ITEM_SCROLLTO_TOP = (1 << 1), /**< top show, top bring in */
380 ELM_GENLIST_ITEM_SCROLLTO_MIDDLE = (1 << 2) /**< middle show, middle bring in */
381 } Elm_Genlist_Item_Scrollto_Type;
384 * @see Elm_Gen_Item_Class
386 typedef Elm_Gen_Item_Class Elm_Genlist_Item_Class;
389 * @see Elm_Gen_Item_Text_Get_Cb
391 typedef Elm_Gen_Item_Text_Get_Cb Elm_Genlist_Item_Text_Get_Cb;
394 * @see Elm_Gen_Item_Content_Get_Cb
396 typedef Elm_Gen_Item_Content_Get_Cb Elm_Genlist_Item_Content_Get_Cb;
399 * @see Elm_Gen_Item_State_Get_Cb
401 typedef Elm_Gen_Item_State_Get_Cb Elm_Genlist_Item_State_Get_Cb;
404 * @see Elm_Gen_Item_Del_Cb
406 typedef Elm_Gen_Item_Del_Cb Elm_Genlist_Item_Del_Cb;
409 * Add a new genlist widget to the given parent Elementary
412 * @param parent The parent object
413 * @return a new genlist widget handle or @c NULL, on errors
415 * This function inserts a new genlist widget on the canvas.
417 * @see elm_genlist_item_append()
418 * @see elm_object_item_del()
419 * @see elm_genlist_clear()
423 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent);
426 * Remove all items from a given genlist widget.
428 * @param obj The genlist object
430 * This removes (and deletes) all items in @p obj, leaving it empty.
432 * @see elm_object_item_del(), to remove just one item.
436 EAPI void elm_genlist_clear(Evas_Object *obj);
439 * Enable or disable multi-selection in the genlist
441 * @param obj The genlist object
442 * @param multi Multi-select enable/disable. Default is disabled.
444 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
445 * the list. This allows more than 1 item to be selected. To retrieve the list
446 * of selected items, use elm_genlist_selected_items_get().
448 * @see elm_genlist_selected_items_get()
449 * @see elm_genlist_multi_select_get()
453 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi);
456 * Gets if multi-selection in genlist is enabled or disabled.
458 * @param obj The genlist object
459 * @return Multi-select enabled/disabled
460 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
462 * @see elm_genlist_multi_select_set()
466 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj);
469 * This sets the horizontal stretching mode.
471 * @param obj The genlist object
472 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
474 * This sets the mode used for sizing items horizontally. Valid modes
475 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
476 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
477 * the scroller will scroll horizontally. Otherwise items are expanded
478 * to fill the width of the viewport of the scroller. If it is
479 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
480 * limited to that size.
482 * @see elm_genlist_mode_get()
486 EAPI void elm_genlist_mode_set(Evas_Object *obj, Elm_List_Mode mode);
489 * Gets the horizontal stretching mode.
491 * @param obj The genlist object
492 * @return The mode to use
493 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
495 * @see elm_genlist_mode_set()
499 EAPI Elm_List_Mode elm_genlist_mode_get(const Evas_Object *obj);
502 * Set the always select mode.
504 * @param obj The genlist object
505 * @param always_select The always select mode (@c EINA_TRUE = on, @c
506 * EINA_FALSE = off). Default is @c EINA_FALSE.
508 * Items will only call their selection func and callback when first
509 * becoming selected. Any further clicks will do nothing, unless you
510 * enable always select with elm_genlist_always_select_mode_set().
511 * This means that, even if selected, every click will make the selected
512 * callbacks be called.
514 * @see elm_genlist_always_select_mode_get()
518 //XXX: How about elm_genlist_select_mode_set() ?
519 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
522 * Get the always select mode.
524 * @param obj The genlist object
525 * @return The always select mode
526 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
528 * @see elm_genlist_always_select_mode_set()
532 //XXX: How about elm_genlist_select_mode_get() ?
533 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj);
536 * Enable/disable the no select mode.
538 * @param obj The genlist object
539 * @param no_select The no select mode
540 * (EINA_TRUE = on, EINA_FALSE = off)
542 * This will turn off the ability to select items entirely and they
543 * will neither appear selected nor call selected callback functions.
545 * @see elm_genlist_no_select_mode_get()
549 //XXX: elm_genlist_always_select_mode_set and elm_genlist_no_select_mode_set API could be merged to elm_genlist_select_mode_set()
550 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
553 * Gets whether the no select mode is enabled.
555 * @param obj The genlist object
556 * @return The no select mode
557 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
559 * @see elm_genlist_no_select_mode_set()
563 //XXX: elm_genlist_always_select_mode_get and elm_genlist_no_select_mode_get API could be merged to elm_genlist_select_mode_get()
564 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj);
567 * Enable/disable horizontal and vertical bouncing effect.
569 * @param obj The genlist object
570 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
571 * EINA_FALSE = off). Default is @c EINA_FALSE.
572 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
573 * EINA_FALSE = off). Default is @c EINA_TRUE.
575 * This will enable or disable the scroller bouncing effect for the
576 * genlist. See elm_scroller_bounce_set() for details.
578 * @see elm_scroller_bounce_set()
579 * @see elm_genlist_bounce_get()
583 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
586 * Get whether the horizontal and vertical bouncing effect is enabled.
588 * @param obj The genlist object
589 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
591 * @param v_bounce Pointer to a bool to receive if the bounce vertically
594 * @see elm_genlist_bounce_set()
598 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
601 * Append a new item in a given genlist widget.
603 * @param obj The genlist object
604 * @param itc The item class for the item
605 * @param data The item data
606 * @param parent The parent item, or NULL if none
607 * @param type Item type
608 * @param func Convenience function called when the item is selected
609 * @param func_data Data passed to @p func above.
610 * @return A handle to the item added or @c NULL if not possible
612 * This adds the given item to the end of the list or the end of
613 * the children list if the @p parent is given.
615 * @see elm_genlist_item_prepend()
616 * @see elm_genlist_item_insert_before()
617 * @see elm_genlist_item_insert_after()
618 * @see elm_object_item_del()
622 EAPI Elm_Object_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
625 * Prepend a new item in a given genlist widget.
627 * @param obj The genlist object
628 * @param itc The item class for the item
629 * @param data The item data
630 * @param parent The parent item, or NULL if none
631 * @param type Item type
632 * @param func Convenience function called when the item is selected
633 * @param func_data Data passed to @p func above.
634 * @return A handle to the item added or NULL if not possible
636 * This adds an item to the beginning of the list or beginning of the
637 * children of the parent if given.
639 * @see elm_genlist_item_append()
640 * @see elm_genlist_item_insert_before()
641 * @see elm_genlist_item_insert_after()
642 * @see elm_object_item_del()
646 EAPI Elm_Object_Item *elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
649 * Insert an item before another in a genlist widget
651 * @param obj The genlist object
652 * @param itc The item class for the item
653 * @param data The item data
654 * @param parent The parent item, or NULL if none
655 * @param before The item to place this new one before.
656 * @param type Item type
657 * @param func Convenience function called when the item is selected
658 * @param func_data Data passed to @p func above.
659 * @return A handle to the item added or @c NULL if not possible
661 * This inserts an item before another in the list. It will be in the
662 * same tree level or group as the item it is inserted before.
664 * @see elm_genlist_item_append()
665 * @see elm_genlist_item_prepend()
666 * @see elm_genlist_item_insert_after()
667 * @see elm_object_item_del()
671 EAPI Elm_Object_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *before, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
674 * Insert an item after another in a genlist widget
676 * @param obj The genlist object
677 * @param itc The item class for the item
678 * @param data The item data
679 * @param parent The parent item, or NULL if none
680 * @param after The item to place this new one after.
681 * @param type Item type
682 * @param func Convenience function called when the item is selected
683 * @param func_data Data passed to @p func above.
684 * @return A handle to the item added or @c NULL if not possible
686 * This inserts an item after another in the list. It will be in the
687 * same tree level or group as the item it is inserted after.
689 * @see elm_genlist_item_append()
690 * @see elm_genlist_item_prepend()
691 * @see elm_genlist_item_insert_before()
692 * @see elm_object_item_del()
696 EAPI Elm_Object_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *after, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
699 * Insert a new item into the sorted genlist object
701 * @param obj The genlist object
702 * @param itc The item class for the item
703 * @param data The item data
704 * @param parent The parent item, or NULL if none
705 * @param type Item type
706 * @param comp The function called for the sort
707 * @param func Convenience function called when item selected
708 * @param func_data Data passed to @p func above.
709 * @return A handle to the item added or NULL if not possible
711 * This inserts an item in the genlist based on user defined comparison
712 * function. The two arguments passed to the function @p func are genlist item
713 * handles to compare.
715 * @see elm_genlist_item_append()
716 * @see elm_genlist_item_prepend()
717 * @see elm_genlist_item_insert_after()
718 * @see elm_object_item_del()
722 EAPI Elm_Object_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
724 /* operations to retrieve existing items */
726 * Get the selected item in the genlist.
728 * @param obj The genlist object
729 * @return The selected item, or NULL if none is selected.
731 * This gets the selected item in the list (if multi-selection is enabled, only
732 * the item that was first selected in the list is returned - which is not very
733 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
736 * If no item is selected, NULL is returned.
738 * @see elm_genlist_selected_items_get()
742 EAPI Elm_Object_Item *elm_genlist_selected_item_get(const Evas_Object *obj);
745 * Get a list of selected items in the genlist.
747 * @param obj The genlist object
748 * @return The list of selected items, or NULL if none are selected.
750 * It returns a list of the selected items. This list pointer is only valid so
751 * long as the selection doesn't change (no items are selected or unselected, or
752 * unselected implicitly by deletion). The list contains genlist items
753 * pointers. The order of the items in this list is the order which they were
754 * selected, i.e. the first item in this list is the first item that was
755 * selected, and so on.
757 * @note If not in multi-select mode, consider using function
758 * elm_genlist_selected_item_get() instead.
760 * @see elm_genlist_multi_select_set()
761 * @see elm_genlist_selected_item_get()
765 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj);
768 * Get a list of realized items in genlist
770 * @param obj The genlist object
771 * @return The list of realized items, nor NULL if none are realized.
773 * This returns a list of the realized items in the genlist. The list
774 * contains genlist item pointers. The list must be freed by the
775 * caller when done with eina_list_free(). The item pointers in the
776 * list are only valid so long as those items are not deleted or the
777 * genlist is not deleted.
779 * @see elm_genlist_realized_items_update()
783 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj);
786 * Get the first item in the genlist
788 * This returns the first item in the list.
790 * @param obj The genlist object
791 * @return The first item, or NULL if none
795 EAPI Elm_Object_Item *elm_genlist_first_item_get(const Evas_Object *obj);
798 * Get the last item in the genlist
800 * This returns the last item in the list.
802 * @return The last item, or NULL if none
806 EAPI Elm_Object_Item *elm_genlist_last_item_get(const Evas_Object *obj);
809 * Set the scrollbar policy
811 * @param obj The genlist object
812 * @param policy_h Horizontal scrollbar policy.
813 * @param policy_v Vertical scrollbar policy.
815 * This sets the scrollbar visibility policy for the given genlist
816 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
817 * made visible if it is needed, and otherwise kept hidden.
818 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
819 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
820 * respectively for the horizontal and vertical scrollbars. Default is
821 * #ELM_SMART_SCROLLER_POLICY_AUTO
823 * @see elm_genlist_scroller_policy_get()
827 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
830 * Get the scrollbar policy
832 * @param obj The genlist object
833 * @param policy_h Pointer to store the horizontal scrollbar policy.
834 * @param policy_v Pointer to store the vertical scrollbar policy.
836 * @see elm_genlist_scroller_policy_set()
840 EAPI void elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
843 * Get the @b next item in a genlist widget's internal list of items,
844 * given a handle to one of those items.
846 * @param it The genlist item to fetch next from
847 * @return The item after @p item, or @c NULL if there's none (and
850 * This returns the item placed after the @p item, on the container
853 * @see elm_genlist_item_prev_get()
857 EAPI Elm_Object_Item *elm_genlist_item_next_get(const Elm_Object_Item *it);
860 * Get the @b previous item in a genlist widget's internal list of items,
861 * given a handle to one of those items.
863 * @param it The genlist item to fetch previous from
864 * @return The item before @p item, or @c NULL if there's none (and
867 * This returns the item placed before the @p item, on the container
870 * @see elm_genlist_item_next_get()
874 EAPI Elm_Object_Item *elm_genlist_item_prev_get(const Elm_Object_Item *it);
877 * Set whether a given genlist item is selected or not
880 * @param selected Use @c EINA_TRUE, to make it selected, @c
881 * EINA_FALSE to make it unselected
883 * This sets the selected state of an item. If multi selection is
884 * not enabled on the containing genlist and @p selected is @c
885 * EINA_TRUE, any other previously selected items will get
886 * unselected in favor of this new one.
888 * @see elm_genlist_item_selected_get()
892 EAPI void elm_genlist_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
895 * Get whether a given genlist item is selected or not
898 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
900 * @see elm_genlist_item_selected_set() for more details
904 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Object_Item *it);
907 * Show the portion of a genlist's internal list containing a given
910 * @param it The item to display
911 * @param type The position to bring in, the given item to.
912 * @ref Elm_Genlist_Item_Scrollto_Type
914 * This causes genlist to jump to the given item @p it and show it (by
915 * jumping to that position), if it is not fully visible.
917 * @see elm_genlist_item_bring_in()
921 EAPI void elm_genlist_item_show(Elm_Object_Item *it, Elm_Genlist_Item_Scrollto_Type type);
924 * Animatedly bring in, to the visible are of a genlist, a given
927 * @param it The item to display
928 * @param type The position to bring in, the given item to.
929 * @ref Elm_Genlist_Item_Scrollto_Type
931 * This causes genlist to jump to the given item @p it and show it (by
932 * animatedly scrolling), if it is not fully visible.
933 * This may use animation and take a some time to do so.
935 * @see elm_genlist_item_show()
939 EAPI void elm_genlist_item_bring_in(Elm_Object_Item *it, Elm_Genlist_Item_Scrollto_Type type);
942 * Update the contents of an item
946 * This updates an item by calling all the item class functions again
947 * to get the contents, texts and states. Use this when the original
948 * item data has changed and the changes are desired to be reflected.
950 * Use elm_genlist_realized_items_update() to update all already realized
953 * @see elm_genlist_realized_items_update()
957 EAPI void elm_genlist_item_update(Elm_Object_Item *it);
960 * Update the item class of an item
963 * @param itc The item class for the item
965 * This sets another class of the item, changing the way that it is
966 * displayed. After changing the item class, elm_genlist_item_update() is
967 * called on the item @p it.
971 EAPI void elm_genlist_item_item_class_update(Elm_Object_Item *it, const Elm_Genlist_Item_Class *itc);
974 * Get the Genlist Item class for the given Genlist Item.
976 * @param it The genlist item
978 * This returns the Genlist_Item_Class for the given item. It can be used to
979 * examine the function pointers and item_style.
983 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Object_Item *it);
986 * Get the index of the item. It is only valid once displayed.
988 * @param it a genlist item
989 * @return the position inside the list of item.
993 EAPI int elm_genlist_item_index_get(const Elm_Object_Item *it);
996 * Update the contents of all realized items.
998 * @param obj The genlist object.
1000 * This updates all realized items by calling all the item class functions again
1001 * to get the contents, texts and states. Use this when the original
1002 * item data has changed and the changes are desired to be reflected.
1004 * To update just one item, use elm_genlist_item_update().
1006 * @see elm_genlist_realized_items_get()
1007 * @see elm_genlist_item_update()
1011 EAPI void elm_genlist_realized_items_update(Evas_Object *obj);
1014 * Return how many items are currently in a list
1016 * @param obj The list
1017 * @return The total number of list items in the list
1019 * This behavior is O(1) and includes items which may or may not be realized.
1023 EAPI unsigned int elm_genlist_items_count(const Evas_Object *obj);
1026 * Add a new genlist item class in a given genlist widget.
1028 * @return New allocated a genlist item class.
1030 * This adds genlist item class for the genlist widget. When adding a item,
1031 * genlist_item_{append, prepend, insert} function needs item class of the item.
1032 * Given callback parameters are used at retrieving {text, content} of
1033 * added item. Set as NULL if it's not used.
1034 * If there's no available memory, return can be NULL.
1036 * @see elm_genlist_item_class_free()
1037 * @see elm_genlist_item_append()
1041 EAPI Elm_Genlist_Item_Class *elm_genlist_item_class_new(void);
1044 * Remove a item class in a given genlist widget.
1046 * @param itc The itc to be removed.
1048 * This removes item class from the genlist widget.
1049 * Whenever it has no more references to it, item class is going to be freed.
1050 * Otherwise it just decreases its reference count.
1052 * @see elm_genlist_item_class_new()
1053 * @see elm_genlist_item_class_ref()
1054 * @see elm_genlist_item_class_unref()
1058 EAPI void elm_genlist_item_class_free(Elm_Genlist_Item_Class *itc);
1061 * Increments object reference count for the item class.
1063 * @param itc The given item class object to reference
1065 * This API just increases its reference count for item class management.
1067 * @see elm_genlist_item_class_unref()
1071 EAPI void elm_genlist_item_class_ref(Elm_Genlist_Item_Class *itc);
1074 * Decrements object reference count for the item class.
1076 * @param itc The given item class object to reference
1078 * This API just decreases its reference count for item class management.
1079 * Reference count can't be less than 0.
1081 * @see elm_genlist_item_class_ref()
1082 * @see elm_genlist_item_class_free()
1086 EAPI void elm_genlist_item_class_unref(Elm_Genlist_Item_Class *itc);
1090 //XXX: Need to review tooltip & cursor APIs
1093 * Set the text to be shown in a given genlist item's tooltips.
1095 * @param it The genlist item
1096 * @param text The text to set in the content
1098 * This call will setup the text to be used as tooltip to that item
1099 * (analogous to elm_object_tooltip_text_set(), but being item
1100 * tooltips with higher precedence than object tooltips). It can
1101 * have only one tooltip at a time, so any previous tooltip data
1104 * In order to set a content or something else as a tooltip, look at
1105 * elm_genlist_item_tooltip_content_cb_set().
1109 EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
1112 * Set the content to be shown in a given genlist item's tooltips
1114 * @param it The genlist item.
1115 * @param func The function returning the tooltip contents.
1116 * @param data What to provide to @a func as callback data/context.
1117 * @param del_cb Called when data is not needed anymore, either when
1118 * another callback replaces @p func, the tooltip is unset with
1119 * elm_genlist_item_tooltip_unset() or the owner @p item
1120 * dies. This callback receives as its first parameter the
1121 * given @p data, being @c event_info the item handle.
1123 * This call will setup the tooltip's contents to @p item
1124 * (analogous to elm_object_tooltip_content_cb_set(), but being
1125 * item tooltips with higher precedence than object tooltips). It
1126 * can have only one tooltip at a time, so any previous tooltip
1127 * content will get removed. @p func (with @p data) will be called
1128 * every time Elementary needs to show the tooltip and it should
1129 * return a valid Evas object, which will be fully managed by the
1130 * tooltip system, getting deleted when the tooltip is gone.
1132 * In order to set just a text as a tooltip, look at
1133 * elm_genlist_item_tooltip_text_set().
1137 EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
1140 * Unset a tooltip from a given genlist item
1142 * @param it genlist item to remove a previously set tooltip from.
1144 * This call removes any tooltip set on @p item. The callback
1145 * provided as @c del_cb to
1146 * elm_genlist_item_tooltip_content_cb_set() will be called to
1147 * notify it is not used anymore (and have resources cleaned, if
1150 * @see elm_genlist_item_tooltip_content_cb_set()
1154 EAPI void elm_genlist_item_tooltip_unset(Elm_Object_Item *it);
1157 * Set a different @b style for a given genlist item's tooltip.
1159 * @param it genlist item with tooltip set
1160 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
1161 * "default", @c "transparent", etc)
1163 * Tooltips can have <b>alternate styles</b> to be displayed on,
1164 * which are defined by the theme set on Elementary. This function
1165 * works analogously as elm_object_tooltip_style_set(), but here
1166 * applied only to genlist item objects. The default style for
1167 * tooltips is @c "default".
1169 * @note before you set a style you should define a tooltip with
1170 * elm_genlist_item_tooltip_content_cb_set() or
1171 * elm_genlist_item_tooltip_text_set()
1173 * @see elm_genlist_item_tooltip_style_get()
1177 EAPI void elm_genlist_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
1180 * Get the style set a given genlist item's tooltip.
1182 * @param it genlist item with tooltip already set on.
1183 * @return style the theme style in use, which defaults to
1184 * "default". If the object does not have a tooltip set,
1185 * then @c NULL is returned.
1187 * @see elm_genlist_item_tooltip_style_set() for more details
1191 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Object_Item *it);
1194 * @brief Disable size restrictions on an object's tooltip
1195 * @param it The tooltip's anchor object
1196 * @param disable If EINA_TRUE, size restrictions are disabled
1197 * @return EINA_FALSE on failure, EINA_TRUE on success
1199 * This function allows a tooltip to expand beyond its parent window's canvas.
1200 * It will instead be limited only by the size of the display.
1202 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
1205 * @brief Retrieve size restriction state of an object's tooltip
1206 * @param it The tooltip's anchor object
1207 * @return If EINA_TRUE, size restrictions are disabled
1209 * This function returns whether a tooltip is allowed to expand beyond
1210 * its parent window's canvas.
1211 * It will instead be limited only by the size of the display.
1213 EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Object_Item *it);
1216 * Set the type of mouse pointer/cursor decoration to be shown,
1217 * when the mouse pointer is over the given genlist widget item
1219 * @param it genlist item to customize cursor on
1220 * @param cursor the cursor type's name
1222 * This function works analogously as elm_object_cursor_set(), but
1223 * here the cursor's changing area is restricted to the item's
1224 * area, and not the whole widget's. Note that that item cursors
1225 * have precedence over widget cursors, so that a mouse over @p
1226 * item will always show cursor @p type.
1228 * If this function is called twice for an object, a previously set
1229 * cursor will be unset on the second call.
1231 * @see elm_object_cursor_set()
1232 * @see elm_genlist_item_cursor_get()
1233 * @see elm_genlist_item_cursor_unset()
1237 EAPI void elm_genlist_item_cursor_set(Elm_Object_Item *it, const char *cursor);
1240 * Get the type of mouse pointer/cursor decoration set to be shown,
1241 * when the mouse pointer is over the given genlist widget item
1243 * @param it genlist item with custom cursor set
1244 * @return the cursor type's name or @c NULL, if no custom cursors
1245 * were set to @p item (and on errors)
1247 * @see elm_object_cursor_get()
1248 * @see elm_genlist_item_cursor_set() for more details
1249 * @see elm_genlist_item_cursor_unset()
1253 EAPI const char *elm_genlist_item_cursor_get(const Elm_Object_Item *it);
1256 * Unset any custom mouse pointer/cursor decoration set to be
1257 * shown, when the mouse pointer is over the given genlist widget
1258 * item, thus making it show the @b default cursor again.
1260 * @param it a genlist item
1262 * Use this call to undo any custom settings on this item's cursor
1263 * decoration, bringing it back to defaults (no custom style set).
1265 * @see elm_object_cursor_unset()
1266 * @see elm_genlist_item_cursor_set() for more details
1270 EAPI void elm_genlist_item_cursor_unset(Elm_Object_Item *it);
1273 * Set a different @b style for a given custom cursor set for a
1276 * @param it genlist item with custom cursor set
1277 * @param style the <b>theme style</b> to use (e.g. @c "default",
1278 * @c "transparent", etc)
1280 * This function only makes sense when one is using custom mouse
1281 * cursor decorations <b>defined in a theme file</b> , which can
1282 * have, given a cursor name/type, <b>alternate styles</b> on
1283 * it. It works analogously as elm_object_cursor_style_set(), but
1284 * here applied only to genlist item objects.
1286 * @warning Before you set a cursor style you should have defined a
1287 * custom cursor previously on the item, with
1288 * elm_genlist_item_cursor_set()
1290 * @see elm_genlist_item_cursor_engine_only_set()
1291 * @see elm_genlist_item_cursor_style_get()
1295 EAPI void elm_genlist_item_cursor_style_set(Elm_Object_Item *it, const char *style);
1298 * Get the current @b style set for a given genlist item's custom
1301 * @param it genlist item with custom cursor set.
1302 * @return style the cursor style in use. If the object does not
1303 * have a cursor set, then @c NULL is returned.
1305 * @see elm_genlist_item_cursor_style_set() for more details
1309 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Object_Item *it);
1312 * Set if the (custom) cursor for a given genlist item should be
1313 * searched in its theme, also, or should only rely on the
1316 * @param it item with custom (custom) cursor already set on
1317 * @param engine_only Use @c EINA_TRUE to have cursors looked for
1318 * only on those provided by the rendering engine, @c EINA_FALSE to
1319 * have them searched on the widget's theme, as well.
1321 * @note This call is of use only if you've set a custom cursor
1322 * for genlist items, with elm_genlist_item_cursor_set().
1324 * @note By default, cursors will only be looked for between those
1325 * provided by the rendering engine.
1329 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
1332 * Get if the (custom) cursor for a given genlist item is being
1333 * searched in its theme, also, or is only relying on the rendering
1336 * @param it a genlist item
1337 * @return @c EINA_TRUE, if cursors are being looked for only on
1338 * those provided by the rendering engine, @c EINA_FALSE if they
1339 * are being searched on the widget's theme, as well.
1341 * @see elm_genlist_item_cursor_engine_only_set(), for more details
1345 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Object_Item *it);
1348 * Enable/disable compress mode.
1350 * @param obj The genlist object
1351 * @param compress The compress mode
1352 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
1354 * This will enable the compress mode where items are "compressed"
1355 * horizontally to fit the genlist scrollable viewport width. This is
1356 * special for genlist. Do not rely on
1357 * elm_genlist_mode_set() being set to @c ELM_LIST_COMPRESS to
1358 * work as genlist needs to handle it specially.
1360 * @see elm_genlist_compress_mode_get()
1364 // XXX: kill this. elm_genlist_height_for_width_mode_set() covers this.
1365 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress);
1368 * Get whether the compress mode is enabled.
1370 * @param obj The genlist object
1371 * @return The compress mode
1372 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
1374 * @see elm_genlist_compress_mode_set()
1378 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj);
1381 * Enable/disable height-for-width mode.
1383 * @param obj The genlist object
1384 * @param height_for_width The height-for-width mode (@c EINA_TRUE = on,
1385 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
1387 * With height-for-width mode the item width will be fixed (restricted
1388 * to a minimum of) to the list width when calculating its size in
1389 * order to allow the height to be calculated based on it. This allows,
1390 * for instance, text block to wrap lines if the Edje part is
1391 * configured with "text.min: 0 1".
1393 * @note This mode will make list resize slower as it will have to
1394 * recalculate every item height again whenever the list width
1397 * @note When height-for-width mode is enabled, it also enables
1398 * compress mode (see elm_genlist_compress_mode_set()) and
1399 * disables homogeneous (see elm_genlist_homogeneous_set()).
1404 //XXX: API name is ambiguous.. How about elm_genlist_mode_fixed_width_set?
1405 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width);
1408 * Get whether the height-for-width mode is enabled.
1410 * @param obj The genlist object
1411 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
1416 //XXX: API name is ambiguous elm_genlist_mode_fixed_width_get() ?????
1417 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj);
1420 * Enable/disable homogeneous mode.
1422 * @param obj The genlist object
1423 * @param homogeneous Assume the items within the genlist are of the
1424 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
1427 * This will enable the homogeneous mode where items are of the same
1428 * height and width so that genlist may do the lazy-loading at its
1429 * maximum (which increases the performance for scrolling the list). This
1430 * implies 'compressed' mode.
1432 * @see elm_genlist_compress_mode_set()
1433 * @see elm_genlist_homogeneous_get()
1437 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous);
1440 * Get whether the homogeneous mode is enabled.
1442 * @param obj The genlist object
1443 * @return Assume the items within the genlist are of the same height
1444 * and width (EINA_TRUE = on, EINA_FALSE = off)
1446 * @see elm_genlist_homogeneous_set()
1450 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj);
1453 * Set the maximum number of items within an item block
1455 * @param obj The genlist object
1456 * @param count Maximum number of items within an item block. Default is 32.
1458 * This will configure the block count to tune to the target with particular
1459 * performance matrix.
1461 * A block of objects will be used to reduce the number of operations due to
1462 * many objects in the screen. It can determine the visibility, or if the
1463 * object has changed, it theme needs to be updated, etc. doing this kind of
1464 * calculation to the entire block, instead of per object.
1466 * The default value for the block count is enough for most lists, so unless
1467 * you know you will have a lot of objects visible in the screen at the same
1468 * time, don't try to change this.
1470 * @see elm_genlist_block_count_get()
1471 * @see @ref Genlist_Implementation
1475 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int count);
1478 * Get the maximum number of items within an item block
1480 * @param obj The genlist object
1481 * @return Maximum number of items within an item block
1483 * @see elm_genlist_block_count_set()
1487 EAPI int elm_genlist_block_count_get(const Evas_Object *obj);
1490 * Set the timeout in seconds for the longpress event.
1492 * @param obj The genlist object
1493 * @param timeout timeout in seconds. Default is elm config value(1.0)
1495 * This option will change how long it takes to send an event "longpressed"
1496 * after the mouse down signal is sent to the list. If this event occurs, no
1497 * "clicked" event will be sent.
1499 * @warning If you set the longpress timeout value with this API, your genlist
1500 * will not be affected by the longpress value of elementary config value
1503 * @see elm_genlist_longpress_timeout_set()
1507 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout);
1510 * Get the timeout in seconds for the longpress event.
1512 * @param obj The genlist object
1513 * @return timeout in seconds
1515 * @see elm_genlist_longpress_timeout_get()
1519 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj);
1522 * Get the item that is at the x, y canvas coords.
1524 * @param obj The genlist object.
1525 * @param x The input x coordinate
1526 * @param y The input y coordinate
1527 * @param posret The position relative to the item returned here
1528 * @return The item at the coordinates or NULL if none
1530 * This returns the item at the given coordinates (which are canvas
1531 * relative, not object-relative). If an item is at that coordinate,
1532 * that item handle is returned, and if @p posret is not NULL, the
1533 * integer pointed to is set to a value of -1, 0 or 1, depending if
1534 * the coordinate is on the upper portion of that item (-1), on the
1535 * middle section (0) or on the lower part (1). If NULL is returned as
1536 * an item (no item found there), then posret may indicate -1 or 1
1537 * based if the coordinate is above or below all items respectively in
1542 EAPI Elm_Object_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret);
1545 * Get the parent item of the given item
1547 * @param it The item
1548 * @return The parent of the item or @c NULL if it has no parent.
1550 * This returns the item that was specified as parent of the item @p it on
1551 * elm_genlist_item_append() and insertion related functions.
1555 EAPI Elm_Object_Item *elm_genlist_item_parent_get(const Elm_Object_Item *it);
1558 * Remove all sub-items (children) of the given item
1560 * @param it The item
1562 * This removes all items that are children (and their descendants) of the
1565 * @see elm_genlist_clear()
1566 * @see elm_object_item_del()
1570 EAPI void elm_genlist_item_subitems_clear(Elm_Object_Item *it);
1573 * Sets the expanded state of an item.
1575 * @param it The item
1576 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
1578 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
1581 * The theme will respond to this change visually, and a signal "expanded" or
1582 * "contracted" will be sent from the genlist with a pointer to the item that
1583 * has been expanded/contracted.
1585 * Calling this function won't show or hide any child of this item (if it is
1586 * a parent). You must manually delete and create them on the callbacks of
1587 * the "expanded" or "contracted" signals.
1589 * @see elm_genlist_item_expanded_get()
1593 EAPI void elm_genlist_item_expanded_set(Elm_Object_Item *it, Eina_Bool expanded);
1596 * Get the expanded state of an item
1598 * @param it The item
1599 * @return The expanded state
1601 * This gets the expanded state of an item.
1603 * @see elm_genlist_item_expanded_set()
1607 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Object_Item *it);
1610 * Get the depth of expanded item
1612 * @param it The genlist item object
1613 * @return The depth of expanded item
1617 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Object_Item *it);
1620 * Sets the display only state of an item.
1622 * @param it The item
1623 * @param display_only @c EINA_TRUE if the item is display only, @c
1624 * EINA_FALSE otherwise.
1626 * A display only item cannot be selected or unselected. It is for
1627 * display only and not selecting or otherwise clicking, dragging
1628 * etc. by the user, thus finger size rules will not be applied to
1631 * It's good to set group index items to display only state.
1633 * @see elm_genlist_item_display_only_get()
1637 //XXX: elm_genlist_item_no_select_mode_set()?
1638 EAPI void elm_genlist_item_display_only_set(Elm_Object_Item *it, Eina_Bool display_only);
1641 * Get the display only state of an item
1643 * @param it The item
1644 * @return @c EINA_TRUE if the item is display only, @c
1645 * EINA_FALSE otherwise.
1647 * @see elm_genlist_item_display_only_set()
1651 //XXX: elm_genlist_item_no_select_mode_get()?
1652 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Object_Item *it);
1655 * Unset all contents fetched by the item class
1657 * @param it The item
1658 * @param l The contents list to return
1660 * This instructs genlist to release references to contents in the item,
1661 * meaning that they will no longer be managed by genlist and are
1662 * floating "orphans" that can be re-used elsewhere if the user wants
1667 EAPI void elm_genlist_item_all_contents_unset(Elm_Object_Item *it, Eina_List **l);
1670 * Promote an item to the top of the list
1672 * @param it The item
1676 EAPI void elm_genlist_item_promote(Elm_Object_Item *it);
1679 * Demote an item to the end of the list
1681 * @param it The item
1685 EAPI void elm_genlist_item_demote(Elm_Object_Item *it);
1688 * Update the part of an item
1690 * @param it The item
1691 * @param parts The name of item's part
1692 * @param itf The type of item's part type
1694 * This updates an item's part by calling item's fetching functions again
1695 * to get the contents, texts and states. Use this when the original
1696 * item data has changed and the changes are desired to be reflected.
1697 * Second parts argument is used for globbing to match '*', '?', and '.'
1698 * It can be used at updating multi fields.
1700 * Use elm_genlist_realized_items_update() to update an item's all
1703 * @see elm_genlist_item_update()
1707 EAPI void elm_genlist_item_fields_update(Elm_Object_Item *it, const char *parts, Elm_Genlist_Item_Field_Type itf);
1710 * Activate a genlist mode on an item
1712 * @param it The genlist item
1713 * @param mode_type Mode name
1714 * @param mode_set Boolean to define set or unset mode.
1716 * A genlist mode is a different way of selecting an item. Once a mode is
1717 * activated on an item, any other selected item is immediately unselected.
1718 * This feature provides an easy way of implementing a new kind of animation
1719 * for selecting an item, without having to entirely rewrite the item style
1720 * theme. However, the elm_genlist_selected_* API can't be used to get what
1721 * item is activate for a mode.
1723 * The current item style will still be used, but applying a genlist mode to
1724 * an item will select it using a different kind of animation.
1726 * The current active item for a mode can be found by
1727 * elm_genlist_mode_item_get().
1729 * The characteristics of genlist mode are:
1730 * - Only one mode can be active at any time, and for only one item.
1731 * - Genlist handles deactivating other items when one item is activated.
1732 * - A mode is defined in the genlist theme (edc), and more modes can easily
1734 * - A mode style and the genlist item style are different things. They
1735 * can be combined to provide a default style to the item, with some kind
1736 * of animation for that item when the mode is activated.
1738 * When a mode is activated on an item, a new view for that item is created.
1739 * The theme of this mode defines the animation that will be used to transit
1740 * the item from the old view to the new view. This second (new) view will be
1741 * active for that item while the mode is active on the item, and will be
1742 * destroyed after the mode is totally deactivated from that item.
1744 * @see elm_genlist_mode_get()
1745 * @see elm_genlist_mode_item_get()
1749 //XXX: How bout elm_genlist_effect_mode_set
1750 EAPI void elm_genlist_item_mode_set(Elm_Object_Item *it, const char *mode_type, Eina_Bool mode_set);
1753 * Get the last (or current) genlist mode used.
1755 * @param obj The genlist object
1757 * This function just returns the name of the last used genlist mode. It will
1758 * be the current mode if it's still active.
1760 * @see elm_genlist_item_mode_set()
1761 * @see elm_genlist_mode_item_get()
1765 //XXX: looks weird... set the mode type to item and get the mode type from object...
1766 EAPI const char *elm_genlist_mode_type_get(const Evas_Object *obj);
1769 * Get active genlist mode item
1771 * @param obj The genlist object
1772 * @return The active item for that current mode. Or @c NULL if no item is
1773 * activated with any mode.
1775 * This function returns the item that was activated with a mode, by the
1776 * function elm_genlist_item_mode_set().
1778 * @see elm_genlist_item_mode_set()
1779 * @see elm_genlist_mode_get()
1783 EAPI const Elm_Object_Item *elm_genlist_mode_item_get(const Evas_Object *obj);
1788 * @param obj The genlist object
1789 * @param reorder_mode The reorder mode
1790 * (EINA_TRUE = on, EINA_FALSE = off)
1794 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode);
1797 * Get the reorder mode
1799 * @param obj The genlist object
1800 * @return The reorder mode
1801 * (EINA_TRUE = on, EINA_FALSE = off)
1805 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj);
1808 * Get the Item's Type
1810 * @param it The genlist item
1811 * @return The item type.
1813 * This function returns the item's type. Normally the item's type.
1814 * If it failed, return value is ELM_GENLIST_ITEM_MAX
1818 EAPI Elm_Genlist_Item_Type elm_genlist_item_type_get(const Elm_Object_Item *it);
1821 * Set Genlist edit mode
1823 * This sets Genlist edit mode.
1825 * @param obj The Genlist object
1826 * @param The edit mode status
1827 * (EINA_TRUE = edit mode, EINA_FALSE = normal mode
1831 //XXX: elm_genlist_effect_mode_set();
1832 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode);
1835 * Get Genlist edit mode
1837 * @param obj The genlist object
1838 * @return The edit mode status
1839 * (EINA_TRUE = edit mode, EINA_FALSE = normal mode
1843 //XXX: elm_genlist_all_items_effect_mode_get();
1844 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj);
1847 * Set the flip state of a given genlist item.
1849 * @param it The genlist item object
1850 * @param flip The flip mode
1851 * (EINA_TRUE = on, EINA_FALSE = off)
1853 * This function sets the flip state of a given genlist item.
1854 * Flip mode overrides current item object.
1855 * It can be used for on-the-fly item replace.
1856 * Flip mode can be used with/without edit mode.
1858 * @see elm_genlist_item_flip_get()
1863 EAPI void elm_genlist_item_flip_set(Elm_Object_Item *it, Eina_Bool flip);
1866 * Get the flip state of a given genlist item.
1868 * @param it The genlist item object
1870 * This function returns the flip state of a given genlist item.
1871 * If the parameter is invalid, it returns EINA_FALSE.
1873 * @see elm_genlist_item_flip_set()
1878 EAPI Eina_Bool elm_genlist_item_flip_get(const Elm_Object_Item *it);