1 // XXX: elm_gengrid - make sure api's match 1:1 with genlist api's
2 // for eventual move to back-end of gengrid == genlist (in grid mode)
4 * @defgroup Gengrid Gengrid (Generic grid)
6 * This widget aims to position objects in a grid layout while
7 * actually creating and rendering only the visible ones, using the
8 * same idea as the @ref Genlist "genlist": the user defines a @b
9 * class for each item, specifying functions that will be called at
10 * object creation, deletion, etc. When those items are selected by
11 * the user, a callback function is issued. Users may interact with
12 * a gengrid via the mouse (by clicking on items to select them and
13 * clicking on the grid's viewport and swiping to pan the whole
14 * view) or via the keyboard, navigating through item with the
17 * @section Gengrid_Layouts Gengrid layouts
19 * Gengrid may layout its items in one of two possible layouts:
23 * When in "horizontal mode", items will be placed in @b columns,
24 * from top to bottom and, when the space for a column is filled,
25 * another one is started on the right, thus expanding the grid
26 * horizontally, making for horizontal scrolling. When in "vertical
27 * mode" , though, items will be placed in @b rows, from left to
28 * right and, when the space for a row is filled, another one is
29 * started below, thus expanding the grid vertically (and making
30 * for vertical scrolling).
32 * @section Gengrid_Items Gengrid items
34 * An item in a gengrid can have 0 or more texts (they can be
35 * regular text or textblock Evas objects - that's up to the style
36 * to determine), 0 or more contents (which are simply objects
37 * swallowed into the gengrid item's theming Edje object) and 0 or
38 * more <b>boolean states</b>, which have the behavior left to the
39 * user to define. The Edje part names for each of these properties
40 * will be looked up, in the theme file for the gengrid, under the
41 * Edje (string) data items named @c "texts", @c "contents" and @c
42 * "states", respectively. For each of those properties, if more
43 * than one part is provided, they must have names listed separated
44 * by spaces in the data fields. For the default gengrid item
45 * theme, we have @b one text part (@c "elm.text"), @b two content
46 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
49 * A gengrid item may be at one of several styles. Elementary
50 * provides one by default - "default", but this can be extended by
51 * system or application custom themes/overlays/extensions (see
52 * @ref Theme "themes" for more details).
54 * @section Gengrid_Item_Class Gengrid item classes
56 * In order to have the ability to add and delete items on the fly,
57 * gengrid implements a class (callback) system where the
58 * application provides a structure with information about that
59 * type of item (gengrid may contain multiple different items with
60 * different classes, states and styles). Gengrid will call the
61 * functions in this struct (methods) when an item is "realized"
62 * (i.e., created dynamically, while the user is scrolling the
63 * grid). All objects will simply be deleted when no longer needed
64 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
65 * contains the following members:
66 * - @c item_style - This is a constant string and simply defines
67 * the name of the item style. It @b must be specified and the
68 * default should be @c "default".
69 * - @c func.text_get - This function is called when an item
70 * object is actually created. The @c data parameter will point to
71 * the same data passed to elm_gengrid_item_append() and related
72 * item creation functions. The @c obj parameter is the gengrid
73 * object itself, while the @c part one is the name string of one
74 * of the existing text parts in the Edje group implementing the
75 * item's theme. This function @b must return a strdup'()ed string,
76 * as the caller will free() it when done. See
77 * #Elm_Gengrid_Item_Text_Get_Cb.
78 * - @c func.content_get - This function is called when an item object
79 * is actually created. The @c data parameter will point to the
80 * same data passed to elm_gengrid_item_append() and related item
81 * creation functions. The @c obj parameter is the gengrid object
82 * itself, while the @c part one is the name string of one of the
83 * existing (content) swallow parts in the Edje group implementing the
84 * item's theme. It must return @c NULL, when no content is desired,
85 * or a valid object handle, otherwise. The object will be deleted
86 * by the gengrid on its deletion or when the item is "unrealized".
87 * See #Elm_Gengrid_Item_Content_Get_Cb.
88 * - @c func.state_get - This function is called when an item
89 * object is actually created. The @c data parameter will point to
90 * the same data passed to elm_gengrid_item_append() and related
91 * item creation functions. The @c obj parameter is the gengrid
92 * object itself, while the @c part one is the name string of one
93 * of the state parts in the Edje group implementing the item's
94 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
95 * true/on. Gengrids will emit a signal to its theming Edje object
96 * with @c "elm,state,xxx,active" and @c "elm" as "emission" and
97 * "source" arguments, respectively, when the state is true (the
98 * default is false), where @c xxx is the name of the (state) part.
99 * See #Elm_Gengrid_Item_State_Get_Cb.
100 * - @c func.del - This is called when elm_object_item_del() is
101 * called on an item or elm_gengrid_clear() is called on the
102 * gengrid. This is intended for use when gengrid items are
103 * deleted, so any data attached to the item (e.g. its data
104 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
106 * @section Gengrid_Usage_Hints Usage hints
108 * If the user wants to have multiple items selected at the same
109 * time, elm_gengrid_multi_select_set() will permit it. If the
110 * gengrid is single-selection only (the default), then
111 * elm_gengrid_select_item_get() will return the selected item or
112 * @c NULL, if none is selected. If the gengrid is under
113 * multi-selection, then elm_gengrid_selected_items_get() will
114 * return a list (that is only valid as long as no items are
115 * modified (added, deleted, selected or unselected) of child items
118 * If an item changes (internal (boolean) state, text or content
119 * changes), then use elm_gengrid_item_update() to have gengrid
120 * update the item with the new state. A gengrid will re-"realize"
121 * the item, thus calling the functions in the
122 * #Elm_Gengrid_Item_Class set for that item.
124 * To programmatically (un)select an item, use
125 * elm_gengrid_item_selected_set(). To get its selected state use
126 * elm_gengrid_item_selected_get(). To make an item disabled
127 * (unable to be selected and appear differently) use
128 * elm_object_item_disabled_set() to set this and
129 * elm_object_item_disabled_get() to get the disabled state.
131 * Grid cells will only have their selection smart callbacks called
132 * when firstly getting selected. Any further clicks will do
133 * nothing, unless you enable the "always select mode", with
134 * elm_gengrid_always_select_mode_set(), thus making every click to
135 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
136 * turn off the ability to select items entirely in the widget and
137 * they will neither appear selected nor call the selection smart
140 * Remember that you can create new styles and add your own theme
141 * augmentation per application with elm_theme_extension_add(). If
142 * you absolutely must have a specific style that overrides any
143 * theme the user or system sets up you can use
144 * elm_theme_overlay_add() to add such a file.
146 * @section Gengrid_Smart_Events Gengrid smart events
148 * Smart events that you can add callbacks for are:
149 * - @c "activated" - The user has double-clicked or pressed
150 * (enter|return|spacebar) on an item. The @c event_info parameter
151 * is the gengrid item that was activated.
152 * - @c "clicked,double" - The user has double-clicked an item.
153 * The @c event_info parameter is the gengrid item that was double-clicked.
154 * - @c "longpressed" - This is called when the item is pressed for a certain
155 * amount of time. By default it's 1 second.
156 * - @c "selected" - The user has made an item selected. The
157 * @c event_info parameter is the gengrid item that was selected.
158 * - @c "unselected" - The user has made an item unselected. The
159 * @c event_info parameter is the gengrid item that was unselected.
160 * - @c "realized" - This is called when the item in the gengrid
161 * has its implementing Evas object instantiated, de facto. @c
162 * event_info is the gengrid item that was created. The object
163 * may be deleted at any time, so it is highly advised to the
164 * caller @b not to use the object pointer returned from
165 * elm_gengrid_item_object_get(), because it may point to freed
167 * - @c "unrealized" - This is called when the implementing Evas
168 * object for this item is deleted. @c event_info is the gengrid
169 * item that was deleted.
170 * - @c "changed" - Called when an item is added, removed, resized
171 * or moved and when the gengrid is resized or gets "horizontal"
173 * - @c "scroll,anim,start" - This is called when scrolling animation has
175 * - @c "scroll,anim,stop" - This is called when scrolling animation has
177 * - @c "drag,start,up" - Called when the item in the gengrid has
178 * been dragged (not scrolled) up.
179 * - @c "drag,start,down" - Called when the item in the gengrid has
180 * been dragged (not scrolled) down.
181 * - @c "drag,start,left" - Called when the item in the gengrid has
182 * been dragged (not scrolled) left.
183 * - @c "drag,start,right" - Called when the item in the gengrid has
184 * been dragged (not scrolled) right.
185 * - @c "drag,stop" - Called when the item in the gengrid has
186 * stopped being dragged.
187 * - @c "drag" - Called when the item in the gengrid is being
189 * - @c "scroll" - called when the content has been scrolled
191 * - @c "scroll,drag,start" - called when dragging the content has
193 * - @c "scroll,drag,stop" - called when dragging the content has
195 * - @c "edge,top" - This is called when the gengrid is scrolled until
197 * - @c "edge,bottom" - This is called when the gengrid is scrolled
198 * until the bottom edge.
199 * - @c "edge,left" - This is called when the gengrid is scrolled
200 * until the left edge.
201 * - @c "edge,right" - This is called when the gengrid is scrolled
202 * until the right edge.
204 * Supported elm_object common APIs
205 * @li elm_object_signal_emit()
207 * Supported elm_object_item common APIs
208 * @li elm_object_item_part_content_get()
209 * @li elm_object_item_part_content_set()
210 * @li elm_object_item_part_content_unset()
211 * @li elm_object_item_part_text_set()
212 * @li elm_object_item_part_text_get()
213 * @li elm_object_item_disabled_set()
214 * @li elm_object_item_disabled_get()
216 * List of gengrid examples:
217 * @li @ref gengrid_example
221 * @addtogroup Gengrid
225 #define ELM_GENGRID_ITEM_CLASS_VERSION ELM_GEN_ITEM_CLASS_VERSION
226 #define ELM_GENGRID_ITEM_CLASS_HEADER ELM_GEN_ITEM_CLASS_HEADER
229 * Defines where to position the item in the genlist.
235 ELM_GENGRID_ITEM_SCROLLTO_NONE = 0, /**< no scrollto */
236 ELM_GENGRID_ITEM_SCROLLTO_IN = (1 << 0), /**< to the nearest viewport */
237 ELM_GENGRID_ITEM_SCROLLTO_TOP = (1 << 1), /**< to the top of viewport */
238 ELM_GENGRID_ITEM_SCROLLTO_MIDDLE = (1 << 2) /**< to the middle of viewport */
239 } Elm_Gengrid_Item_Scrollto_Type;
243 * @see Elm_Gen_Item_Class
245 typedef Elm_Gen_Item_Class Elm_Gengrid_Item_Class;
248 * @see Elm_Gen_Item_Text_Get_Cb
250 typedef Elm_Gen_Item_Text_Get_Cb Elm_Gengrid_Item_Text_Get_Cb;
253 * @see Elm_Gen_Item_Content_Get_Cb
255 typedef Elm_Gen_Item_Content_Get_Cb Elm_Gengrid_Item_Content_Get_Cb;
258 * @see Elm_Gen_Item_State_Get_Cb
260 typedef Elm_Gen_Item_State_Get_Cb Elm_Gengrid_Item_State_Get_Cb;
263 * @see Elm_Gen_Item_Del_Cb
265 typedef Elm_Gen_Item_Del_Cb Elm_Gengrid_Item_Del_Cb;
268 * Add a new gengrid widget to the given parent Elementary
271 * @param parent The parent object
272 * @return a new gengrid widget handle or @c NULL, on errors
274 * This function inserts a new gengrid widget on the canvas.
276 * @see elm_gengrid_item_size_set()
277 * @see elm_gengrid_group_item_size_set()
278 * @see elm_gengrid_horizontal_set()
279 * @see elm_gengrid_item_append()
280 * @see elm_object_item_del()
281 * @see elm_gengrid_clear()
285 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent);
288 * Remove all items from a given gengrid widget
290 * @param obj The gengrid object.
292 * This removes (and deletes) all items in @p obj, leaving it
295 * @see elm_object_item_del(), to remove just one item.
299 EAPI void elm_gengrid_clear(Evas_Object *obj);
302 * Enable or disable multi-selection in a given gengrid widget
304 * @param obj The gengrid object.
305 * @param multi @c EINA_TRUE, to enable multi-selection,
306 * @c EINA_FALSE to disable it.
308 * Multi-selection is the ability to have @b more than one
309 * item selected, on a given gengrid, simultaneously. When it is
310 * enabled, a sequence of clicks on different items will make them
311 * all selected, progressively. A click on an already selected item
312 * will unselect it. If interacting via the keyboard,
313 * multi-selection is enabled while holding the "Shift" key.
315 * @note By default, multi-selection is @b disabled on gengrids
317 * @see elm_gengrid_multi_select_get()
321 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi);
324 * Get whether multi-selection is enabled or disabled for a given
327 * @param obj The gengrid object.
328 * @return @c EINA_TRUE, if multi-selection is enabled, @c
329 * EINA_FALSE otherwise
331 * @see elm_gengrid_multi_select_set() for more details
335 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj);
338 * Set the direction in which a given gengrid widget will expand while
341 * @param obj The gengrid object.
342 * @param horizontal @c EINA_TRUE to make the gengrid expand
343 * horizontally, @c EINA_FALSE to expand vertically.
345 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
346 * in @b columns, from top to bottom and, when the space for a
347 * column is filled, another one is started on the right, thus
348 * expanding the grid horizontally. When in "vertical mode"
349 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
350 * to right and, when the space for a row is filled, another one is
351 * started below, thus expanding the grid vertically.
353 * @see elm_gengrid_horizontal_get()
357 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
360 * Get for what direction a given gengrid widget will expand while
363 * @param obj The gengrid object.
364 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
365 * @c EINA_FALSE if it's set to expand vertically.
367 * @see elm_gengrid_horizontal_set() for more details
371 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj);
374 * Enable or disable bouncing effect for a given gengrid widget
376 * @param obj The gengrid object
377 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
378 * @c EINA_FALSE to disable it
379 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
380 * @c EINA_FALSE to disable it
382 * The bouncing effect occurs whenever one reaches the gengrid's
383 * edge's while panning it -- it will scroll past its limits a
384 * little bit and return to the edge again, in a animated for,
387 * @note By default, gengrids have bouncing enabled on both axis
389 * @see elm_gengrid_bounce_get()
393 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
396 * Get whether bouncing effects are enabled or disabled, for a
397 * given gengrid widget, on each axis
399 * @param obj The gengrid object
400 * @param h_bounce Pointer to a variable where to store the
401 * horizontal bouncing flag.
402 * @param v_bounce Pointer to a variable where to store the
403 * vertical bouncing flag.
405 * @see elm_gengrid_bounce_set() for more details
409 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
412 * Append a new item in a given gengrid widget.
414 * @param obj The gengrid object.
415 * @param gic The item class for the item.
416 * @param data The item data.
417 * @param func Convenience function called when the item is
419 * @param func_data Data to be passed to @p func.
420 * @return A handle to the item added or @c NULL, on errors.
422 * This adds an item to the beginning of the gengrid.
424 * @see elm_gengrid_item_prepend()
425 * @see elm_gengrid_item_insert_before()
426 * @see elm_gengrid_item_insert_after()
427 * @see elm_object_item_del()
431 EAPI Elm_Object_Item *elm_gengrid_item_append(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Evas_Smart_Cb func, const void *func_data);
434 * Prepend a new item in a given gengrid widget.
436 * @param obj The gengrid object.
437 * @param gic The item class for the item.
438 * @param data The item data.
439 * @param func Convenience function called when the item is
441 * @param func_data Data to be passed to @p func.
442 * @return A handle to the item added or @c NULL, on errors.
444 * This adds an item to the end of the gengrid.
446 * @see elm_gengrid_item_append()
447 * @see elm_gengrid_item_insert_before()
448 * @see elm_gengrid_item_insert_after()
449 * @see elm_object_item_del()
453 EAPI Elm_Object_Item *elm_gengrid_item_prepend(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Evas_Smart_Cb func, const void *func_data);
456 * Insert an item before another in a gengrid widget
458 * @param obj The gengrid object.
459 * @param gic The item class for the item.
460 * @param data The item data.
461 * @param relative The item to place this new one before.
462 * @param func Convenience function called when the item is
464 * @param func_data Data to be passed to @p func.
465 * @return A handle to the item added or @c NULL, on errors.
467 * This inserts an item before another in the gengrid.
469 * @see elm_gengrid_item_append()
470 * @see elm_gengrid_item_prepend()
471 * @see elm_gengrid_item_insert_after()
472 * @see elm_object_item_del()
476 EAPI Elm_Object_Item *elm_gengrid_item_insert_before(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data);
479 * Insert an item after another in a gengrid widget
481 * @param obj The gengrid object.
482 * @param gic The item class for the item.
483 * @param data The item data.
484 * @param relative The item to place this new one after.
485 * @param func Convenience function called when the item is
487 * @param func_data Data to be passed to @p func.
488 * @return A handle to the item added or @c NULL, on errors.
490 * This inserts an item after another in the gengrid.
492 * @see elm_gengrid_item_append()
493 * @see elm_gengrid_item_prepend()
494 * @see elm_gengrid_item_insert_after()
495 * @see elm_object_item_del()
499 EAPI Elm_Object_Item *elm_gengrid_item_insert_after(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Elm_Object_Item *relative, Evas_Smart_Cb func, const void *func_data);
502 * Insert an item in a gengrid widget using a user-defined sort function.
504 * @param obj The gengrid object.
505 * @param gic The item class for the item.
506 * @param data The item data.
507 * @param comp User defined comparison function that defines the sort order
508 * based on Elm_Gen_Item and its data param.
509 * @param func Convenience function called when the item is selected.
510 * @param func_data Data to be passed to @p func.
511 * @return A handle to the item added or @c NULL, on errors.
513 * This inserts an item in the gengrid based on user defined comparison
514 * function. The two arguments passed to the function @p func are gengrid
515 * item handles to compare.
517 * @see elm_gengrid_item_append()
518 * @see elm_gengrid_item_prepend()
519 * @see elm_gengrid_item_insert_after()
520 * @see elm_object_item_del()
524 EAPI Elm_Object_Item *elm_gengrid_item_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
527 * Get the selected item in a given gengrid widget
529 * @param obj The gengrid object.
530 * @return The selected item's handle or @c NULL, if none is
531 * selected at the moment (and on errors)
533 * This returns the selected item in @p obj. If multi selection is
534 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
535 * the first item in the list is selected, which might not be very
536 * useful. For that case, see elm_gengrid_selected_items_get().
540 EAPI Elm_Object_Item *elm_gengrid_selected_item_get(const Evas_Object *obj);
543 * Get <b>a list</b> of selected items in a given gengrid
545 * @param obj The gengrid object.
546 * @return The list of selected items or @c NULL, if none is
547 * selected at the moment (and on errors)
549 * This returns a list of the selected items, in the order that
550 * they appear in the grid. This list is only valid as long as no
551 * more items are selected or unselected (or unselected implicitly
552 * by deletion). The list contains #Gengrid item pointers as
555 * @see elm_gengrid_selected_item_get()
559 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj);
562 //EAPI Eina_List *elm_gengrid_realized_items_get(const Evas_Object *obj);
565 * Get the first item in a given gengrid widget
567 * @param obj The gengrid object
568 * @return The first item's handle or @c NULL, if there are no
569 * items in @p obj (and on errors)
571 * This returns the first item in the @p obj's internal list of
574 * @see elm_gengrid_last_item_get()
578 EAPI Elm_Object_Item *elm_gengrid_first_item_get(const Evas_Object *obj);
581 * Get the last item in a given gengrid widget
583 * @param obj The gengrid object
584 * @return The last item's handle or @c NULL, if there are no
585 * items in @p obj (and on errors)
587 * This returns the last item in the @p obj's internal list of
590 * @see elm_gengrid_first_item_get()
594 EAPI Elm_Object_Item *elm_gengrid_last_item_get(const Evas_Object *obj);
597 //EAPI void elm_gengrid_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
600 //EAPI void elm_gengrid_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
603 * Get the @b next item in a gengrid widget's internal list of items,
604 * given a handle to one of those items.
606 * @param it The gengrid item to fetch next from
607 * @return The item after @p item, or @c NULL if there's none (and
610 * This returns the item placed after the @p item, on the container
613 * @see elm_gengrid_item_prev_get()
617 EAPI Elm_Object_Item *elm_gengrid_item_next_get(const Elm_Object_Item *it);
620 * Get the @b previous item in a gengrid widget's internal list of items,
621 * given a handle to one of those items.
623 * @param it The gengrid item to fetch previous from
624 * @return The item before @p item, or @c NULL if there's none (and
627 * This returns the item placed before the @p item, on the container
630 * @see elm_gengrid_item_next_get()
634 EAPI Elm_Object_Item *elm_gengrid_item_prev_get(const Elm_Object_Item *it);
637 * Set whether a given gengrid item is selected or not
639 * @param it The gengrid item
640 * @param selected Use @c EINA_TRUE, to make it selected, @c
641 * EINA_FALSE to make it unselected
643 * This sets the selected state of an item. If multi-selection is
644 * not enabled on the containing gengrid and @p selected is @c
645 * EINA_TRUE, any other previously selected items will get
646 * unselected in favor of this new one.
648 * @see elm_gengrid_item_selected_get()
652 EAPI void elm_gengrid_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
655 * Get whether a given gengrid item is selected or not
657 * @param it The gengrid item
658 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
660 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
662 * @see elm_gengrid_item_selected_set() for more details
666 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Object_Item *it);
669 * Show the portion of a gengrid's internal grid containing a given
670 * item, @b immediately.
672 * @param it The item to display
673 * @param type Where to position the item in the viewport.
675 * This causes gengrid to @b redraw its viewport's contents to the
676 * region containing the given @p item item, if it is not fully
679 * @see elm_gengrid_item_bring_in()
683 EAPI void elm_gengrid_item_show(Elm_Object_Item *it, Elm_Gengrid_Item_Scrollto_Type type);
686 * Animatedly bring in, to the visible area of a gengrid, a given
689 * @param it The gengrid item to display
690 * @param type Where to position the item in the viewport.
692 * This causes gengrid to jump to the given @p item and show
693 * it (by scrolling), if it is not fully visible. This will use
694 * animation to do so and take a period of time to complete.
696 * @see elm_gengrid_item_show()
700 EAPI void elm_gengrid_item_bring_in(Elm_Object_Item *it, Elm_Gengrid_Item_Scrollto_Type type);
703 * Update the contents of a given gengrid item
705 * @param it The gengrid item
707 * This updates an item by calling all the item class functions
708 * again to get the contents, texts and states. Use this when the
709 * original item data has changed and you want the changes to be
714 EAPI void elm_gengrid_item_update(Elm_Object_Item *it);
717 * Update the item class of a gengrid item.
719 * This sets another class of the item, changing the way that it is
720 * displayed. After changing the item class, elm_gengrid_item_update() is
721 * called on the item @p it.
723 * @param it The gengrid item
724 * @param gic The gengrid item class describing the function pointers and the item style.
728 EAPI void elm_gengrid_item_item_class_update(Elm_Object_Item *it, const Elm_Gengrid_Item_Class *gic);
731 * Get the Gengrid Item class for the given Gengrid Item.
733 * @param it The gengrid item
735 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
736 * the function pointers and item_style.
740 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Object_Item *it);
743 //EAPI int elm_gengrid_item_index_get(const Elm_Object_Item *it);
744 //EAPI void elm_gengrid_realized_items_update(Evas_Object *obj);
745 //EAPI unsigned int elm_gengrid_items_count(const Evas_Object *obj);
748 * Add a new gengrid item class in a given gengrid widget.
750 * @return New allocated a gengrid item class.
752 * This adds gengrid item class for the gengrid widget. When adding a item,
753 * gengrid_item_{append, prepend, insert} function needs item class of the item.
754 * Given callback parameters are used at retrieving {text, content} of
755 * added item. Set as NULL if it's not used.
756 * If there's no available memory, return can be NULL.
758 * @see elm_gengrid_item_class_free()
759 * @see elm_gengrid_item_append()
763 EAPI Elm_Gengrid_Item_Class *elm_gengrid_item_class_new(void);
766 * Remove a item class in a given gengrid widget.
768 * @param itc The itc to be removed.
770 * This removes item class from the gengrid widget.
771 * Whenever it has no more references to it, item class is going to be freed.
772 * Otherwise it just decreases its reference count.
774 * @see elm_gengrid_item_class_new()
775 * @see elm_gengrid_item_class_ref()
776 * @see elm_gengrid_item_class_unref()
780 EAPI void elm_gengrid_item_class_free(Elm_Gengrid_Item_Class *itc);
783 * Increments object reference count for the item class.
785 * @param itc The given item class object to reference
787 * This API just increases its reference count for item class management.
789 * @see elm_gengrid_item_class_unref()
793 EAPI void elm_gengrid_item_class_ref(Elm_Gengrid_Item_Class *itc);
796 * Decrements object reference count for the item class.
798 * @param itc The given item class object to reference
800 * This API just decreases its reference count for item class management.
801 * Reference count can't be less than 0.
803 * @see elm_gengrid_item_class_ref()
804 * @see elm_gengrid_item_class_free()
808 EAPI void elm_gengrid_item_class_unref(Elm_Gengrid_Item_Class *itc);
810 //XXX: Need to review tooltip & cursor APIs
813 * Set the text to be shown in a given gengrid item's tooltips.
815 * @param it The gengrid item
816 * @param text The text to set in the content
818 * This call will setup the text to be used as tooltip to that item
819 * (analogous to elm_object_tooltip_text_set(), but being item
820 * tooltips with higher precedence than object tooltips). It can
821 * have only one tooltip at a time, so any previous tooltip data
824 * In order to set a content or something else as a tooltip, look at
825 * elm_gengrid_item_tooltip_content_cb_set().
829 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
832 * Set the content to be shown in a given gengrid item's tooltip
834 * @param it The gengrid item.
835 * @param func The function returning the tooltip contents.
836 * @param data What to provide to @a func as callback data/context.
837 * @param del_cb Called when data is not needed anymore, either when
838 * another callback replaces @p func, the tooltip is unset with
839 * elm_gengrid_item_tooltip_unset() or the owner @p item
840 * dies. This callback receives as its first parameter the
841 * given @p data, being @c event_info the item handle.
843 * This call will setup the tooltip's contents to @p item
844 * (analogous to elm_object_tooltip_content_cb_set(), but being
845 * item tooltips with higher precedence than object tooltips). It
846 * can have only one tooltip at a time, so any previous tooltip
847 * content will get removed. @p func (with @p data) will be called
848 * every time Elementary needs to show the tooltip and it should
849 * return a valid Evas object, which will be fully managed by the
850 * tooltip system, getting deleted when the tooltip is gone.
852 * In order to set just a text as a tooltip, look at
853 * elm_gengrid_item_tooltip_text_set().
857 EAPI void elm_gengrid_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
860 * Unset a tooltip from a given gengrid item
862 * @param it gengrid item to remove a previously set tooltip from.
864 * This call removes any tooltip set on @p item. The callback
865 * provided as @c del_cb to
866 * elm_gengrid_item_tooltip_content_cb_set() will be called to
867 * notify it is not used anymore (and have resources cleaned, if
870 * @see elm_gengrid_item_tooltip_content_cb_set()
874 EAPI void elm_gengrid_item_tooltip_unset(Elm_Object_Item *it);
877 * Set a different @b style for a given gengrid item's tooltip.
879 * @param it gengrid item with tooltip set
880 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
881 * "default", @c "transparent", etc)
883 * Tooltips can have <b>alternate styles</b> to be displayed on,
884 * which are defined by the theme set on Elementary. This function
885 * works analogously as elm_object_tooltip_style_set(), but here
886 * applied only to gengrid item objects. The default style for
887 * tooltips is @c "default".
889 * @note before you set a style you should define a tooltip with
890 * elm_gengrid_item_tooltip_content_cb_set() or
891 * elm_gengrid_item_tooltip_text_set()
893 * @see elm_gengrid_item_tooltip_style_get()
897 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
900 * Get the style set a given gengrid item's tooltip.
902 * @param it gengrid item with tooltip already set on.
903 * @return style the theme style in use, which defaults to
904 * "default". If the object does not have a tooltip set,
905 * then @c NULL is returned.
907 * @see elm_gengrid_item_tooltip_style_set() for more details
911 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Object_Item *it);
914 * @brief Disable size restrictions on an object's tooltip
915 * @param it The tooltip's anchor object
916 * @param disable If EINA_TRUE, size restrictions are disabled
917 * @return EINA_FALSE on failure, EINA_TRUE on success
919 * This function allows a tooltip to expand beyond its parent window's canvas.
920 * It will instead be limited only by the size of the display.
922 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
925 * @brief Retrieve size restriction state of an object's tooltip
926 * @param it The tooltip's anchor object
927 * @return If EINA_TRUE, size restrictions are disabled
929 * This function returns whether a tooltip is allowed to expand beyond
930 * its parent window's canvas.
931 * It will instead be limited only by the size of the display.
933 EAPI Eina_Bool elm_gengrid_item_tooltip_window_mode_get(const Elm_Object_Item *it);
936 * Set the type of mouse pointer/cursor decoration to be shown,
937 * when the mouse pointer is over the given gengrid widget item
939 * @param it gengrid item to customize cursor on
940 * @param cursor the cursor type's name
942 * This function works analogously as elm_object_cursor_set(), but
943 * here the cursor's changing area is restricted to the item's
944 * area, and not the whole widget's. Note that that item cursors
945 * have precedence over widget cursors, so that a mouse over @p
946 * item will always show cursor @p type.
948 * If this function is called twice for an object, a previously set
949 * cursor will be unset on the second call.
951 * @see elm_object_cursor_set()
952 * @see elm_gengrid_item_cursor_get()
953 * @see elm_gengrid_item_cursor_unset()
957 EAPI void elm_gengrid_item_cursor_set(Elm_Object_Item *it, const char *cursor);
960 * Get the type of mouse pointer/cursor decoration set to be shown,
961 * when the mouse pointer is over the given gengrid widget item
963 * @param it gengrid item with custom cursor set
964 * @return the cursor type's name or @c NULL, if no custom cursors
965 * were set to @p item (and on errors)
967 * @see elm_object_cursor_get()
968 * @see elm_gengrid_item_cursor_set() for more details
969 * @see elm_gengrid_item_cursor_unset()
973 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Object_Item *it);
976 * Unset any custom mouse pointer/cursor decoration set to be
977 * shown, when the mouse pointer is over the given gengrid widget
978 * item, thus making it show the @b default cursor again.
980 * @param it a gengrid item
982 * Use this call to undo any custom settings on this item's cursor
983 * decoration, bringing it back to defaults (no custom style set).
985 * @see elm_object_cursor_unset()
986 * @see elm_gengrid_item_cursor_set() for more details
990 EAPI void elm_gengrid_item_cursor_unset(Elm_Object_Item *it);
993 * Set a different @b style for a given custom cursor set for a
996 * @param it gengrid item with custom cursor set
997 * @param style the <b>theme style</b> to use (e.g. @c "default",
998 * @c "transparent", etc)
1000 * This function only makes sense when one is using custom mouse
1001 * cursor decorations <b>defined in a theme file</b> , which can
1002 * have, given a cursor name/type, <b>alternate styles</b> on
1003 * it. It works analogously as elm_object_cursor_style_set(), but
1004 * here applied only to gengrid item objects.
1006 * @warning Before you set a cursor style you should have defined a
1007 * custom cursor previously on the item, with
1008 * elm_gengrid_item_cursor_set()
1010 * @see elm_gengrid_item_cursor_engine_only_set()
1011 * @see elm_gengrid_item_cursor_style_get()
1015 EAPI void elm_gengrid_item_cursor_style_set(Elm_Object_Item *it, const char *style);
1018 * Get the current @b style set for a given gengrid item's custom
1021 * @param it gengrid item with custom cursor set.
1022 * @return style the cursor style in use. If the object does not
1023 * have a cursor set, then @c NULL is returned.
1025 * @see elm_gengrid_item_cursor_style_set() for more details
1029 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Object_Item *it);
1032 * Set if the (custom) cursor for a given gengrid item should be
1033 * searched in its theme, also, or should only rely on the
1036 * @param it item with custom (custom) cursor already set on
1037 * @param engine_only Use @c EINA_TRUE to have cursors looked for
1038 * only on those provided by the rendering engine, @c EINA_FALSE to
1039 * have them searched on the widget's theme, as well.
1041 * @note This call is of use only if you've set a custom cursor
1042 * for gengrid items, with elm_gengrid_item_cursor_set().
1044 * @note By default, cursors will only be looked for between those
1045 * provided by the rendering engine.
1049 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
1052 * Get if the (custom) cursor for a given gengrid item is being
1053 * searched in its theme, also, or is only relying on the rendering
1056 * @param it a gengrid item
1057 * @return @c EINA_TRUE, if cursors are being looked for only on
1058 * those provided by the rendering engine, @c EINA_FALSE if they
1059 * are being searched on the widget's theme, as well.
1061 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
1065 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Object_Item *it);
1068 * Set the size for the items of a given gengrid widget
1070 * @param obj The gengrid object.
1071 * @param w The items' width.
1072 * @param h The items' height;
1074 * A gengrid, after creation, has still no information on the size
1075 * to give to each of its cells. So, you most probably will end up
1076 * with squares one @ref Fingers "finger" wide, the default
1077 * size. Use this function to force a custom size for you items,
1078 * making them as big as you wish.
1080 * @see elm_gengrid_item_size_get()
1084 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
1087 * Get the size set for the items of a given gengrid widget
1089 * @param obj The gengrid object.
1090 * @param w Pointer to a variable where to store the items' width.
1091 * @param h Pointer to a variable where to store the items' height.
1093 * @note Use @c NULL pointers on the size values you're not
1094 * interested in: they'll be ignored by the function.
1096 * @see elm_gengrid_item_size_get() for more details
1100 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h);
1103 * Set the size for the group items of a given gengrid widget
1105 * @param obj The gengrid object.
1106 * @param w The group items' width.
1107 * @param h The group items' height;
1109 * A gengrid, after creation, has still no information on the size
1110 * to give to each of its cells. So, you most probably will end up
1111 * with squares one @ref Fingers "finger" wide, the default
1112 * size. Use this function to force a custom size for you group items,
1113 * making them as big as you wish.
1115 * @see elm_gengrid_group_item_size_get()
1119 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
1122 * Get the size set for the group items of a given gengrid widget
1124 * @param obj The gengrid object.
1125 * @param w Pointer to a variable where to store the group items' width.
1126 * @param h Pointer to a variable where to store the group items' height.
1128 * @note Use @c NULL pointers on the size values you're not
1129 * interested in: they'll be ignored by the function.
1131 * @see elm_gengrid_group_item_size_get() for more details
1135 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h);
1138 * Set the items grid's alignment within a given gengrid widget
1140 * @param obj The gengrid object.
1141 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
1142 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
1144 * This sets the alignment of the whole grid of items of a gengrid
1145 * within its given viewport. By default, those values are both
1146 * 0.5, meaning that the gengrid will have its items grid placed
1147 * exactly in the middle of its viewport.
1149 * @note If given alignment values are out of the cited ranges,
1150 * they'll be changed to the nearest boundary values on the valid
1153 * @see elm_gengrid_align_get()
1157 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y);
1160 * Get the items grid's alignment values within a given gengrid
1163 * @param obj The gengrid object.
1164 * @param align_x Pointer to a variable where to store the
1165 * horizontal alignment.
1166 * @param align_y Pointer to a variable where to store the vertical
1169 * @note Use @c NULL pointers on the alignment values you're not
1170 * interested in: they'll be ignored by the function.
1172 * @see elm_gengrid_align_set() for more details
1176 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y);
1179 * Set whether a given gengrid widget is or not able have items
1182 * @param obj The gengrid object
1183 * @param reorder_mode Use @c EINA_TRUE to turn reordering on,
1184 * @c EINA_FALSE to turn it off
1186 * If a gengrid is set to allow reordering, a click held for more
1187 * than 0.5 over a given item will highlight it specially,
1188 * signaling the gengrid has entered the reordering state. From
1189 * that time on, the user will be able to, while still holding the
1190 * mouse button down, move the item freely in the gengrid's
1191 * viewport, replacing to said item to the locations it goes to.
1192 * The replacements will be animated and, whenever the user
1193 * releases the mouse button, the item being replaced gets a new
1194 * definitive place in the grid.
1196 * @see elm_gengrid_reorder_mode_get()
1200 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode);
1203 * Get whether a given gengrid widget is or not able have items
1206 * @param obj The gengrid object
1207 * @return @c EINA_TRUE, if reordering is on, @c EINA_FALSE if it's
1210 * @see elm_gengrid_reorder_mode_set() for more details
1214 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj);
1218 * Set a given gengrid widget's scrolling page size, relative to
1219 * its viewport size.
1221 * @param obj The gengrid object
1222 * @param h_pagerel The horizontal page (relative) size
1223 * @param v_pagerel The vertical page (relative) size
1225 * The gengrid's scroller is capable of binding scrolling by the
1226 * user to "pages". It means that, while scrolling and, specially
1227 * after releasing the mouse button, the grid will @b snap to the
1228 * nearest displaying page's area. When page sizes are set, the
1229 * grid's continuous content area is split into (equal) page sized
1232 * This function sets the size of a page <b>relatively to the
1233 * viewport dimensions</b> of the gengrid, for each axis. A value
1234 * @c 1.0 means "the exact viewport's size", in that axis, while @c
1235 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
1236 * a viewport". Sane usable values are, than, between @c 0.0 and @c
1237 * 1.0. Values beyond those will make it behave behave
1238 * inconsistently. If you only want one axis to snap to pages, use
1239 * the value @c 0.0 for the other one.
1241 * There is a function setting page size values in @b absolute
1242 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
1243 * is mutually exclusive to this one.
1245 * @see elm_gengrid_page_relative_get()
1249 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
1252 * Get a given gengrid widget's scrolling page size, relative to
1253 * its viewport size.
1255 * @param obj The gengrid object
1256 * @param h_pagerel Pointer to a variable where to store the
1257 * horizontal page (relative) size
1258 * @param v_pagerel Pointer to a variable where to store the
1259 * vertical page (relative) size
1261 * @see elm_gengrid_page_relative_set() for more details
1265 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
1268 * Set a given gengrid widget's scrolling page size
1270 * @param obj The gengrid object
1271 * @param h_pagesize The horizontal page size, in pixels
1272 * @param v_pagesize The vertical page size, in pixels
1274 * The gengrid's scroller is capable of binding scrolling by the
1275 * user to "pages". It means that, while scrolling and, specially
1276 * after releasing the mouse button, the grid will @b snap to the
1277 * nearest displaying page's area. When page sizes are set, the
1278 * grid's continuous content area is split into (equal) page sized
1281 * This function sets the size of a page of the gengrid, in pixels,
1282 * for each axis. Sane usable values are, between @c 0 and the
1283 * dimensions of @p obj, for each axis. Values beyond those will
1284 * make it behave behave inconsistently. If you only want one axis
1285 * to snap to pages, use the value @c 0 for the other one.
1287 * There is a function setting page size values in @b relative
1288 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
1289 * use is mutually exclusive to this one.
1293 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
1296 * @brief Get gengrid current page number.
1298 * @param obj The gengrid object
1299 * @param h_pagenumber The horizontal page number
1300 * @param v_pagenumber The vertical page number
1302 * The page number starts from 0. 0 is the first page.
1303 * Current page means the page which meet the top-left of the viewport.
1304 * If there are two or more pages in the viewport, it returns the number of page
1305 * which meet the top-left of the viewport.
1307 * @see elm_gengrid_last_page_get()
1308 * @see elm_gengrid_page_show()
1309 * @see elm_gengrid_page_bring_in()
1311 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
1314 * @brief Get gengrid last page number.
1316 * @param obj The gengrid object
1317 * @param h_pagenumber The horizontal page number
1318 * @param v_pagenumber The vertical page number
1320 * The page number starts from 0. 0 is the first page.
1321 * This returns the last page number among the pages.
1323 * @see elm_gengrid_current_page_get()
1324 * @see elm_gengrid_page_show()
1325 * @see elm_gengrid_page_bring_in()
1327 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
1330 * Show a specific virtual region within the gengrid content object by page number.
1332 * @param obj The gengrid object
1333 * @param h_pagenumber The horizontal page number
1334 * @param v_pagenumber The vertical page number
1336 * 0, 0 of the indicated page is located at the top-left of the viewport.
1337 * This will jump to the page directly without animation.
1342 * sc = elm_gengrid_add(win);
1343 * elm_gengrid_content_set(sc, content);
1344 * elm_gengrid_page_relative_set(sc, 1, 0);
1345 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
1346 * elm_gengrid_page_show(sc, h_page + 1, v_page);
1349 * @see elm_gengrid_page_bring_in()
1351 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
1354 * Show a specific virtual region within the gengrid content object by page number.
1356 * @param obj The gengrid object
1357 * @param h_pagenumber The horizontal page number
1358 * @param v_pagenumber The vertical page number
1360 * 0, 0 of the indicated page is located at the top-left of the viewport.
1361 * This will slide to the page with animation.
1366 * sc = elm_gengrid_add(win);
1367 * elm_gengrid_content_set(sc, content);
1368 * elm_gengrid_page_relative_set(sc, 1, 0);
1369 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
1370 * elm_gengrid_page_bring_in(sc, h_page, v_page);
1373 * @see elm_gengrid_page_show()
1375 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
1378 * Get a given gengrid item's position, relative to the whole
1379 * gengrid's grid area.
1381 * @param it The Gengrid item.
1382 * @param x Pointer to variable to store the item's <b>row number</b>.
1383 * @param y Pointer to variable to store the item's <b>column number</b>.
1385 * This returns the "logical" position of the item within the
1386 * gengrid. For example, @c (0, 1) would stand for first row,
1391 EAPI void elm_gengrid_item_pos_get(const Elm_Object_Item *it, unsigned int *x, unsigned int *y);
1394 * Set how the items grid's filled within a given gengrid widget
1396 * @param obj The gengrid object.
1397 * @param fill Filled if True
1399 * This sets the fill state of the whole grid of items of a gengrid
1400 * within its given viewport. By default, this value is false, meaning
1401 * that if the first line of items grid's isn't filled, the items are
1402 * centered with the alignment
1404 * @see elm_gengrid_filled_get()
1409 //XXX: Does this API working well?
1410 EAPI void elm_gengrid_filled_set(Evas_Object *obj, Eina_Bool fill);
1413 * Get how the items grid's filled within a given gengrid widget
1415 * @param obj The gengrid object.
1416 * @return @c EINA_TRUE, if filled is on, @c EINA_FALSE if it's
1419 * @note Use @c NULL pointers on the alignment values you're not
1420 * interested in: they'll be ignored by the function.
1422 * @see elm_gengrid_align_set() for more details
1426 //XXX: Does this API working well?
1427 EAPI Eina_Bool elm_gengrid_filled_get(const Evas_Object *obj);
1430 * Set the gengrid select mode.
1432 * @param obj The gengrid object
1433 * @param mode The select mode
1435 * elm_gengrid_select_mode_set() changes item select mode in the gengrid widget.
1436 * - ELM_OBJECT_NORMAL_SELECT : Items will only call their selection func and
1437 * callback when first becoming selected. Any further clicks will
1438 * do nothing, unless you set always select mode.
1439 * - ELM_OBJECT_ALWAYS_SELECT : This means that, even if selected,
1440 * every click will make the selected callbacks be called.
1441 * - ELM_OBJECT_NO_SELECT : This will turn off the ability to select items
1442 * entirely and they will neither appear selected nor call selected
1443 * callback functions.
1445 * @see elm_gengrid_select_mode_get()
1450 elm_gengrid_select_mode_set(Evas_Object *obj, Elm_Object_Select_Mode_Type mode);
1453 * Get the gengrid select mode.
1455 * @param obj The gengrid object
1456 * @return The select mode
1457 * (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
1459 * @see elm_gengrid_select_mode_set()
1463 EAPI Elm_Object_Select_Mode_Type
1464 elm_gengrid_select_mode_get(const Evas_Object *obj);
1467 * Set whether the gengrid items' should be hilighted when item selected.
1469 * @param obj The gengrid object.
1470 * @param hilight @c EINA_TRUE to enable hilight or @c EINA_FALSE to
1473 * This will turn on/off the hilight effect when items are selected and
1474 * they will or will not be hilighted. The selected and clicked
1475 * callback functions will still be called.
1477 * hilight is enabled by default.
1479 * @see elm_gengrid_hilight_mode_get().
1485 elm_gengrid_hilight_mode_set(Evas_Object *obj,
1489 * Get whether the gengrid items' should be hilighted when item selected.
1491 * @param obj The gengrid object.
1492 * @return @c EINA_TRUE means items can be hilighted. @c EINA_FALSE indicates
1493 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
1495 * @see elm_gengrid_hilight_mode_set() for details.
1501 elm_gengrid_hilight_mode_get(const Evas_Object *obj);