1 #include <Elementary.h>
2 #include <Elementary_Cursor.h>
6 * @defgroup Gengrid Gengrid
8 * This widget aims to position objects in a grid layout while
9 * actually building only the visible ones, using the same idea as
10 * genlist: the user define a class for each item, specifying
11 * functions that will be called at object creation and deletion.
13 * Signals that you can add callbacks for are:
15 * clicked - The user has double-clicked or pressed enter on
16 * a item. The event_infoparameter is the Gengrid item
17 * that was double-clicked.
19 * selected - The user has made an item selected. The event_info
20 * parameter is the Gengrid item that was selected.
22 * unselected - The user has made an item unselected. The event_info
23 * parameter is the Gengrid item that was unselected.
25 * realized - This is called when the item in the Gengrid is created
26 * as a real evas object. event_info is the Gengrid item that was
27 * created. The object may be deleted at any time, so it is up to the
28 * caller to not use the object pointer from
29 * elm_gengrid_item_object_get() in a way where it may point to freed
32 * unrealized - This is called when the real evas object for this item
33 * is deleted. event_info is the Gengrid item that was created.
35 * changed - Called when an item is added, removed, resized or moved
36 * and when gengrid is resized or horizontal property changes.
38 * drag,start,up - Called when the item in the Gengrid has been
39 * dragged (not scrolled) up.
41 * drag,start,down - Called when the item in the Gengrid has been
42 * dragged (not scrolled) down.
44 * drag,start,left - Called when the item in the Gengrid has been
45 * dragged (not scrolled) left.
47 * drag,start,right - Called when the item in the Gengrid has been
48 * dragged (not scrolled) right.
50 * drag,stop - Called when the item in the Gengrid has stopped being
53 * drag - Called when the item in the Gengrid is being dragged.
55 * scroll - called when the content has been scrolled (moved).
57 * scroll,drag,start - called when dragging the content has started.
59 * scroll,drag,stop - called when dragging the content has stopped.
62 * A item in the Gengrid can have 0 or more text labels (they can be
63 * regular text or textblock - that's up to the style to determine), 0
64 * or more icons (which are simply objects swallowed into the Gengrid
65 * item) and 0 or more boolean states that can be used for check,
66 * radio or other indicators by the edje theme style. A item may be
67 * one of several styles (Elementary provides 1 by default -
68 * "default", but this can be extended by system or application custom
69 * themes/overlays/extensions).
71 * In order to implement the ability to add and delete items on the
72 * fly, Gengrid implements a class/callback system where the
73 * application provides a structure with information about that type
74 * of item (Gengrid may contain multiple different items with
75 * different classes, states and styles). Gengrid will call the
76 * functions in this struct (methods) when a item is "realized" (that
77 * is created dynamically while scrolling). All objects will simply be
78 * deleted when no longer needed with evas_object_del(). The
79 * Elm_GenGrid_Item_Class structure contains the following members:
81 * item_style - This is a constant string and simply defines the name
82 * of the item style. It must be specified and the default should be
85 * func.label_get - This function is called when an actual item object
86 * is created. The data parameter is the one passed to
87 * elm_gengrid_item_append() and related item creation functions. The
88 * obj parameter is the Gengrid object and the part parameter is the
89 * string name of the text part in the edje design that is listed as
90 * one of the possible labels that can be set. This function must
91 * return a strdup'()ed string as the caller will free() it when done.
93 * func.icon_get - This function is called when an actual item object
94 * is created. The data parameter is the one passed to
95 * elm_gengrid_item_append() and related item creation functions. The
96 * obj parameter is the Gengrid object and the part parameter is the
97 * string name of the icon part in the edje design that is listed as
98 * one of the possible icons that can be set. This must return NULL
99 * for no object or a valid object. The object will be deleted by
100 * Gengrid on shutdown or when the item is unrealized.
102 * func.state_get - This function is called when an actual item object
103 * is created. The data parameter is the one passed to
104 * elm_gengrid_item_append() and related item creation functions. The
105 * obj parameter is the Gengrid object and the part parameter is the
106 * string name of th state part in the edje design that is listed as
107 * one of the possible states that can be set. Return 0 for false and
108 * 1 for true. Gengrid will emit a signal to the edje object with
109 * "elm,state,XXX,active" "elm" when true (the default is false),
110 * where XXX is the name of the part.
112 * func.del - This is called when elm_gengrid_item_del() is called on
113 * a item or elm_gengrid_clear() is called on the Gengrid. This is
114 * intended for use when actual Gengrid items are deleted, so any
115 * backing data attached to the item (e.g. its data parameter on
116 * creation) can be deleted.
118 * If the application wants multiple items to be able to be selected,
119 * elm_gengrid_multi_select_set() can enable this. If the Gengrid is
120 * single-selection only (the default), then
121 * elm_gengrid_select_item_get() will return the selected item, if
122 * any, or NULL if none is selected. If the Gengrid is multi-select
123 * then elm_gengrid_selected_items_get() will return a list (that is
124 * only valid as long as no items are modified (added, deleted,
125 * selected or unselected).
127 * If a item changes (state of boolean changes, label or icons
128 * change), then use elm_gengrid_item_update() to have Gengrid update
129 * the item with the new state. Gengrid will re-realize the item thus
130 * call the functions in the _Elm_Gengrid_Item_Class for that item.
132 * To programmatically (un)select a item use
133 * elm_gengrid_item_selected_set(). To get its selected state use
134 * elm_gengrid_item_selected_get(). To make a item disabled (unable to
135 * be selected and appear differently) use
136 * elm_gengrid_item_disabled_set() to set this and
137 * elm_gengrid_item_disabled_get() to get the disabled state.
139 * Cells will only call their selection func and callback when first
140 * becoming selected. Any further clicks will do nothing, unless you
141 * enable always select with
142 * elm_gengrid_always_select_mode_set(). This means event if selected,
143 * every click will make the selected callbacks be called.
144 * elm_gengrid_no_select_mode_set() will turn off the ability to
145 * select items entirely and they will neither appear selected nor
146 * call selected callback function.
148 * Remember that you can create new styles and add your own theme
149 * augmentation per application with elm_theme_extension_add(). If you
150 * absolutely must have a specific style that overrides any theme the
151 * user or system sets up you can use elm_theme_overlay_add() to add
156 * * Handle non-homogeneous objects too.
159 typedef struct _Widget_Data Widget_Data;
160 typedef struct _Pan Pan;
164 struct _Elm_Gengrid_Item
166 Elm_Widget_Item base;
169 const Elm_Gengrid_Item_Class *gic;
170 Ecore_Timer *long_timer;
172 Eina_List *labels, *icons, *states, *icon_objs;
179 Evas_Coord x, y, dx, dy;
186 Elm_Tooltip_Item_Content_Cb content_cb;
187 Evas_Smart_Cb del_cb;
191 const char *mouse_cursor;
193 Eina_Bool want_unrealize : 1;
194 Eina_Bool realized : 1;
195 Eina_Bool dragging : 1;
197 Eina_Bool delete_me : 1;
198 Eina_Bool display_only : 1;
199 Eina_Bool disabled : 1;
200 Eina_Bool selected : 1;
201 Eina_Bool hilighted : 1;
206 Evas_Object *self, *scr;
207 Evas_Object *pan_smart;
212 Elm_Gengrid_Item *last_selected_item;
213 double align_x, align_y;
215 Evas_Coord pan_x, pan_y;
216 Evas_Coord item_width, item_height; /* Each item size */
217 Evas_Coord minw, minh; /* Total obj size */
222 Eina_Bool horizontal : 1;
223 Eina_Bool on_hold : 1;
224 Eina_Bool longpressed : 1;
226 Eina_Bool no_select : 1;
227 Eina_Bool wasselected : 1;
228 Eina_Bool always_select : 1;
229 Eina_Bool clear_me : 1;
232 #define ELM_GENGRID_ITEM_FROM_INLIST(item) \
233 ((item) ? EINA_INLIST_CONTAINER_GET(item, Elm_Gengrid_Item) : NULL)
237 Evas_Object_Smart_Clipped_Data __clipped_data;
241 static const char *widtype = NULL;
242 static void _item_hilight(Elm_Gengrid_Item *item);
243 static void _item_unrealize(Elm_Gengrid_Item *item);
244 static void _item_select(Elm_Gengrid_Item *item);
245 static void _item_unselect(Elm_Gengrid_Item *item);
246 static void _calc_job(void *data);
247 static void _on_focus_hook(void *data,
249 static Eina_Bool _item_multi_select_up(Widget_Data *wd);
250 static Eina_Bool _item_multi_select_down(Widget_Data *wd);
251 static Eina_Bool _item_multi_select_left(Widget_Data *wd);
252 static Eina_Bool _item_multi_select_right(Widget_Data *wd);
253 static Eina_Bool _item_single_select_up(Widget_Data *wd);
254 static Eina_Bool _item_single_select_down(Widget_Data *wd);
255 static Eina_Bool _item_single_select_left(Widget_Data *wd);
256 static Eina_Bool _item_single_select_right(Widget_Data *wd);
257 static Eina_Bool _event_hook(Evas_Object *obj,
259 Evas_Callback_Type type,
261 static Eina_Bool _deselect_all_items(Widget_Data *wd);
263 static Evas_Smart_Class _pan_sc = EVAS_SMART_CLASS_INIT_VERSION;
264 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
267 _event_hook(Evas_Object *obj,
268 Evas_Object *src __UNUSED__,
269 Evas_Callback_Type type,
272 if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
273 Evas_Event_Key_Down *ev = event_info;
274 Widget_Data *wd = elm_widget_data_get(obj);
275 if (!wd) return EINA_FALSE;
276 if (!wd->items) return EINA_FALSE;
277 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
278 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
280 Elm_Gengrid_Item *item = NULL;
283 Evas_Coord step_x = 0;
284 Evas_Coord step_y = 0;
287 Evas_Coord page_x = 0;
288 Evas_Coord page_y = 0;
290 elm_smart_scroller_child_pos_get(wd->scr, &x, &y);
291 elm_smart_scroller_step_size_get(wd->scr, &step_x, &step_y);
292 elm_smart_scroller_page_size_get(wd->scr, &page_x, &page_y);
293 elm_smart_scroller_child_viewport_size_get(wd->scr, &v_w, &v_h);
295 if ((!strcmp(ev->keyname, "Left")) || (!strcmp(ev->keyname, "KP_Left")))
297 if ((wd->horizontal) &&
298 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
299 (_item_multi_select_up(wd)))
300 || (_item_single_select_up(wd))))
302 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
305 else if ((!wd->horizontal) &&
306 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
307 (_item_multi_select_left(wd)))
308 || (_item_single_select_left(wd))))
310 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
316 else if ((!strcmp(ev->keyname, "Right")) || (!strcmp(ev->keyname, "KP_Right")))
318 if ((wd->horizontal) &&
319 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
320 (_item_multi_select_down(wd)))
321 || (_item_single_select_down(wd))))
323 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
326 else if ((!wd->horizontal) &&
327 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
328 (_item_multi_select_right(wd)))
329 || (_item_single_select_right(wd))))
331 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
337 else if ((!strcmp(ev->keyname, "Up")) || (!strcmp(ev->keyname, "KP_Up")))
339 if ((wd->horizontal) &&
340 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
341 (_item_multi_select_left(wd)))
342 || (_item_single_select_left(wd))))
344 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
347 else if ((!wd->horizontal) &&
348 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
349 (_item_multi_select_up(wd)))
350 || (_item_single_select_up(wd))))
352 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
358 else if ((!strcmp(ev->keyname, "Down")) || (!strcmp(ev->keyname, "KP_Down")))
360 if ((wd->horizontal) &&
361 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
362 (_item_multi_select_right(wd)))
363 || (_item_single_select_right(wd))))
365 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
368 else if ((!wd->horizontal) &&
369 (((evas_key_modifier_is_set(ev->modifiers, "Shift")) &&
370 (_item_multi_select_down(wd)))
371 || (_item_single_select_down(wd))))
373 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
379 else if ((!strcmp(ev->keyname, "Home")) || (!strcmp(ev->keyname, "KP_Home")))
381 item = elm_gengrid_first_item_get(obj);
382 elm_gengrid_item_bring_in(item);
383 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
386 else if ((!strcmp(ev->keyname, "End")) || (!strcmp(ev->keyname, "KP_End")))
388 item = elm_gengrid_last_item_get(obj);
389 elm_gengrid_item_bring_in(item);
390 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
393 else if ((!strcmp(ev->keyname, "Prior")) ||
394 (!strcmp(ev->keyname, "KP_Prior")))
399 x -= -(page_x * v_w) / 100;
406 y -= -(page_y * v_h) / 100;
411 else if ((!strcmp(ev->keyname, "Next")) || (!strcmp(ev->keyname, "KP_Next")))
416 x += -(page_x * v_w) / 100;
423 y += -(page_y * v_h) / 100;
428 else if (!strcmp(ev->keyname, "Escape"))
430 if (!_deselect_all_items(wd)) return EINA_FALSE;
431 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
434 else if (!strcmp(ev->keyname, "Return"))
436 item = elm_gengrid_selected_item_get(obj);
437 evas_object_smart_callback_call(item->wd->self, "clicked", item);
439 else return EINA_FALSE;
441 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
442 elm_smart_scroller_child_pos_set(wd->scr, x, y);
447 _deselect_all_items(Widget_Data *wd)
449 if (!wd->selected) return EINA_FALSE;
451 elm_gengrid_item_selected_set(wd->selected->data, EINA_FALSE);
457 _item_multi_select_left(Widget_Data *wd)
459 if (!wd->selected) return EINA_FALSE;
461 Elm_Gengrid_Item *prev = elm_gengrid_item_prev_get(wd->last_selected_item);
462 if (!prev) return EINA_TRUE;
463 if (elm_gengrid_item_selected_get(prev))
465 elm_gengrid_item_selected_set(wd->last_selected_item, EINA_FALSE);
466 wd->last_selected_item = prev;
467 elm_gengrid_item_show(wd->last_selected_item);
471 elm_gengrid_item_selected_set(prev, EINA_TRUE);
472 elm_gengrid_item_show(prev);
479 _item_multi_select_right(Widget_Data *wd)
481 if (!wd->selected) return EINA_FALSE;
483 Elm_Gengrid_Item *next = elm_gengrid_item_next_get(wd->last_selected_item);
484 if (!next) return EINA_TRUE;
485 if (elm_gengrid_item_selected_get(next))
487 elm_gengrid_item_selected_set(wd->last_selected_item, EINA_FALSE);
488 wd->last_selected_item = next;
489 elm_gengrid_item_show(wd->last_selected_item);
493 elm_gengrid_item_selected_set(next, EINA_TRUE);
494 elm_gengrid_item_show(next);
501 _item_multi_select_up(Widget_Data *wd)
504 Eina_Bool r = EINA_TRUE;
506 if (!wd->selected) return EINA_FALSE;
508 for (i = 0; (r) && (i < wd->nmax); i++)
509 r &= _item_multi_select_left(wd);
515 _item_multi_select_down(Widget_Data *wd)
518 Eina_Bool r = EINA_TRUE;
520 if (!wd->selected) return EINA_FALSE;
522 for (i = 0; (r) && (i < wd->nmax); i++)
523 r &= _item_multi_select_right(wd);
529 _item_single_select_up(Widget_Data *wd)
533 Elm_Gengrid_Item *prev;
537 prev = ELM_GENGRID_ITEM_FROM_INLIST(wd->items->last);
538 while ((prev) && (prev->delete_me))
539 prev = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(prev)->prev);
540 elm_gengrid_item_selected_set(prev, EINA_TRUE);
541 elm_gengrid_item_show(prev);
544 else prev = elm_gengrid_item_prev_get(wd->last_selected_item);
546 if (!prev) return EINA_FALSE;
548 for (i = 1; i < wd->nmax; i++)
550 Elm_Gengrid_Item *tmp = elm_gengrid_item_prev_get(prev);
551 if (!tmp) return EINA_FALSE;
555 _deselect_all_items(wd);
557 elm_gengrid_item_selected_set(prev, EINA_TRUE);
558 elm_gengrid_item_show(prev);
563 _item_single_select_down(Widget_Data *wd)
567 Elm_Gengrid_Item *next;
571 next = ELM_GENGRID_ITEM_FROM_INLIST(wd->items);
572 while ((next) && (next->delete_me))
573 next = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(next)->next);
574 elm_gengrid_item_selected_set(next, EINA_TRUE);
575 elm_gengrid_item_show(next);
578 else next = elm_gengrid_item_next_get(wd->last_selected_item);
580 if (!next) return EINA_FALSE;
582 for (i = 1; i < wd->nmax; i++)
584 Elm_Gengrid_Item *tmp = elm_gengrid_item_next_get(next);
585 if (!tmp) return EINA_FALSE;
589 _deselect_all_items(wd);
591 elm_gengrid_item_selected_set(next, EINA_TRUE);
592 elm_gengrid_item_show(next);
597 _item_single_select_left(Widget_Data *wd)
599 Elm_Gengrid_Item *prev;
602 prev = ELM_GENGRID_ITEM_FROM_INLIST(wd->items->last);
603 while ((prev) && (prev->delete_me))
604 prev = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(prev)->prev);
606 else prev = elm_gengrid_item_prev_get(wd->last_selected_item);
608 if (!prev) return EINA_FALSE;
610 _deselect_all_items(wd);
612 elm_gengrid_item_selected_set(prev, EINA_TRUE);
613 elm_gengrid_item_show(prev);
618 _item_single_select_right(Widget_Data *wd)
620 Elm_Gengrid_Item *next;
623 next = ELM_GENGRID_ITEM_FROM_INLIST(wd->items);
624 while ((next) && (next->delete_me))
625 next = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(next)->next);
627 else next = elm_gengrid_item_next_get(wd->last_selected_item);
629 if (!next) return EINA_FALSE;
631 _deselect_all_items(wd);
633 elm_gengrid_item_selected_set(next, EINA_TRUE);
634 elm_gengrid_item_show(next);
639 _on_focus_hook(void *data __UNUSED__,
642 Widget_Data *wd = elm_widget_data_get(obj);
644 if (elm_widget_focus_get(obj))
646 edje_object_signal_emit(wd->self, "elm,action,focus", "elm");
647 evas_object_focus_set(wd->self, EINA_TRUE);
648 if ((wd->selected) && (!wd->last_selected_item))
649 wd->last_selected_item = eina_list_data_get(wd->selected);
653 edje_object_signal_emit(wd->self, "elm,action,unfocus", "elm");
654 evas_object_focus_set(wd->self, EINA_FALSE);
659 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
661 Widget_Data *wd = elm_widget_data_get(obj);
662 Elm_Gengrid_Item *item;
664 elm_smart_scroller_mirrored_set(wd->scr, rtl);
665 if (!wd->items) return;
666 item = ELM_GENGRID_ITEM_FROM_INLIST(wd->items);
670 edje_object_mirrored_set(item->base.view, rtl);
671 elm_gengrid_item_update(item);
672 item = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(item)->next);
677 _theme_hook(Evas_Object *obj)
679 Widget_Data *wd = elm_widget_data_get(obj);
681 _elm_widget_mirrored_reload(obj);
682 _mirrored_set(obj, elm_widget_mirrored_get(obj));
683 elm_smart_scroller_object_theme_set(obj, wd->scr, "gengrid", "base",
684 elm_widget_style_get(obj));
688 _del_pre_hook(Evas_Object *obj)
690 Widget_Data *wd = elm_widget_data_get(obj);
692 elm_gengrid_clear(obj);
693 evas_object_del(wd->pan_smart);
694 wd->pan_smart = NULL;
698 _del_hook(Evas_Object *obj)
700 Widget_Data *wd = elm_widget_data_get(obj);
705 _signal_emit_hook(Evas_Object *obj,
706 const char *emission,
709 Widget_Data *wd = elm_widget_data_get(obj);
711 edje_object_signal_emit(elm_smart_scroller_edje_object_get(wd->scr),
716 _mouse_move(void *data,
717 Evas *evas __UNUSED__,
721 Elm_Gengrid_Item *item = data;
722 Evas_Event_Mouse_Move *ev = event_info;
723 Evas_Coord minw = 0, minh = 0, x, y, dx, dy, adx, ady;
725 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD)
727 if (!item->wd->on_hold)
729 item->wd->on_hold = EINA_TRUE;
730 if (!item->wd->wasselected)
731 _item_unselect(item);
734 if ((item->dragging) && (item->down))
736 if (item->long_timer)
738 ecore_timer_del(item->long_timer);
739 item->long_timer = NULL;
741 evas_object_smart_callback_call(item->wd->self, "drag", item);
744 if ((!item->down) || (item->wd->longpressed))
746 if (item->long_timer)
748 ecore_timer_del(item->long_timer);
749 item->long_timer = NULL;
753 if (!item->display_only)
754 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
755 evas_object_geometry_get(obj, &x, &y, NULL, NULL);
756 x = ev->cur.canvas.x - x;
757 y = ev->cur.canvas.y - y;
760 if (adx < 0) adx = -dx;
763 if (ady < 0) ady = -dy;
766 if ((adx > minw) || (ady > minh))
768 const char *left_drag, *right_drag;
769 if (!elm_widget_mirrored_get(item->wd->self))
771 left_drag = "drag,start,left";
772 right_drag = "drag,start,right";
776 left_drag = "drag,start,right";
777 right_drag = "drag,start,left";
781 if (item->long_timer)
783 ecore_timer_del(item->long_timer);
784 item->long_timer = NULL;
786 if (!item->wd->wasselected)
787 _item_unselect(item);
791 evas_object_smart_callback_call(item->wd->self, "drag,start,up",
796 evas_object_smart_callback_call(item->wd->self,
803 evas_object_smart_callback_call(item->wd->self,
804 "drag,start,down", item);
808 evas_object_smart_callback_call(item->wd->self,
811 evas_object_smart_callback_call(item->wd->self,
819 _long_press(void *data)
821 Elm_Gengrid_Item *item = data;
823 item->long_timer = NULL;
824 if ((item->disabled) || (item->dragging)) return ECORE_CALLBACK_CANCEL;
825 item->wd->longpressed = EINA_TRUE;
826 evas_object_smart_callback_call(item->wd->self, "longpressed", item);
827 return ECORE_CALLBACK_CANCEL;
831 _mouse_down(void *data,
832 Evas *evas __UNUSED__,
836 Elm_Gengrid_Item *item = data;
837 Evas_Event_Mouse_Down *ev = event_info;
840 if (ev->button != 1) return;
843 evas_object_geometry_get(obj, &x, &y, NULL, NULL);
844 item->dx = ev->canvas.x - x;
845 item->dy = ev->canvas.y - y;
846 item->wd->longpressed = EINA_FALSE;
847 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) item->wd->on_hold = EINA_TRUE;
848 else item->wd->on_hold = EINA_FALSE;
849 item->wd->wasselected = item->selected;
851 if (ev->flags & EVAS_BUTTON_DOUBLE_CLICK)
852 evas_object_smart_callback_call(item->wd->self, "clicked", item);
853 if (item->long_timer) ecore_timer_del(item->long_timer);
855 item->long_timer = ecore_timer_add(_elm_config->longpress_timeout,
858 item->long_timer = NULL;
862 _mouse_up(void *data,
863 Evas *evas __UNUSED__,
864 Evas_Object *obj __UNUSED__,
867 Elm_Gengrid_Item *item = data;
868 Evas_Event_Mouse_Up *ev = event_info;
869 Eina_Bool dragged = EINA_FALSE;
871 if (ev->button != 1) return;
872 item->down = EINA_FALSE;
873 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) item->wd->on_hold = EINA_TRUE;
874 else item->wd->on_hold = EINA_FALSE;
875 if (item->long_timer)
877 ecore_timer_del(item->long_timer);
878 item->long_timer = NULL;
882 item->dragging = EINA_FALSE;
883 evas_object_smart_callback_call(item->wd->self, "drag,stop", item);
886 if (item->wd->on_hold)
888 item->wd->longpressed = EINA_FALSE;
889 item->wd->on_hold = EINA_FALSE;
892 if (item->wd->longpressed)
894 item->wd->longpressed = EINA_FALSE;
895 if (!item->wd->wasselected) _item_unselect(item);
896 item->wd->wasselected = EINA_FALSE;
901 if (item->want_unrealize) _item_unrealize(item);
903 if ((item->disabled) || (dragged)) return;
911 else _item_unselect(item);
917 while (item->wd->selected)
918 _item_unselect(item->wd->selected->data);
922 const Eina_List *l, *l_next;
923 Elm_Gengrid_Item *item2;
925 EINA_LIST_FOREACH_SAFE(item->wd->selected, l, l_next, item2)
926 if (item2 != item) _item_unselect(item2);
934 _item_hilight(Elm_Gengrid_Item *item)
936 if ((item->wd->no_select) || (item->delete_me) || (item->hilighted)) return;
937 edje_object_signal_emit(item->base.view, "elm,state,selected", "elm");
938 item->hilighted = EINA_TRUE;
942 _item_realize(Elm_Gengrid_Item *item)
947 if ((item->realized) || (item->delete_me)) return;
948 item->base.view = edje_object_add(evas_object_evas_get(item->wd->self));
949 edje_object_scale_set(item->base.view, elm_widget_scale_get(item->wd->self) *
951 edje_object_mirrored_set(item->base.view, elm_widget_mirrored_get(item->base.widget));
952 evas_object_smart_member_add(item->base.view, item->wd->pan_smart);
953 elm_widget_sub_object_add(item->wd->self, item->base.view);
954 snprintf(style, sizeof(style), "item/%s",
955 item->gic->item_style ? item->gic->item_style : "default");
956 _elm_theme_object_set(item->wd->self, item->base.view, "gengrid", style,
957 elm_widget_style_get(item->wd->self));
959 evas_object_rectangle_add(evas_object_evas_get(item->wd->self));
960 evas_object_color_set(item->spacer, 0, 0, 0, 0);
961 elm_widget_sub_object_add(item->wd->self, item->spacer);
962 evas_object_size_hint_min_set(item->spacer, 2 * _elm_config->scale, 1);
963 edje_object_part_swallow(item->base.view, "elm.swallow.pad", item->spacer);
965 if (item->gic->func.label_get)
971 elm_widget_stringlist_get(edje_object_data_get(item->base.view,
973 EINA_LIST_FOREACH(item->labels, l, key)
975 char *s = item->gic->func.label_get
976 ((void *)item->base.data, item->wd->self, l->data);
979 edje_object_part_text_set(item->base.view, l->data, s);
985 if (item->gic->func.icon_get)
991 elm_widget_stringlist_get(edje_object_data_get(item->base.view,
993 EINA_LIST_FOREACH(item->icons, l, key)
995 Evas_Object *ic = item->gic->func.icon_get
996 ((void *)item->base.data, item->wd->self, l->data);
999 item->icon_objs = eina_list_append(item->icon_objs, ic);
1000 edje_object_part_swallow(item->base.view, key, ic);
1001 evas_object_show(ic);
1002 elm_widget_sub_object_add(item->wd->self, ic);
1007 if (item->gic->func.state_get)
1013 elm_widget_stringlist_get(edje_object_data_get(item->base.view,
1015 EINA_LIST_FOREACH(item->states, l, key)
1017 Eina_Bool on = item->gic->func.state_get
1018 ((void *)item->base.data, item->wd->self, l->data);
1021 snprintf(buf, sizeof(buf), "elm,state,%s,active", key);
1022 edje_object_signal_emit(item->base.view, buf, "elm");
1027 if ((!item->wd->item_width) && (!item->wd->item_height))
1029 edje_object_size_min_restricted_calc(item->base.view,
1030 &item->wd->item_width,
1031 &item->wd->item_height,
1032 item->wd->item_width,
1033 item->wd->item_height);
1034 elm_coords_finger_size_adjust(1, &item->wd->item_width,
1035 1, &item->wd->item_height);
1038 evas_object_event_callback_add(item->base.view, EVAS_CALLBACK_MOUSE_DOWN,
1040 evas_object_event_callback_add(item->base.view, EVAS_CALLBACK_MOUSE_UP,
1042 evas_object_event_callback_add(item->base.view, EVAS_CALLBACK_MOUSE_MOVE,
1046 edje_object_signal_emit(item->base.view, "elm,state,selected", "elm");
1048 edje_object_signal_emit(item->base.view, "elm,state,disabled", "elm");
1050 evas_object_show(item->base.view);
1052 if (item->tooltip.content_cb)
1054 elm_widget_item_tooltip_content_cb_set(item,
1055 item->tooltip.content_cb,
1056 item->tooltip.data, NULL);
1057 elm_widget_item_tooltip_style_set(item, item->tooltip.style);
1060 if (item->mouse_cursor)
1061 elm_widget_item_cursor_set(item, item->mouse_cursor);
1063 item->realized = EINA_TRUE;
1064 item->want_unrealize = EINA_FALSE;
1068 _item_unrealize(Elm_Gengrid_Item *item)
1072 if (!item->realized) return;
1073 if (item->long_timer)
1075 ecore_timer_del(item->long_timer);
1076 item->long_timer = NULL;
1078 evas_object_del(item->base.view);
1079 item->base.view = NULL;
1080 evas_object_del(item->spacer);
1081 item->spacer = NULL;
1082 elm_widget_stringlist_free(item->labels);
1083 item->labels = NULL;
1084 elm_widget_stringlist_free(item->icons);
1086 elm_widget_stringlist_free(item->states);
1087 item->states = NULL;
1089 EINA_LIST_FREE(item->icon_objs, icon)
1090 evas_object_del(icon);
1092 item->realized = EINA_FALSE;
1093 item->want_unrealize = EINA_FALSE;
1097 _item_place(Elm_Gengrid_Item *item,
1101 Evas_Coord x, y, ox, oy, cvx, cvy, cvw, cvh;
1102 Evas_Coord tch, tcw, alignw = 0, alignh = 0, vw, vh;
1105 evas_object_geometry_get(item->wd->pan_smart, &ox, &oy, &vw, &vh);
1107 /* Preload rows/columns at each side of the Gengrid */
1108 cvx = ox - PRELOAD * item->wd->item_width;
1109 cvy = oy - PRELOAD * item->wd->item_height;
1110 cvw = vw + 2 * PRELOAD * item->wd->item_width;
1111 cvh = vh + 2 * PRELOAD * item->wd->item_height;
1116 if (item->wd->horizontal)
1118 int columns, items_visible = 0, items_row;
1120 if (item->wd->item_height > 0)
1121 items_visible = vh / item->wd->item_height;
1122 if (items_visible < 1)
1125 columns = item->wd->count / items_visible;
1126 if (item->wd->count % items_visible)
1129 tcw = item->wd->item_width * columns;
1130 alignw = (vw - tcw) * item->wd->align_x;
1132 items_row = items_visible;
1133 if (items_row > item->wd->count)
1134 items_row = item->wd->count;
1135 tch = items_row * item->wd->item_height;
1136 alignh = (vh - tch) * item->wd->align_y;
1140 int rows, items_visible = 0, items_col;
1142 if (item->wd->item_width > 0)
1143 items_visible = vw / item->wd->item_width;
1144 if (items_visible < 1)
1147 rows = item->wd->count / items_visible;
1148 if (item->wd->count % items_visible)
1151 tch = item->wd->item_height * rows;
1152 alignh = (vh - tch) * item->wd->align_y;
1154 items_col = items_visible;
1155 if (items_col > item->wd->count)
1156 items_col = item->wd->count;
1157 tcw = items_col * item->wd->item_width;
1158 alignw = (vw - tcw) * item->wd->align_x;
1161 x = cx * item->wd->item_width - item->wd->pan_x + ox + alignw;
1162 if (elm_widget_mirrored_get(item->wd->self))
1163 { /* Switch items side and componsate for pan_x when in RTL mode */
1165 evas_object_geometry_get(item->wd->self, NULL, NULL, &ww, NULL);
1166 x = ww - x - item->wd->item_width - item->wd->pan_x - item->wd->pan_x;
1169 y = cy * item->wd->item_height - item->wd->pan_y + oy + alignh;
1171 Eina_Bool was_realized = item->realized;
1172 if (ELM_RECTS_INTERSECT(x, y, item->wd->item_width, item->wd->item_height,
1173 cvx, cvy, cvw, cvh))
1175 _item_realize(item);
1177 evas_object_smart_callback_call(item->wd->self, "realized", item);
1178 evas_object_move(item->base.view, x, y);
1179 evas_object_resize(item->base.view, item->wd->item_width,
1180 item->wd->item_height);
1184 _item_unrealize(item);
1186 evas_object_smart_callback_call(item->wd->self, "unrealized", item);
1190 static Elm_Gengrid_Item *
1191 _item_create(Widget_Data *wd,
1192 const Elm_Gengrid_Item_Class *gic,
1195 const void *func_data)
1197 Elm_Gengrid_Item *item;
1199 item = elm_widget_item_new(wd->self, Elm_Gengrid_Item);
1200 if (!item) return NULL;
1204 item->base.data = data;
1205 item->func.func = func;
1206 item->func.data = func_data;
1207 item->mouse_cursor = NULL;
1212 _item_del(Elm_Gengrid_Item *item)
1214 elm_widget_item_pre_notify_del(item);
1216 item->wd->selected = eina_list_remove(item->wd->selected, item);
1217 if (item->realized) _item_unrealize(item);
1218 if ((!item->delete_me) && (item->gic->func.del))
1219 item->gic->func.del((void *)item->base.data, item->wd->self);
1220 item->delete_me = EINA_TRUE;
1221 item->wd->items = eina_inlist_remove(item->wd->items, EINA_INLIST_GET(item));
1222 if (item->long_timer) ecore_timer_del(item->long_timer);
1223 if (item->tooltip.del_cb)
1224 item->tooltip.del_cb((void *)item->tooltip.data, item->base.widget, item);
1225 item->wd->walking -= item->walking;
1227 if (item->wd->calc_job) ecore_job_del(item->wd->calc_job);
1228 item->wd->calc_job = ecore_job_add(_calc_job, item->wd);
1229 elm_widget_item_del(item);
1233 _item_select(Elm_Gengrid_Item *item)
1235 if ((item->wd->no_select) || (item->delete_me)) return;
1238 if (item->wd->always_select) goto call;
1241 item->selected = EINA_TRUE;
1242 item->wd->selected = eina_list_append(item->wd->selected, item);
1245 item->wd->walking++;
1246 if (item->func.func)
1247 item->func.func((void *)item->func.data, item->wd->self, item);
1248 if (!item->delete_me)
1249 evas_object_smart_callback_call(item->wd->self, "selected", item);
1251 item->wd->walking--;
1252 if ((item->wd->clear_me) && (!item->wd->walking))
1253 elm_gengrid_clear(item->base.widget);
1256 if ((!item->walking) && (item->delete_me))
1257 if (!item->relcount) _item_del(item);
1259 item->wd->last_selected_item = item;
1263 _item_unselect(Elm_Gengrid_Item *item)
1265 if ((item->delete_me) || (!item->hilighted)) return;
1266 edje_object_signal_emit(item->base.view, "elm,state,unselected", "elm");
1267 item->hilighted = EINA_FALSE;
1270 item->selected = EINA_FALSE;
1271 item->wd->selected = eina_list_remove(item->wd->selected, item);
1272 evas_object_smart_callback_call(item->wd->self, "unselected", item);
1277 _calc_job(void *data)
1279 Widget_Data *wd = data;
1280 Evas_Coord minw = 0, minh = 0, nmax = 0, cvw, cvh;
1283 evas_object_geometry_get(wd->pan_smart, NULL, NULL, &cvw, &cvh);
1284 if ((cvw != 0) || (cvh != 0))
1286 if ((wd->horizontal) && (wd->item_height > 0))
1287 nmax = cvh / wd->item_height;
1288 else if (wd->item_width > 0)
1289 nmax = cvw / wd->item_width;
1297 minw = ceil(count / (float)nmax) * wd->item_width;
1298 minh = nmax * wd->item_height;
1302 minw = nmax * wd->item_width;
1303 minh = ceil(count / (float)nmax) * wd->item_height;
1306 if ((minw != wd->minw) || (minh != wd->minh))
1310 evas_object_smart_callback_call(wd->pan_smart, "changed", NULL);
1314 wd->calc_job = NULL;
1315 evas_object_smart_changed(wd->pan_smart);
1320 _pan_add(Evas_Object *obj)
1323 Evas_Object_Smart_Clipped_Data *cd;
1326 cd = evas_object_smart_data_get(obj);
1329 sd->__clipped_data = *cd;
1331 evas_object_smart_data_set(obj, sd);
1335 _pan_del(Evas_Object *obj)
1337 Pan *sd = evas_object_smart_data_get(obj);
1344 _pan_set(Evas_Object *obj,
1348 Pan *sd = evas_object_smart_data_get(obj);
1349 if ((x == sd->wd->pan_x) && (y == sd->wd->pan_y)) return;
1352 evas_object_smart_changed(obj);
1356 _pan_get(Evas_Object *obj,
1360 Pan *sd = evas_object_smart_data_get(obj);
1361 if (x) *x = sd->wd->pan_x;
1362 if (y) *y = sd->wd->pan_y;
1366 _pan_child_size_get(Evas_Object *obj,
1370 Pan *sd = evas_object_smart_data_get(obj);
1371 if (w) *w = sd->wd->minw;
1372 if (h) *h = sd->wd->minh;
1376 _pan_max_get(Evas_Object *obj,
1380 Pan *sd = evas_object_smart_data_get(obj);
1384 evas_object_geometry_get(obj, NULL, NULL, &ow, &oh);
1386 *x = (ow < sd->wd->minw) ? sd->wd->minw - ow : 0;
1388 *y = (oh < sd->wd->minh) ? sd->wd->minh - oh : 0;
1392 _pan_min_get(Evas_Object *obj,
1396 Pan *sd = evas_object_smart_data_get(obj);
1400 _pan_max_get(obj, &mx, &my);
1402 *x = -mx * sd->wd->align_x;
1404 *y = -my * sd->wd->align_y;
1408 _pan_resize(Evas_Object *obj,
1412 Pan *sd = evas_object_smart_data_get(obj);
1415 evas_object_geometry_get(obj, NULL, NULL, &ow, &oh);
1416 if ((ow == w) && (oh == h)) return;
1417 if (sd->wd->calc_job) ecore_job_del(sd->wd->calc_job);
1418 sd->wd->calc_job = ecore_job_add(_calc_job, sd->wd);
1422 _pan_calculate(Evas_Object *obj)
1424 Pan *sd = evas_object_smart_data_get(obj);
1425 Evas_Coord cx = 0, cy = 0;
1426 Elm_Gengrid_Item *item;
1429 if (!sd->wd->nmax) return;
1431 EINA_INLIST_FOREACH(sd->wd->items, item)
1433 _item_place(item, cx, cy);
1434 if (sd->wd->horizontal)
1436 cy = (cy + 1) % sd->wd->nmax;
1441 cx = (cx + 1) % sd->wd->nmax;
1445 evas_object_smart_callback_call(sd->wd->self, "changed", NULL);
1449 _pan_move(Evas_Object *obj,
1450 Evas_Coord x __UNUSED__,
1451 Evas_Coord y __UNUSED__)
1453 Pan *sd = evas_object_smart_data_get(obj);
1455 if (sd->wd->calc_job) ecore_job_del(sd->wd->calc_job);
1456 sd->wd->calc_job = ecore_job_add(_calc_job, sd->wd);
1460 _hold_on(void *data __UNUSED__,
1462 void *event_info __UNUSED__)
1464 Widget_Data *wd = elm_widget_data_get(obj);
1466 elm_smart_scroller_hold_set(wd->scr, 1);
1470 _hold_off(void *data __UNUSED__,
1472 void *event_info __UNUSED__)
1474 Widget_Data *wd = elm_widget_data_get(obj);
1476 elm_smart_scroller_hold_set(wd->scr, 0);
1480 _freeze_on(void *data __UNUSED__,
1482 void *event_info __UNUSED__)
1484 Widget_Data *wd = elm_widget_data_get(obj);
1486 elm_smart_scroller_freeze_set(wd->scr, 1);
1490 _freeze_off(void *data __UNUSED__,
1492 void *event_info __UNUSED__)
1494 Widget_Data *wd = elm_widget_data_get(obj);
1496 elm_smart_scroller_freeze_set(wd->scr, 0);
1500 _scr_drag_start(void *data,
1501 Evas_Object *obj __UNUSED__,
1502 void *event_info __UNUSED__)
1504 evas_object_smart_callback_call(data, "scroll,drag,start", NULL);
1508 _scr_drag_stop(void *data,
1509 Evas_Object *obj __UNUSED__,
1510 void *event_info __UNUSED__)
1512 evas_object_smart_callback_call(data, "scroll,drag,stop", NULL);
1516 _scr_scroll(void *data,
1517 Evas_Object *obj __UNUSED__,
1518 void *event_info __UNUSED__)
1520 evas_object_smart_callback_call(data, "scroll", NULL);
1524 * Add a new Gengrid object.
1526 * @param parent The parent object.
1527 * @return The new object or NULL if it cannot be created.
1529 * @see elm_gengrid_item_size_set()
1530 * @see elm_gengrid_horizontal_set()
1531 * @see elm_gengrid_item_append()
1532 * @see elm_gengrid_item_del()
1533 * @see elm_gengrid_clear()
1538 elm_gengrid_add(Evas_Object *parent)
1543 static Evas_Smart *smart = NULL;
1544 Eina_Bool bounce = _elm_config->thumbscroll_bounce_enable;
1546 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
1548 wd = ELM_NEW(Widget_Data);
1549 e = evas_object_evas_get(parent);
1550 if (!e) return NULL;
1551 obj = elm_widget_add(e);
1552 ELM_SET_WIDTYPE(widtype, "gengrid");
1553 elm_widget_type_set(obj, "gengrid");
1554 elm_widget_sub_object_add(parent, obj);
1555 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
1556 elm_widget_data_set(obj, wd);
1557 elm_widget_del_hook_set(obj, _del_hook);
1558 elm_widget_del_pre_hook_set(obj, _del_pre_hook);
1559 elm_widget_theme_hook_set(obj, _theme_hook);
1560 elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
1561 elm_widget_can_focus_set(obj, EINA_TRUE);
1562 elm_widget_event_hook_set(obj, _event_hook);
1564 wd->scr = elm_smart_scroller_add(e);
1565 elm_smart_scroller_widget_set(wd->scr, obj);
1566 elm_smart_scroller_object_theme_set(obj, wd->scr, "gengrid", "base",
1568 elm_widget_resize_object_set(obj, wd->scr);
1570 evas_object_smart_callback_add(wd->scr, "drag,start", _scr_drag_start, obj);
1571 evas_object_smart_callback_add(wd->scr, "drag,stop", _scr_drag_stop, obj);
1572 evas_object_smart_callback_add(wd->scr, "scroll", _scr_scroll, obj);
1574 elm_smart_scroller_bounce_allow_set(wd->scr, bounce, bounce);
1579 wd->no_select = EINA_FALSE;
1581 evas_object_smart_callback_add(obj, "scroll-hold-on", _hold_on, obj);
1582 evas_object_smart_callback_add(obj, "scroll-hold-off", _hold_off, obj);
1583 evas_object_smart_callback_add(obj, "scroll-freeze-on", _freeze_on, obj);
1584 evas_object_smart_callback_add(obj, "scroll-freeze-off", _freeze_off, obj);
1588 static Evas_Smart_Class sc;
1590 evas_object_smart_clipped_smart_set(&_pan_sc);
1592 sc.name = "elm_gengrid_pan";
1593 sc.version = EVAS_SMART_CLASS_VERSION;
1596 sc.resize = _pan_resize;
1597 sc.move = _pan_move;
1598 sc.calculate = _pan_calculate;
1599 smart = evas_smart_class_new(&sc);
1603 wd->pan_smart = evas_object_smart_add(e, smart);
1604 wd->pan = evas_object_smart_data_get(wd->pan_smart);
1608 elm_smart_scroller_extern_pan_set(wd->scr, wd->pan_smart,
1609 _pan_set, _pan_get, _pan_max_get,
1610 _pan_min_get, _pan_child_size_get);
1612 _mirrored_set(obj, elm_widget_mirrored_get(obj));
1617 * Set the size for the item of the Gengrid.
1619 * @param obj The Gengrid object.
1620 * @param w The item's width.
1621 * @param h The item's height;
1623 * @see elm_gengrid_item_size_get()
1628 elm_gengrid_item_size_set(Evas_Object *obj,
1632 ELM_CHECK_WIDTYPE(obj, widtype);
1633 Widget_Data *wd = elm_widget_data_get(obj);
1635 if ((wd->item_width == w) && (wd->item_height == h)) return;
1637 wd->item_height = h;
1638 if (wd->calc_job) ecore_job_del(wd->calc_job);
1639 wd->calc_job = ecore_job_add(_calc_job, wd);
1643 * Get the size of the item of the Gengrid.
1645 * @param obj The Gengrid object.
1646 * @param w Pointer to the item's width.
1647 * @param h Pointer to the item's height.
1649 * @see elm_gengrid_item_size_get()
1654 elm_gengrid_item_size_get(const Evas_Object *obj,
1658 ELM_CHECK_WIDTYPE(obj, widtype);
1659 Widget_Data *wd = elm_widget_data_get(obj);
1661 if (w) *w = wd->item_width;
1662 if (h) *h = wd->item_height;
1666 * Set item's alignment within the scroller.
1668 * @param obj The Gengrid object.
1669 * @param align_x The x alignment (0 <= x <= 1).
1670 * @param align_y The y alignment (0 <= y <= 1).
1672 * @see elm_gengrid_align_get()
1677 elm_gengrid_align_set(Evas_Object *obj,
1681 ELM_CHECK_WIDTYPE(obj, widtype);
1682 Widget_Data *wd = elm_widget_data_get(obj);
1686 else if (align_x < 0.0)
1688 wd->align_x = align_x;
1692 else if (align_y < 0.0)
1694 wd->align_y = align_y;
1698 * Get the alignenment set for the Gengrid object.
1700 * @param obj The Gengrid object.
1701 * @param align_x Pointer to x alignenment.
1702 * @param align_y Pointer to y alignenment.
1704 * @see elm_gengrid_align_set()
1709 elm_gengrid_align_get(const Evas_Object *obj,
1713 ELM_CHECK_WIDTYPE(obj, widtype);
1714 Widget_Data *wd = elm_widget_data_get(obj);
1715 if (align_x) *align_x = wd->align_x;
1716 if (align_y) *align_y = wd->align_y;
1720 * Add item to the end of the Gengrid.
1722 * @param obj The Gengrid object.
1723 * @param gic The item class for the item.
1724 * @param data The item data.
1725 * @param func Convenience function called when item is selected.
1726 * @param func_data Data passed to @p func above.
1727 * @return A handle to the item added or NULL if not possible.
1729 * @see elm_gengrid_item_prepend()
1730 * @see elm_gengrid_item_insert_before()
1731 * @see elm_gengrid_item_insert_after()
1732 * @see elm_gengrid_item_del()
1736 EAPI Elm_Gengrid_Item *
1737 elm_gengrid_item_append(Evas_Object *obj,
1738 const Elm_Gengrid_Item_Class *gic,
1741 const void *func_data)
1743 Elm_Gengrid_Item *item;
1744 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1745 Widget_Data *wd = elm_widget_data_get(obj);
1746 if (!wd) return NULL;
1748 item = _item_create(wd, gic, data, func, func_data);
1749 if (!item) return NULL;
1750 wd->items = eina_inlist_append(wd->items, EINA_INLIST_GET(item));
1752 if (wd->calc_job) ecore_job_del(wd->calc_job);
1753 wd->calc_job = ecore_job_add(_calc_job, wd);
1759 * Add item at start of the Gengrid.
1761 * This adds an item to the beginning of the grid.
1763 * @param obj The Gengrid object.
1764 * @param gic The item class for the item.
1765 * @param data The item data.
1766 * @param func Convenience function called when item is selected.
1767 * @param func_data Data passed to @p func above.
1768 * @return A handle to the item added or NULL if not possible.
1770 * @see elm_gengrid_item_append()
1771 * @see elm_gengrid_item_insert_before()
1772 * @see elm_gengrid_item_insert_after()
1773 * @see elm_gengrid_item_del()
1777 EAPI Elm_Gengrid_Item *
1778 elm_gengrid_item_prepend(Evas_Object *obj,
1779 const Elm_Gengrid_Item_Class *gic,
1782 const void *func_data)
1784 Elm_Gengrid_Item *item;
1785 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1786 Widget_Data *wd = elm_widget_data_get(obj);
1787 if (!wd) return NULL;
1789 item = _item_create(wd, gic, data, func, func_data);
1790 if (!item) return NULL;
1791 wd->items = eina_inlist_prepend(wd->items, EINA_INLIST_GET(item));
1793 if (wd->calc_job) ecore_job_del(wd->calc_job);
1794 wd->calc_job = ecore_job_add(_calc_job, wd);
1800 * Insert and item before another in the Gengrid.
1802 * This inserts an item before another in the grid.
1804 * @param obj The Gengrid object.
1805 * @param gic The item class for the item.
1806 * @param data The item data.
1807 * @param relative The item to which insert before.
1808 * @param func Convenience function called when item is selected.
1809 * @param func_data Data passed to @p func above.
1810 * @return A handle to the item added or NULL if not possible.
1812 * @see elm_gengrid_item_append()
1813 * @see elm_gengrid_item_prepend()
1814 * @see elm_gengrid_item_insert_after()
1815 * @see elm_gengrid_item_del()
1819 EAPI Elm_Gengrid_Item *
1820 elm_gengrid_item_insert_before(Evas_Object *obj,
1821 const Elm_Gengrid_Item_Class *gic,
1823 Elm_Gengrid_Item *relative,
1825 const void *func_data)
1827 Elm_Gengrid_Item *item;
1828 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1829 EINA_SAFETY_ON_NULL_RETURN_VAL(relative, NULL);
1830 Widget_Data *wd = elm_widget_data_get(obj);
1831 if (!wd) return NULL;
1833 item = _item_create(wd, gic, data, func, func_data);
1834 if (!item) return NULL;
1835 wd->items = eina_inlist_prepend_relative
1836 (wd->items, EINA_INLIST_GET(item), EINA_INLIST_GET(relative));
1838 if (wd->calc_job) ecore_job_del(wd->calc_job);
1839 wd->calc_job = ecore_job_add(_calc_job, wd);
1845 * Insert and item after another in the Gengrid.
1847 * This inserts an item after another in the grid.
1849 * @param obj The Gengrid object.
1850 * @param gic The item class for the item.
1851 * @param data The item data.
1852 * @param relative The item to which insert after.
1853 * @param func Convenience function called when item is selected.
1854 * @param func_data Data passed to @p func above.
1855 * @return A handle to the item added or NULL if not possible.
1857 * @see elm_gengrid_item_append()
1858 * @see elm_gengrid_item_prepend()
1859 * @see elm_gengrid_item_insert_before()
1860 * @see elm_gengrid_item_del()
1864 EAPI Elm_Gengrid_Item *
1865 elm_gengrid_item_insert_after(Evas_Object *obj,
1866 const Elm_Gengrid_Item_Class *gic,
1868 Elm_Gengrid_Item *relative,
1870 const void *func_data)
1872 Elm_Gengrid_Item *item;
1873 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1874 EINA_SAFETY_ON_NULL_RETURN_VAL(relative, NULL);
1875 Widget_Data *wd = elm_widget_data_get(obj);
1876 if (!wd) return NULL;
1878 item = _item_create(wd, gic, data, func, func_data);
1879 if (!item) return NULL;
1880 wd->items = eina_inlist_append_relative
1881 (wd->items, EINA_INLIST_GET(item), EINA_INLIST_GET(relative));
1883 if (wd->calc_job) ecore_job_del(wd->calc_job);
1884 wd->calc_job = ecore_job_add(_calc_job, wd);
1890 * Remove a item from the Gengrid.
1892 * @param item The item to be removed.
1893 * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise.
1895 * @see elm_gengrid_clear() to remove all items of the Gengrid.
1900 elm_gengrid_item_del(Elm_Gengrid_Item *item)
1902 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
1903 if ((item->relcount > 0) || (item->walking > 0))
1905 item->delete_me = EINA_TRUE;
1906 elm_widget_item_pre_notify_del(item);
1908 item->wd->selected = eina_list_remove(item->wd->selected, item);
1909 if (item->gic->func.del)
1910 item->gic->func.del((void *)item->base.data, item->wd->self);
1918 * Set for what direction the Gengrid will expand.
1920 * @param obj The Gengrid object.
1921 * @param setting If @c EINA_TRUE the Gengrid will expand horizontally
1922 * or vertically if @c EINA_FALSE.
1927 elm_gengrid_horizontal_set(Evas_Object *obj,
1930 ELM_CHECK_WIDTYPE(obj, widtype);
1931 Widget_Data *wd = elm_widget_data_get(obj);
1933 if (setting == wd->horizontal) return;
1934 wd->horizontal = setting;
1936 /* Update the items to conform to the new layout */
1937 if (wd->calc_job) ecore_job_del(wd->calc_job);
1938 wd->calc_job = ecore_job_add(_calc_job, wd);
1944 * This clears all items in the Gengrid, leaving it empty.
1946 * @param obj The Gengrid object.
1948 * @see elm_gengrid_item_del() to remove just one item.
1953 elm_gengrid_clear(Evas_Object *obj)
1955 ELM_CHECK_WIDTYPE(obj, widtype);
1956 Widget_Data *wd = elm_widget_data_get(obj);
1961 ecore_job_del(wd->calc_job);
1962 wd->calc_job = NULL;
1965 if (wd->walking > 0)
1967 Elm_Gengrid_Item *item;
1969 EINA_INLIST_FOREACH(wd->items, item)
1970 item->delete_me = 1;
1976 Elm_Gengrid_Item *item = ELM_GENGRID_ITEM_FROM_INLIST(wd->items);
1978 wd->items = eina_inlist_remove(wd->items, wd->items);
1979 elm_widget_item_pre_notify_del(item);
1980 if (item->realized) _item_unrealize(item);
1981 if (item->gic->func.del)
1982 item->gic->func.del((void *)item->base.data, wd->self);
1983 if (item->long_timer) ecore_timer_del(item->long_timer);
1984 elm_widget_item_del(item);
1989 eina_list_free(wd->selected);
1990 wd->selected = NULL;
1998 evas_object_size_hint_min_set(wd->pan_smart, wd->minw, wd->minh);
1999 evas_object_smart_callback_call(wd->pan_smart, "changed", NULL);
2003 * Get the real evas object of the Gengrid item
2005 * This returns the actual evas object used for the specified Gengrid
2006 * item. This may be NULL as it may not be created, and may be
2007 * deleted at any time by Gengrid. Do not modify this object (move,
2008 * resize, show, hide etc.) as Gengrid is controlling it. This
2009 * function is for querying, emitting custom signals or hooking lower
2010 * level callbacks for events. Do not delete this object under any
2013 * @param item The Gengrid item.
2014 * @return the evas object associated to this item.
2016 * @see elm_gengrid_item_data_get()
2020 EAPI const Evas_Object *
2021 elm_gengrid_item_object_get(const Elm_Gengrid_Item *item)
2023 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2024 return item->base.view;
2028 * Update the contents of an item
2030 * This updates an item by calling all the item class functions again
2031 * to get the icons, labels and states. Use this when the original
2032 * item data has changed and the changes are desired to be reflected.
2034 * @param item The item
2039 elm_gengrid_item_update(Elm_Gengrid_Item *item)
2041 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2042 if (!item->realized) return;
2043 if (item->want_unrealize) return;
2044 _item_unrealize(item);
2045 _item_realize(item);
2046 _item_place(item, item->x, item->y);
2050 * Returns the data associated to a item
2052 * This returns the data value passed on the elm_gengrid_item_append()
2053 * and related item addition calls.
2055 * @param item The Gengrid item.
2056 * @return the data associated to this item.
2058 * @see elm_gengrid_item_append()
2059 * @see elm_gengrid_item_object_get()
2064 elm_gengrid_item_data_get(const Elm_Gengrid_Item *item)
2066 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2067 return elm_widget_item_data_get(item);
2071 * Set the data item from the gengrid item
2073 * This set the data value passed on the elm_gengrid_item_append() and
2074 * related item addition calls. This function will also call
2075 * elm_gengrid_item_update() so the item will be updated to reflect
2078 * @param item The item
2079 * @param data The new data pointer to set
2084 elm_gengrid_item_data_set(Elm_Gengrid_Item *item,
2087 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2088 elm_widget_item_data_set(item, data);
2089 elm_gengrid_item_update(item);
2093 * Get the item's coordinates.
2095 * This returns the logical position of the item whithin the Gengrid.
2097 * @param item The Gengrid item.
2098 * @param x The x-axis coordinate pointer.
2099 * @param y The y-axis coordinate pointer.
2104 elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item,
2108 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2109 if (x) *x = item->x;
2110 if (y) *y = item->y;
2114 * Enable or disable multi-select in the Gengrid.
2116 * This enables (EINA_TRUE) or disables (EINA_FALSE) multi-select in
2117 * the Gengrid. This allows more than 1 item to be selected.
2119 * @param obj The Gengrid object.
2120 * @param multi Multi-select enabled/disabled
2125 elm_gengrid_multi_select_set(Evas_Object *obj,
2128 ELM_CHECK_WIDTYPE(obj, widtype);
2129 Widget_Data *wd = elm_widget_data_get(obj);
2135 * Get if multi-select in Gengrid is enabled or disabled
2137 * @param obj The Gengrid object
2138 * @return Multi-select enable/disable
2139 * (EINA_TRUE = enabled / EINA_FALSE = disabled)
2144 elm_gengrid_multi_select_get(const Evas_Object *obj)
2146 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
2147 Widget_Data *wd = elm_widget_data_get(obj);
2148 if (!wd) return EINA_FALSE;
2153 * Get the selected item in the Gengrid
2155 * This gets the selected item in the Gengrid (if multi-select is
2156 * enabled only the first item in the list is selected - which is not
2157 * very useful, so see elm_gengrid_selected_items_get() for when
2158 * multi-select is used).
2160 * If no item is selected, NULL is returned.
2162 * @param obj The Gengrid object.
2163 * @return The selected item, or NULL if none.
2167 EAPI Elm_Gengrid_Item *
2168 elm_gengrid_selected_item_get(const Evas_Object *obj)
2170 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
2171 Widget_Data *wd = elm_widget_data_get(obj);
2172 if (!wd) return NULL;
2173 if (wd->selected) return wd->selected->data;
2178 * Get a list of selected items in the Gengrid.
2180 * This returns a list of the selected items. This list pointer is
2181 * only valid so long as no items are selected or unselected (or
2182 * unselected implictly by deletion). The list contains
2183 * Elm_Gengrid_Item pointers.
2185 * @param obj The Gengrid object.
2186 * @return The list of selected items, or NULL if none are selected.
2190 EAPI const Eina_List *
2191 elm_gengrid_selected_items_get(const Evas_Object *obj)
2193 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
2194 Widget_Data *wd = elm_widget_data_get(obj);
2195 if (!wd) return NULL;
2196 return wd->selected;
2200 * Set the selected state of a item.
2202 * This sets the selected state of a item. If multi-select is not
2203 * enabled and selected is EINA_TRUE, previously selected items are
2206 * @param item The item
2207 * @param selected The selected state.
2212 elm_gengrid_item_selected_set(Elm_Gengrid_Item *item,
2215 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2216 Widget_Data *wd = item->wd;
2218 if (item->delete_me) return;
2219 selected = !!selected;
2220 if (item->selected == selected) return;
2226 while (wd->selected)
2227 _item_unselect(wd->selected->data);
2229 _item_hilight(item);
2233 _item_unselect(item);
2237 * Get the selected state of a item.
2239 * This gets the selected state of a item (1 selected, 0 not selected).
2241 * @param item The item
2242 * @return The selected state
2247 elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item)
2249 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, EINA_FALSE);
2250 return item->selected;
2254 * Sets the disabled state of a item.
2256 * A disabled item cannot be selected or unselected. It will also
2257 * change appearance to disabled. This sets the disabled state (1
2258 * disabled, 0 not disabled).
2260 * @param item The item
2261 * @param disabled The disabled state
2266 elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item,
2269 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2270 if (item->disabled == disabled) return;
2271 if (item->delete_me) return;
2272 item->disabled = disabled;
2276 edje_object_signal_emit(item->base.view, "elm,state,disabled", "elm");
2278 edje_object_signal_emit(item->base.view, "elm,state,enabled", "elm");
2283 * Get the disabled state of a item.
2285 * This gets the disabled state of the given item.
2287 * @param item The item
2288 * @return The disabled state
2293 elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item)
2295 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, EINA_FALSE);
2296 if (item->delete_me) return EINA_FALSE;
2297 return item->disabled;
2300 static Evas_Object *
2301 _elm_gengrid_item_label_create(void *data,
2303 void *item __UNUSED__)
2305 Evas_Object *label = elm_label_add(obj);
2308 elm_object_style_set(label, "tooltip");
2309 elm_label_label_set(label, data);
2314 _elm_gengrid_item_label_del_cb(void *data,
2315 Evas_Object *obj __UNUSED__,
2316 void *event_info __UNUSED__)
2318 eina_stringshare_del(data);
2322 * Set the text to be shown in the gengrid item.
2324 * @param item Target item
2325 * @param text The text to set in the content
2327 * Setup the text as tooltip to object. The item can have only one
2328 * tooltip, so any previous tooltip data is removed.
2333 elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item,
2336 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2337 text = eina_stringshare_add(text);
2338 elm_gengrid_item_tooltip_content_cb_set(item, _elm_gengrid_item_label_create,
2340 _elm_gengrid_item_label_del_cb);
2344 * Set the content to be shown in the tooltip item
2346 * Setup the tooltip to item. The item can have only one tooltip, so
2347 * any previous tooltip data is removed. @p func(with @p data) will be
2348 * called every time that need show the tooltip and it should return a
2349 * valid Evas_Object. This object is then managed fully by tooltip
2350 * system and is deleted when the tooltip is gone.
2352 * @param item the gengrid item being attached a tooltip.
2353 * @param func the function used to create the tooltip contents.
2354 * @param data what to provide to @a func as callback data/context.
2355 * @param del_cb called when data is not needed anymore, either when
2356 * another callback replaces @func, the tooltip is unset with
2357 * elm_gengrid_item_tooltip_unset() or the owner @a item
2358 * dies. This callback receives as the first parameter the
2359 * given @a data, and @c event_info is the item.
2364 elm_gengrid_item_tooltip_content_cb_set(Elm_Gengrid_Item *item,
2365 Elm_Tooltip_Item_Content_Cb func,
2367 Evas_Smart_Cb del_cb)
2369 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(item, error);
2371 if ((item->tooltip.content_cb == func) && (item->tooltip.data == data))
2374 if (item->tooltip.del_cb)
2375 item->tooltip.del_cb((void *)item->tooltip.data,
2376 item->base.widget, item);
2377 item->tooltip.content_cb = func;
2378 item->tooltip.data = data;
2379 item->tooltip.del_cb = del_cb;
2380 if (item->base.view)
2382 elm_widget_item_tooltip_content_cb_set(item,
2383 item->tooltip.content_cb,
2384 item->tooltip.data, NULL);
2385 elm_widget_item_tooltip_style_set(item, item->tooltip.style);
2391 if (del_cb) del_cb((void *)data, NULL, NULL);
2395 * Unset tooltip from item
2397 * @param item gengrid item to remove previously set tooltip.
2399 * Remove tooltip from item. The callback provided as del_cb to
2400 * elm_gengrid_item_tooltip_content_cb_set() will be called to notify
2401 * it is not used anymore.
2403 * @see elm_gengrid_item_tooltip_content_cb_set()
2408 elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item)
2410 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2411 if ((item->base.view) && (item->tooltip.content_cb))
2412 elm_widget_item_tooltip_unset(item);
2414 if (item->tooltip.del_cb)
2415 item->tooltip.del_cb((void *)item->tooltip.data, item->base.widget, item);
2416 item->tooltip.del_cb = NULL;
2417 item->tooltip.content_cb = NULL;
2418 item->tooltip.data = NULL;
2419 if (item->tooltip.style)
2420 elm_gengrid_item_tooltip_style_set(item, NULL);
2424 * Sets a different style for this item tooltip.
2426 * @note before you set a style you should define a tooltip with
2427 * elm_gengrid_item_tooltip_content_cb_set() or
2428 * elm_gengrid_item_tooltip_text_set()
2430 * @param item gengrid item with tooltip already set.
2431 * @param style the theme style to use (default, transparent, ...)
2436 elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item,
2439 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2440 eina_stringshare_replace(&item->tooltip.style, style);
2441 if (item->base.view) elm_widget_item_tooltip_style_set(item, style);
2445 * Get the style for this item tooltip.
2447 * @param item gengrid item with tooltip already set.
2448 * @return style the theme style in use, defaults to "default". If the
2449 * object does not have a tooltip set, then NULL is returned.
2454 elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item)
2456 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2457 return item->tooltip.style;
2461 * Set the cursor to be shown when mouse is over the gengrid item
2463 * @param item Target item
2464 * @param cursor the cursor name to be used.
2466 * @see elm_object_cursor_set()
2470 elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item,
2473 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2474 eina_stringshare_replace(&item->mouse_cursor, cursor);
2475 if (item->base.view) elm_widget_item_cursor_set(item, cursor);
2479 * Get the cursor to be shown when mouse is over the gengrid item
2481 * @param item gengrid item with cursor already set.
2482 * @return the cursor name.
2487 elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item)
2489 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2490 return elm_widget_item_cursor_get(item);
2494 * Unset the cursor to be shown when mouse is over the gengrid item
2496 * @param item Target item
2498 * @see elm_object_cursor_unset()
2502 elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item)
2504 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2505 if (!item->mouse_cursor)
2508 if (item->base.view)
2509 elm_widget_item_cursor_unset(item);
2511 eina_stringshare_del(item->mouse_cursor);
2512 item->mouse_cursor = NULL;
2516 * Sets a different style for this item cursor.
2518 * @note before you set a style you should define a cursor with
2519 * elm_gengrid_item_cursor_set()
2521 * @param item gengrid item with cursor already set.
2522 * @param style the theme style to use (default, transparent, ...)
2527 elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item,
2530 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2531 elm_widget_item_cursor_style_set(item, style);
2535 * Get the style for this item cursor.
2537 * @param item gengrid item with cursor already set.
2538 * @return style the theme style in use, defaults to "default". If the
2539 * object does not have a cursor set, then NULL is returned.
2544 elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item)
2546 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2547 return elm_widget_item_cursor_style_get(item);
2551 * Set if the cursor set should be searched on the theme or should use
2552 * the provided by the engine, only.
2554 * @note before you set if should look on theme you should define a
2555 * cursor with elm_object_cursor_set(). By default it will only look
2556 * for cursors provided by the engine.
2558 * @param item widget item with cursor already set.
2559 * @param engine_only boolean to define it cursors should be looked
2560 * only between the provided by the engine or searched on widget's
2566 elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item,
2567 Eina_Bool engine_only)
2569 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2570 elm_widget_item_cursor_engine_only_set(item, engine_only);
2574 * Get the cursor engine only usage for this item cursor.
2576 * @param item widget item with cursor already set.
2577 * @return engine_only boolean to define it cursors should be looked
2578 * only between the provided by the engine or searched on widget's
2579 * theme as well. If the object does not have a cursor set, then
2580 * EINA_FALSE is returned.
2585 elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item)
2587 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, EINA_FALSE);
2588 return elm_widget_item_cursor_engine_only_get(item);
2592 * Set the always select mode.
2594 * Cells will only call their selection func and callback when first
2595 * becoming selected. Any further clicks will do nothing, unless you
2596 * enable always select with
2597 * elm_gengrid_always_select_mode_set(). This means even if selected,
2598 * every click will make the selected callbacks be called.
2600 * @param obj The Gengrid object
2601 * @param always_select The always select mode (EINA_TRUE = on,
2607 elm_gengrid_always_select_mode_set(Evas_Object *obj,
2608 Eina_Bool always_select)
2610 ELM_CHECK_WIDTYPE(obj, widtype);
2611 Widget_Data *wd = elm_widget_data_get(obj);
2613 wd->always_select = always_select;
2617 * Get the always select mode.
2619 * @param obj The Gengrid object.
2620 * @return The always select mode (EINA_TRUE = on, EINA_FALSE = off)
2625 elm_gengrid_always_select_mode_get(const Evas_Object *obj)
2627 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
2628 Widget_Data *wd = elm_widget_data_get(obj);
2629 if (!wd) return EINA_FALSE;
2630 return wd->always_select;
2634 * Set no select mode.
2636 * This will turn off the ability to select items entirely and they
2637 * will neither appear selected nor call selected callback functions.
2639 * @param obj The Gengrid object
2640 * @param no_select The no select mode (EINA_TRUE = on, EINA_FALSE = off)
2645 elm_gengrid_no_select_mode_set(Evas_Object *obj,
2646 Eina_Bool no_select)
2648 ELM_CHECK_WIDTYPE(obj, widtype);
2649 Widget_Data *wd = elm_widget_data_get(obj);
2651 wd->no_select = no_select;
2655 * Gets no select mode.
2657 * @param obj The Gengrid object
2658 * @return The no select mode (EINA_TRUE = on, EINA_FALSE = off)
2663 elm_gengrid_no_select_mode_get(const Evas_Object *obj)
2665 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
2666 Widget_Data *wd = elm_widget_data_get(obj);
2667 if (!wd) return EINA_FALSE;
2668 return wd->no_select;
2674 * This will enable or disable the scroller bounce mode for the
2675 * Gengrid. See elm_scroller_bounce_set() for details.
2677 * @param obj The Gengrid object
2678 * @param h_bounce Allow bounce horizontally
2679 * @param v_bounce Allow bounce vertically
2684 elm_gengrid_bounce_set(Evas_Object *obj,
2688 ELM_CHECK_WIDTYPE(obj, widtype);
2689 Widget_Data *wd = elm_widget_data_get(obj);
2691 elm_smart_scroller_bounce_allow_set(wd->scr, h_bounce, v_bounce);
2695 * Get the bounce mode
2697 * @param obj The Gengrid object
2698 * @param h_bounce Allow bounce horizontally
2699 * @param v_bounce Allow bounce vertically
2704 elm_gengrid_bounce_get(const Evas_Object *obj,
2705 Eina_Bool *h_bounce,
2706 Eina_Bool *v_bounce)
2708 ELM_CHECK_WIDTYPE(obj, widtype);
2709 Widget_Data *wd = elm_widget_data_get(obj);
2711 elm_smart_scroller_bounce_allow_get(wd->scr, h_bounce, v_bounce);
2715 * Get all items in the Gengrid.
2717 * This returns a list of the Gengrid items. The list contains
2718 * Elm_Gengrid_Item pointers.
2720 * @param obj The Gengrid object.
2721 * @return The list of items, or NULL if none.
2727 * Set gengrid scroll page size relative to viewport size.
2729 * The gengrid scroller is capable of limiting scrolling by the user
2730 * to "pages" That is to jump by and only show a "whole page" at a
2731 * time as if the continuous area of the scroller content is split
2732 * into page sized pieces. This sets the size of a page relative to
2733 * the viewport of the scroller. 1.0 is "1 viewport" is size
2734 * (horizontally or vertically). 0.0 turns it off in that axis. This
2735 * is mutually exclusive with page size (see
2736 * elm_gengrid_page_size_set() for more information). Likewise 0.5 is
2737 * "half a viewport". Sane usable valus are normally between 0.0 and
2738 * 1.0 including 1.0. If you only want 1 axis to be page "limited",
2739 * use 0.0 for the other axis.
2741 * @param obj The gengrid object
2742 * @param h_pagerel The horizontal page relative size
2743 * @param v_pagerel The vertical page relative size
2748 elm_gengrid_page_relative_set(Evas_Object *obj,
2752 Evas_Coord pagesize_h;
2753 Evas_Coord pagesize_v;
2755 ELM_CHECK_WIDTYPE(obj, widtype);
2756 Widget_Data *wd = elm_widget_data_get(obj);
2759 elm_smart_scroller_paging_get(wd->scr, NULL, NULL, &pagesize_h, &pagesize_v);
2760 elm_smart_scroller_paging_set(wd->scr, h_pagerel, v_pagerel, pagesize_h,
2765 * Set gengrid scroll page size.
2767 * See also elm_gengrid_page_relative_set(). This, instead of a page
2768 * size being relative to the viewport, sets it to an absolute fixed
2769 * value, with 0 turning it off for that axis.
2771 * @param obj The gengrid object
2772 * @param h_pagesize The horizontal page size
2773 * @param v_pagesize The vertical page size
2778 elm_gengrid_page_size_set(Evas_Object *obj,
2779 Evas_Coord h_pagesize,
2780 Evas_Coord v_pagesize)
2785 ELM_CHECK_WIDTYPE(obj, widtype);
2786 Widget_Data *wd = elm_widget_data_get(obj);
2788 elm_smart_scroller_paging_get(wd->scr, &pagerel_h, &pagerel_v, NULL, NULL);
2789 elm_smart_scroller_paging_set(wd->scr, pagerel_h, pagerel_v, h_pagesize,
2794 * Get the first item in the gengrid
2796 * This returns the first item in the list.
2798 * @param obj The gengrid object
2799 * @return The first item, or NULL if none
2803 EAPI Elm_Gengrid_Item *
2804 elm_gengrid_first_item_get(const Evas_Object *obj)
2806 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
2807 Widget_Data *wd = elm_widget_data_get(obj);
2808 if (!wd) return NULL;
2809 if (!wd->items) return NULL;
2810 Elm_Gengrid_Item *item = ELM_GENGRID_ITEM_FROM_INLIST(wd->items);
2811 while ((item) && (item->delete_me))
2812 item = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(item)->next);
2817 * Get the last item in the gengrid
2819 * This returns the last item in the list.
2821 * @return The last item, or NULL if none
2825 EAPI Elm_Gengrid_Item *
2826 elm_gengrid_last_item_get(const Evas_Object *obj)
2828 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
2829 Widget_Data *wd = elm_widget_data_get(obj);
2830 if (!wd) return NULL;
2831 if (!wd->items) return NULL;
2832 Elm_Gengrid_Item *item = ELM_GENGRID_ITEM_FROM_INLIST(wd->items->last);
2833 while ((item) && (item->delete_me))
2834 item = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(item)->prev);
2839 * Get the next item in the gengrid
2841 * This returns the item after the item @p item.
2843 * @param item The item
2844 * @return The item after @p item, or NULL if none
2848 EAPI Elm_Gengrid_Item *
2849 elm_gengrid_item_next_get(const Elm_Gengrid_Item *item)
2851 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2854 item = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(item)->next);
2855 if ((item) && (!item->delete_me)) break;
2857 return (Elm_Gengrid_Item *)item;
2861 * Get the previous item in the gengrid
2863 * This returns the item before the item @p item.
2865 * @param item The item
2866 * @return The item before @p item, or NULL if none
2870 EAPI Elm_Gengrid_Item *
2871 elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item)
2873 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2876 item = ELM_GENGRID_ITEM_FROM_INLIST(EINA_INLIST_GET(item)->prev);
2877 if ((item) && (!item->delete_me)) break;
2879 return (Elm_Gengrid_Item *)item;
2883 * Get the gengrid object from an item
2885 * This returns the gengrid object itself that an item belongs to.
2887 * @param item The item
2888 * @return The gengrid object
2893 elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item)
2895 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
2896 return item->base.widget;
2900 * Show the given item
2902 * This causes gengrid to jump to the given item @p item and show it
2903 * (by scrolling), if it is not fully visible.
2905 * @param item The item
2910 elm_gengrid_item_show(Elm_Gengrid_Item *item)
2912 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2913 Widget_Data *wd = elm_widget_data_get(item->wd->self);
2914 Evas_Coord minx = 0, miny = 0;
2917 if ((!item) || (item->delete_me)) return;
2918 _pan_min_get(wd->pan_smart, &minx, &miny);
2920 elm_smart_scroller_child_region_show(item->wd->scr,
2921 item->x * wd->item_width + minx,
2922 item->y * wd->item_height + miny,
2923 item->wd->item_width,
2924 item->wd->item_height);
2928 * Bring in the given item
2930 * This causes gengrig to jump to the given item @p item and show it
2931 * (by scrolling), if it is not fully visible. This may use animation
2932 * to do so and take a period of time
2934 * @param item The item
2939 elm_gengrid_item_bring_in(Elm_Gengrid_Item *item)
2941 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
2942 if (item->delete_me) return;
2944 Evas_Coord minx = 0, miny = 0;
2945 Widget_Data *wd = elm_widget_data_get(item->wd->self);
2947 _pan_min_get(wd->pan_smart, &minx, &miny);
2949 elm_smart_scroller_region_bring_in(item->wd->scr,
2950 item->x * wd->item_width + minx,
2951 item->y * wd->item_height + miny,
2952 item->wd->item_width,
2953 item->wd->item_height);