1 #include <Elementary.h>
4 static const char SMART_NAME[] = "elm_widget";
7 Smart_Data * sd = evas_object_smart_data_get(obj); \
8 if ((!obj) || (!sd) || (!_elm_widget_is(obj)))
9 #define INTERNAL_ENTRY \
10 Smart_Data * sd = evas_object_smart_data_get(obj); \
13 typedef struct _Smart_Data Smart_Data;
14 typedef struct _Edje_Signal_Data Edje_Signal_Data;
15 typedef struct _Elm_Event_Cb_Data Elm_Event_Cb_Data;
21 Evas_Object *parent_obj;
22 Evas_Coord x, y, w, h;
24 Evas_Object *resize_obj;
25 Evas_Object *hover_obj;
26 Eina_List *tooltips, *cursors;
27 void (*del_func)(Evas_Object *obj);
28 void (*del_pre_func)(Evas_Object *obj);
29 void (*focus_func)(Evas_Object *obj);
30 void (*activate_func)(Evas_Object *obj);
31 void (*disable_func)(Evas_Object *obj);
32 void (*theme_func)(Evas_Object *obj);
33 Eina_Bool (*event_func)(Evas_Object *obj,
35 Evas_Callback_Type type,
37 void (*signal_func)(Evas_Object *obj,
40 void (*callback_add_func)(Evas_Object *obj,
45 void (*callback_del_func)(Evas_Object *obj,
50 void (*changed_func)(Evas_Object *obj);
51 Eina_Bool (*focus_next_func)(const Evas_Object *obj,
52 Elm_Focus_Direction dir,
54 void (*on_focus_func)(void *data,
57 void (*on_change_func)(void *data,
60 void (*on_show_region_func)(void *data,
62 void *on_show_region_data;
63 void (*focus_region_func)(Evas_Object *obj,
68 void (*on_focus_region_func)(const Evas_Object *obj,
74 Evas_Coord rx, ry, rw, rh;
80 unsigned int focus_order;
81 Eina_Bool focus_order_on_calc;
83 int child_drag_x_locked;
84 int child_drag_y_locked;
86 Eina_List *edje_signals;
88 Eina_Bool drag_x_locked : 1;
89 Eina_Bool drag_y_locked : 1;
91 Eina_Bool can_focus : 1;
92 Eina_Bool child_can_focus : 1;
93 Eina_Bool focused : 1;
94 Eina_Bool highlight_ignore : 1;
95 Eina_Bool highlight_in_theme : 1;
96 Eina_Bool disabled : 1;
97 Eina_Bool is_mirrored : 1;
98 Eina_Bool mirrored_auto_mode : 1; /* This is TRUE by default */
100 Eina_List *focus_chain;
104 struct _Edje_Signal_Data
108 const char *emission;
113 struct _Elm_Event_Cb_Data
119 /* local subsystem functions */
120 static void _smart_reconfigure(Smart_Data *sd);
121 static void _smart_add(Evas_Object *obj);
122 static void _smart_del(Evas_Object *obj);
123 static void _smart_move(Evas_Object *obj,
126 static void _smart_resize(Evas_Object *obj,
129 static void _smart_show(Evas_Object *obj);
130 static void _smart_hide(Evas_Object *obj);
131 static void _smart_color_set(Evas_Object *obj,
136 static void _smart_clip_set(Evas_Object *obj,
138 static void _smart_clip_unset(Evas_Object *obj);
139 static void _smart_calculate(Evas_Object *obj);
140 static void _smart_init(void);
142 static void _if_focused_revert(Evas_Object *obj,
143 Eina_Bool can_focus_only);
144 static Evas_Object *_newest_focus_order_get(Evas_Object *obj,
145 unsigned int *newest_focus_order,
146 Eina_Bool can_focus_only);
148 /* local subsystem globals */
149 static Evas_Smart *_e_smart = NULL;
150 static Eina_List *widtypes = NULL;
152 static unsigned int focus_order = 0;
155 static inline Eina_Bool
156 _elm_widget_is(const Evas_Object *obj)
158 const char *type = evas_object_type_get(obj);
159 return type == SMART_NAME;
162 static inline Eina_Bool
163 _is_focusable(Evas_Object *obj)
165 API_ENTRY return EINA_FALSE;
166 return sd->can_focus || (sd->child_can_focus);
170 _unfocus_parents(Evas_Object *obj)
172 for (; obj; obj = elm_widget_parent_get(obj))
175 if (!sd->focused) return;
181 _focus_parents(Evas_Object *obj)
183 for (; obj; obj = elm_widget_parent_get(obj))
186 if (sd->focused) return;
192 _sub_obj_del(void *data,
195 void *event_info __UNUSED__)
197 Smart_Data *sd = data;
199 if (_elm_widget_is(obj))
201 if (elm_widget_focus_get(obj)) _unfocus_parents(sd->obj);
203 if (obj == sd->resize_obj)
204 sd->resize_obj = NULL;
205 else if (obj == sd->hover_obj)
206 sd->hover_obj = NULL;
208 sd->subobjs = eina_list_remove(sd->subobjs, obj);
209 evas_object_smart_callback_call(sd->obj, "sub-object-del", obj);
213 _sub_obj_hide(void *data __UNUSED__,
216 void *event_info __UNUSED__)
218 _if_focused_revert(obj, EINA_TRUE);
222 _sub_obj_mouse_down(void *data __UNUSED__,
225 void *event_info __UNUSED__)
227 Evas_Object *o = obj;
230 if (_elm_widget_is(o)) break;
231 o = evas_object_smart_parent_get(o);
235 if (!_is_focusable(o)) return;
236 elm_widget_focus_steal(o);
240 _propagate_x_drag_lock(Evas_Object *obj,
246 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
249 sd2->child_drag_x_locked += dir;
250 _propagate_x_drag_lock(sd->parent_obj, dir);
256 _propagate_y_drag_lock(Evas_Object *obj,
262 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
265 sd2->child_drag_y_locked += dir;
266 _propagate_y_drag_lock(sd->parent_obj, dir);
272 _propagate_event(void *data,
278 Evas_Callback_Type type = (Evas_Callback_Type)(long)data;
279 Evas_Event_Flags *event_flags = NULL;
283 case EVAS_CALLBACK_KEY_DOWN:
285 Evas_Event_Key_Down *ev = event_info;
286 event_flags = &(ev->event_flags);
290 case EVAS_CALLBACK_KEY_UP:
292 Evas_Event_Key_Up *ev = event_info;
293 event_flags = &(ev->event_flags);
297 case EVAS_CALLBACK_MOUSE_WHEEL:
299 Evas_Event_Mouse_Wheel *ev = event_info;
300 event_flags = &(ev->event_flags);
308 elm_widget_event_propagate(obj, type, event_info, event_flags);
312 _parent_focus(Evas_Object *obj)
315 if (sd->focused) return;
317 Evas_Object *o = elm_widget_parent_get(obj);
318 sd->focus_order_on_calc = EINA_TRUE;
320 if (o) _parent_focus(o);
322 if (!sd->focus_order_on_calc)
323 return; /* we don't want to override it if by means of any of the
324 callbacks below one gets to calculate our order
328 sd->focus_order = focus_order;
329 sd->focused = EINA_TRUE;
330 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
331 if (sd->focus_func) sd->focus_func(obj);
333 _elm_widget_focus_region_show(obj);
335 sd->focus_order_on_calc = EINA_FALSE;
339 _elm_object_focus_chain_del_cb(void *data,
342 void *event_info __UNUSED__)
344 Smart_Data *sd = data;
346 sd->focus_chain = eina_list_remove(sd->focus_chain, obj);
349 // exposed util funcs to elm
351 _elm_widget_type_clear(void)
355 EINA_LIST_FREE(widtypes, ptr)
357 eina_stringshare_del(*ptr);
363 _elm_widget_focus_region_show(const Evas_Object *obj)
365 Evas_Coord x, y, w, h, ox, oy;
371 o = elm_widget_parent_get(obj);
374 elm_widget_focus_region_get(obj, &x, &y, &w, &h);
375 evas_object_geometry_get(obj, &ox, &oy, NULL, NULL);
379 sd2 = evas_object_smart_data_get(o);
380 if (sd2->focus_region_func)
382 sd2->focus_region_func(o, x, y, w, h);
383 elm_widget_focus_region_get(o, &x, &y, &w, &h);
387 evas_object_geometry_get(o, &px, &py, NULL, NULL);
393 o = elm_widget_parent_get(o);
398 * @defgroup Widget Widget
401 * Exposed api for making widgets
404 elm_widget_type_register(const char **ptr)
406 widtypes = eina_list_append(widtypes, (void *)ptr);
410 elm_widget_api_check(int ver)
412 if (ver != ELM_INTERNAL_API_VERSION)
414 CRITICAL("Elementary widget api versions do not match");
421 elm_widget_add(Evas *evas)
425 obj = evas_object_smart_add(evas, _e_smart);
426 elm_widget_mirrored_set(obj, elm_mirrored_get());
431 elm_widget_del_hook_set(Evas_Object *obj,
432 void (*func)(Evas_Object *obj))
439 elm_widget_del_pre_hook_set(Evas_Object *obj,
440 void (*func)(Evas_Object *obj))
443 sd->del_pre_func = func;
447 elm_widget_focus_hook_set(Evas_Object *obj,
448 void (*func)(Evas_Object *obj))
451 sd->focus_func = func;
455 elm_widget_activate_hook_set(Evas_Object *obj,
456 void (*func)(Evas_Object *obj))
459 sd->activate_func = func;
463 elm_widget_disable_hook_set(Evas_Object *obj,
464 void (*func)(Evas_Object *obj))
467 sd->disable_func = func;
471 elm_widget_theme_hook_set(Evas_Object *obj,
472 void (*func)(Evas_Object *obj))
475 sd->theme_func = func;
479 elm_widget_event_hook_set(Evas_Object *obj,
480 Eina_Bool (*func)(Evas_Object *obj,
482 Evas_Callback_Type type,
486 sd->event_func = func;
490 elm_widget_changed_hook_set(Evas_Object *obj,
491 void (*func)(Evas_Object *obj))
494 sd->changed_func = func;
498 elm_widget_signal_emit_hook_set(Evas_Object *obj,
499 void (*func)(Evas_Object *obj,
500 const char *emission,
504 sd->signal_func = func;
508 elm_widget_signal_callback_add_hook_set(Evas_Object *obj,
509 void (*func)(Evas_Object *obj,
510 const char *emission,
512 Edje_Signal_Cb func_cb,
516 sd->callback_add_func = func;
520 elm_widget_signal_callback_del_hook_set(Evas_Object *obj,
521 void (*func)(Evas_Object *obj,
522 const char *emission,
524 Edje_Signal_Cb func_cb,
528 sd->callback_del_func = func;
532 elm_widget_theme(Evas_Object *obj)
540 EINA_LIST_FOREACH(sd->subobjs, l, child) elm_widget_theme(child);
541 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
542 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
543 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
544 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
545 if (sd->theme_func) sd->theme_func(obj);
549 elm_widget_theme_specific(Evas_Object *obj,
557 Elm_Theme *th2, *thdef;
560 thdef = elm_theme_default_get();
565 if (!th2) th2 = thdef;
573 if (th2 == thdef) break;
574 th2 = th2->ref_theme;
575 if (!th2) th2 = thdef;
579 EINA_LIST_FOREACH(sd->subobjs, l, child)
580 elm_widget_theme_specific(child, th, force);
581 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
582 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
583 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
584 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
585 if (sd->theme_func) sd->theme_func(obj);
591 * Set hook to get next object in object focus chain.
593 * @param obj The widget object.
594 * @param func The hook to be used with this widget.
599 elm_widget_focus_next_hook_set(Evas_Object *obj,
600 Eina_Bool (*func)(const Evas_Object *obj,
601 Elm_Focus_Direction dir,
605 sd->focus_next_func = func;
609 * Returns the widget's mirrored mode.
611 * @param obj The widget.
612 * @return mirrored mode of the object.
616 elm_widget_mirrored_get(const Evas_Object *obj)
618 API_ENTRY return EINA_FALSE;
619 return sd->is_mirrored;
623 * Sets the widget's mirrored mode.
625 * @param obj The widget.
626 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
629 elm_widget_mirrored_set(Evas_Object *obj,
633 if (sd->is_mirrored != mirrored)
635 sd->is_mirrored = mirrored;
636 elm_widget_theme(obj);
642 * Resets the mirrored mode from the system mirror mode for widgets that are in
643 * automatic mirroring mode. This function does not call elm_widget_theme.
645 * @param obj The widget.
646 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
649 _elm_widget_mirrored_reload(Evas_Object *obj)
652 Eina_Bool mirrored = elm_mirrored_get();
653 if (elm_widget_mirrored_automatic_get(obj) && (sd->is_mirrored != mirrored))
655 sd->is_mirrored = mirrored;
660 * Returns the widget's mirrored mode setting.
662 * @param obj The widget.
663 * @return mirrored mode setting of the object.
667 elm_widget_mirrored_automatic_get(const Evas_Object *obj)
669 API_ENTRY return EINA_FALSE;
670 return sd->mirrored_auto_mode;
674 * Sets the widget's mirrored mode setting.
675 * When widget in automatic mode, it follows the system mirrored mode set by
676 * elm_mirrored_set().
677 * @param obj The widget.
678 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
681 elm_widget_mirrored_automatic_set(Evas_Object *obj,
685 if (sd->mirrored_auto_mode != automatic)
687 sd->mirrored_auto_mode = automatic;
691 elm_widget_mirrored_set(obj, elm_mirrored_get());
697 elm_widget_on_focus_hook_set(Evas_Object *obj,
698 void (*func)(void *data,
703 sd->on_focus_func = func;
704 sd->on_focus_data = data;
708 elm_widget_on_change_hook_set(Evas_Object *obj,
709 void (*func)(void *data,
714 sd->on_change_func = func;
715 sd->on_change_data = data;
719 elm_widget_on_show_region_hook_set(Evas_Object *obj,
720 void (*func)(void *data,
725 sd->on_show_region_func = func;
726 sd->on_show_region_data = data;
732 * Set the hook to use to show the focused region.
734 * Whenever a new widget gets focused or it's needed to show the focused
735 * area of the current one, this hook will be called on objects that may
736 * want to move their children into their visible area.
737 * The area given in the hook function is relative to the @p obj widget.
739 * @param obj The widget object
740 * @param func The function to call to show the specified area.
745 elm_widget_focus_region_hook_set(Evas_Object *obj,
746 void (*func)(Evas_Object *obj,
753 sd->focus_region_func = func;
759 * Set the hook to retrieve the focused region of a widget.
761 * This hook will be called by elm_widget_focus_region_get() whenever
762 * it's needed to get the focused area of a widget. The area must be relative
763 * to the widget itself and if no hook is set, it will default to the entire
766 * @param obj The widget object
767 * @param func The function used to retrieve the focus region.
772 elm_widget_on_focus_region_hook_set(Evas_Object *obj,
773 void (*func)(const Evas_Object *obj,
780 sd->on_focus_region_func = func;
784 elm_widget_data_set(Evas_Object *obj,
792 elm_widget_data_get(const Evas_Object *obj)
794 API_ENTRY return NULL;
799 elm_widget_sub_object_add(Evas_Object *obj,
803 double scale, pscale = elm_widget_scale_get(sobj);
804 Elm_Theme *th, *pth = elm_widget_theme_get(sobj);
805 Eina_Bool mirrored, pmirrored = elm_widget_mirrored_get(obj);
807 if (_elm_widget_is(sobj))
809 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
812 if (sd2->parent_obj == obj)
815 elm_widget_sub_object_del(sd2->parent_obj, sobj);
816 sd2->parent_obj = obj;
817 if (!sd->child_can_focus && (_is_focusable(sobj)))
818 sd->child_can_focus = EINA_TRUE;
823 void *data = evas_object_data_get(sobj, "elm-parent");
826 if (data == obj) return;
827 evas_object_event_callback_del(sobj, EVAS_CALLBACK_DEL,
832 sd->subobjs = eina_list_append(sd->subobjs, sobj);
833 evas_object_data_set(sobj, "elm-parent", obj);
834 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
835 if (_elm_widget_is(sobj))
836 evas_object_event_callback_add(sobj, EVAS_CALLBACK_HIDE, _sub_obj_hide, sd);
837 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
838 scale = elm_widget_scale_get(sobj);
839 th = elm_widget_theme_get(sobj);
840 mirrored = elm_widget_mirrored_get(sobj);
841 if ((scale != pscale) || (th != pth) || (pmirrored != mirrored)) elm_widget_theme(sobj);
842 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
846 elm_widget_sub_object_del(Evas_Object *obj,
849 Evas_Object *sobj_parent;
853 sobj_parent = evas_object_data_del(sobj, "elm-parent");
854 if (sobj_parent != obj)
856 static int abort_on_warn = -1;
857 ERR("removing sub object %p from parent %p, "
858 "but elm-parent is different %p!",
859 sobj, obj, sobj_parent);
860 if (EINA_UNLIKELY(abort_on_warn == -1))
862 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
863 else abort_on_warn = 0;
865 if (abort_on_warn == 1) abort();
867 if (!sd->child_can_focus)
869 if (_is_focusable(sobj)) sd->child_can_focus = 0;
871 if (_elm_widget_is(sobj))
873 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
876 sd2->parent_obj = NULL;
877 if (sd2->resize_obj == sobj)
878 sd2->resize_obj = NULL;
880 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
883 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
884 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
887 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
888 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
890 if (_elm_widget_is(sobj))
891 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
893 evas_object_smart_callback_call(obj, "sub-object-del", sobj);
897 elm_widget_resize_object_set(Evas_Object *obj,
901 // orphan previous resize obj
904 evas_object_clip_unset(sd->resize_obj);
905 evas_object_data_del(sd->resize_obj, "elm-parent");
906 if (_elm_widget_is(sd->resize_obj))
908 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
909 if (sd2) sd2->parent_obj = NULL;
910 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_HIDE,
913 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_DEL,
915 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_MOUSE_DOWN,
916 _sub_obj_mouse_down, sd);
917 evas_object_smart_member_del(sd->resize_obj);
918 if (_elm_widget_is(sd->resize_obj))
920 if (elm_widget_focus_get(sd->resize_obj)) _unfocus_parents(obj);
923 // orphan new resize obj
926 evas_object_data_del(sobj, "elm-parent");
927 if (_elm_widget_is(sobj))
929 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
930 if (sd2) sd2->parent_obj = NULL;
931 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
934 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
936 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_MOUSE_DOWN,
937 _sub_obj_mouse_down, sd);
938 evas_object_smart_member_del(sobj);
939 if (_elm_widget_is(sobj))
941 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
944 // set the resize obj up
945 sd->resize_obj = sobj;
948 if (_elm_widget_is(sd->resize_obj))
950 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
951 if (sd2) sd2->parent_obj = obj;
952 evas_object_event_callback_add(sobj, EVAS_CALLBACK_HIDE,
955 evas_object_clip_set(sobj, evas_object_clip_get(obj));
956 evas_object_smart_member_add(sobj, obj);
957 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
959 evas_object_event_callback_add(sobj, EVAS_CALLBACK_MOUSE_DOWN,
960 _sub_obj_mouse_down, sd);
961 _smart_reconfigure(sd);
962 evas_object_data_set(sobj, "elm-parent", obj);
963 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
964 if (_elm_widget_is(sobj))
966 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
972 elm_widget_hover_object_set(Evas_Object *obj,
978 evas_object_event_callback_del_full(sd->hover_obj, EVAS_CALLBACK_DEL,
981 sd->hover_obj = sobj;
984 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
986 _smart_reconfigure(sd);
991 elm_widget_can_focus_set(Evas_Object *obj,
995 sd->can_focus = can_focus;
998 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN,
1000 (void *)(long)EVAS_CALLBACK_KEY_DOWN);
1001 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_UP,
1003 (void *)(long)EVAS_CALLBACK_KEY_UP);
1004 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOUSE_WHEEL,
1006 (void *)(long)EVAS_CALLBACK_MOUSE_WHEEL);
1010 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_DOWN,
1012 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_UP,
1014 evas_object_event_callback_del(obj, EVAS_CALLBACK_MOUSE_WHEEL,
1020 elm_widget_can_focus_get(const Evas_Object *obj)
1022 API_ENTRY return EINA_FALSE;
1023 return sd->can_focus;
1027 elm_widget_child_can_focus_get(const Evas_Object *obj)
1029 API_ENTRY return EINA_FALSE;
1030 return sd->child_can_focus;
1034 elm_widget_highlight_ignore_set(Evas_Object *obj,
1038 sd->highlight_ignore = !!ignore;
1042 elm_widget_highlight_ignore_get(const Evas_Object *obj)
1044 API_ENTRY return EINA_FALSE;
1045 return sd->highlight_ignore;
1049 elm_widget_highlight_in_theme_set(Evas_Object *obj,
1050 Eina_Bool highlight)
1053 sd->highlight_in_theme = !!highlight;
1054 /* FIXME: if focused, it should switch from one mode to the other */
1058 elm_widget_highlight_in_theme_get(const Evas_Object *obj)
1060 API_ENTRY return EINA_FALSE;
1061 return sd->highlight_in_theme;
1065 elm_widget_focus_get(const Evas_Object *obj)
1067 API_ENTRY return EINA_FALSE;
1072 elm_widget_focused_object_get(const Evas_Object *obj)
1074 const Evas_Object *subobj;
1076 API_ENTRY return NULL;
1078 if (!sd->focused) return NULL;
1079 EINA_LIST_FOREACH(sd->subobjs, l, subobj)
1081 Evas_Object *fobj = elm_widget_focused_object_get(subobj);
1082 if (fobj) return fobj;
1084 return (Evas_Object *)obj;
1088 elm_widget_top_get(const Evas_Object *obj)
1090 API_ENTRY return NULL;
1091 if (sd->parent_obj) return elm_widget_top_get(sd->parent_obj);
1092 return (Evas_Object *)obj;
1096 elm_widget_is(const Evas_Object *obj)
1098 return _elm_widget_is(obj);
1102 elm_widget_parent_widget_get(const Evas_Object *obj)
1104 Evas_Object *parent;
1106 if (_elm_widget_is(obj))
1108 Smart_Data *sd = evas_object_smart_data_get(obj);
1109 if (!sd) return NULL;
1110 parent = sd->parent_obj;
1114 parent = evas_object_data_get(obj, "elm-parent");
1115 if (!parent) parent = evas_object_smart_parent_get(obj);
1120 Evas_Object *elm_parent;
1121 if (_elm_widget_is(parent)) break;
1122 elm_parent = evas_object_data_get(parent, "elm-parent");
1123 if (elm_parent) parent = elm_parent;
1124 else parent = evas_object_smart_parent_get(parent);
1130 elm_widget_event_callback_add(Evas_Object *obj,
1135 EINA_SAFETY_ON_NULL_RETURN(func);
1136 Elm_Event_Cb_Data *ecb = ELM_NEW(Elm_Event_Cb_Data);
1139 sd->event_cb = eina_list_append(sd->event_cb, ecb);
1143 elm_widget_event_callback_del(Evas_Object *obj,
1147 API_ENTRY return NULL;
1148 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
1150 Elm_Event_Cb_Data *ecd;
1151 EINA_LIST_FOREACH(sd->event_cb, l, ecd)
1152 if ((ecd->func == func) && (ecd->data == data))
1155 sd->event_cb = eina_list_remove_list(sd->event_cb, l);
1156 return (void *)data;
1162 elm_widget_event_propagate(Evas_Object *obj,
1163 Evas_Callback_Type type,
1165 Evas_Event_Flags *event_flags)
1167 API_ENTRY return EINA_FALSE; //TODO reduce.
1168 if (!_elm_widget_is(obj)) return EINA_FALSE;
1169 Evas_Object *parent = obj;
1170 Elm_Event_Cb_Data *ecd;
1171 Eina_List *l, *l_prev;
1174 (!(event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD))))
1176 sd = evas_object_smart_data_get(parent);
1177 if ((!sd) || (!_elm_widget_is(obj)))
1178 return EINA_FALSE; //Not Elm Widget
1180 if (sd->event_func && (sd->event_func(parent, obj, type, event_info)))
1183 EINA_LIST_FOREACH_SAFE(sd->event_cb, l, l_prev, ecd)
1185 if (ecd->func((void *)ecd->data, parent, obj, type, event_info) ||
1186 (event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD)))
1189 parent = sd->parent_obj;
1198 * Set custom focus chain.
1200 * This function i set one new and overwrite any previous custom focus chain
1201 * with the list of objects. The previous list will be deleted and this list
1202 * will be managed. After setted, don't modity it.
1204 * @note On focus cycle, only will be evaluated children of this container.
1206 * @param obj The container widget
1207 * @param objs Chain of objects to pass focus
1211 elm_widget_focus_custom_chain_set(Evas_Object *obj,
1215 if (!sd->focus_next_func)
1218 elm_widget_focus_custom_chain_unset(obj);
1223 EINA_LIST_FOREACH(objs, l, o)
1225 evas_object_event_callback_add(o, EVAS_CALLBACK_DEL,
1226 _elm_object_focus_chain_del_cb, sd);
1229 sd->focus_chain = objs;
1235 * Get custom focus chain
1237 * @param obj The container widget
1240 EAPI const Eina_List *
1241 elm_widget_focus_custom_chain_get(const Evas_Object *obj)
1243 API_ENTRY return NULL;
1244 return (const Eina_List *)sd->focus_chain;
1250 * Unset custom focus chain
1252 * @param obj The container widget
1256 elm_widget_focus_custom_chain_unset(Evas_Object *obj)
1259 Eina_List *l, *l_next;
1262 EINA_LIST_FOREACH_SAFE(sd->focus_chain, l, l_next, o)
1264 evas_object_event_callback_del_full(o, EVAS_CALLBACK_DEL,
1265 _elm_object_focus_chain_del_cb, sd);
1266 sd->focus_chain = eina_list_remove_list(sd->focus_chain, l);
1273 * Append object to custom focus chain.
1275 * @note If relative_child equal to NULL or not in custom chain, the object
1276 * will be added in end.
1278 * @note On focus cycle, only will be evaluated children of this container.
1280 * @param obj The container widget
1281 * @param child The child to be added in custom chain
1282 * @param relative_child The relative object to position the child
1286 elm_widget_focus_custom_chain_append(Evas_Object *obj,
1288 Evas_Object *relative_child)
1291 EINA_SAFETY_ON_NULL_RETURN(child);
1292 if (!sd->focus_next_func)
1295 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1296 _elm_object_focus_chain_del_cb, sd);
1298 if (!relative_child)
1300 sd->focus_chain = eina_list_append(sd->focus_chain, child);
1304 sd->focus_chain = eina_list_append_relative(sd->focus_chain, child, relative_child);
1311 * Prepend object to custom focus chain.
1313 * @note If relative_child equal to NULL or not in custom chain, the object
1314 * will be added in begin.
1316 * @note On focus cycle, only will be evaluated children of this container.
1318 * @param obj The container widget
1319 * @param child The child to be added in custom chain
1320 * @param relative_child The relative object to position the child
1324 elm_widget_focus_custom_chain_prepend(Evas_Object *obj,
1326 Evas_Object *relative_child)
1329 EINA_SAFETY_ON_NULL_RETURN(child);
1330 if (!sd->focus_next_func)
1333 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1334 _elm_object_focus_chain_del_cb, sd);
1336 if (!relative_child)
1338 sd->focus_chain = eina_list_prepend(sd->focus_chain, child);
1342 sd->focus_chain = eina_list_prepend_relative(sd->focus_chain, child, relative_child);
1349 * Give focus to next object in object tree.
1351 * Give focus to next object in focus chain of one object sub-tree.
1352 * If the last object of chain already have focus, the focus will go to the
1353 * first object of chain.
1355 * @param obj The widget root of sub-tree
1356 * @param dir Direction to cycle the focus
1361 elm_widget_focus_cycle(Evas_Object *obj,
1362 Elm_Focus_Direction dir)
1364 Evas_Object *target = NULL;
1365 if (!_elm_widget_is(obj))
1367 elm_widget_focus_next_get(obj, dir, &target);
1369 elm_widget_focus_steal(target);
1375 * Give focus to near object in one direction.
1377 * Give focus to near object in direction of one object.
1378 * If none focusable object in given direction, the focus will not change.
1380 * @param obj The reference widget
1381 * @param x Horizontal component of direction to focus
1382 * @param y Vertical component of direction to focus
1387 elm_widget_focus_direction_go(Evas_Object *obj __UNUSED__,
1397 * Get next object in focus chain of object tree.
1399 * Get next object in focus chain of one object sub-tree.
1400 * Return the next object by reference. If don't have any candidate to receive
1401 * focus before chain end, the first candidate will be returned.
1403 * @param obj The widget root of sub-tree
1404 * @param dir Direction os focus chain
1405 * @param next The next object in focus chain
1406 * @return EINA_TRUE if don't need focus chain restart/loop back
1407 * to use 'next' obj.
1412 elm_widget_focus_next_get(const Evas_Object *obj,
1413 Elm_Focus_Direction dir,
1420 API_ENTRY return EINA_FALSE;
1422 /* Ignore if disabled */
1423 if ((!evas_object_visible_get(obj)) || (elm_widget_disabled_get(obj)))
1427 if (sd->focus_next_func)
1428 return sd->focus_next_func(obj, dir, next);
1430 if (!elm_widget_can_focus_get(obj))
1434 *next = (Evas_Object *)obj;
1435 return !elm_widget_focus_get(obj);
1441 * Get next object in focus chain of object tree in list.
1443 * Get next object in focus chain of one object sub-tree ordered by one list.
1444 * Return the next object by reference. If don't have any candidate to receive
1445 * focus before list end, the first candidate will be returned.
1447 * @param obj The widget root of sub-tree
1448 * @param dir Direction os focus chain
1449 * @param items list with ordered objects
1450 * @param list_data_get function to get the object from one item of list
1451 * @param next The next object in focus chain
1452 * @return EINA_TRUE if don't need focus chain restart/loop back
1453 * to use 'next' obj.
1458 elm_widget_focus_list_next_get(const Evas_Object *obj,
1459 const Eina_List *items,
1460 void *(*list_data_get)(const Eina_List * list),
1461 Elm_Focus_Direction dir,
1464 Eina_List *(*list_next)(const Eina_List * list);
1470 if (!_elm_widget_is(obj))
1477 if (dir == ELM_FOCUS_PREVIOUS)
1479 items = eina_list_last(items);
1480 list_next = eina_list_prev;
1482 else if (dir == ELM_FOCUS_NEXT)
1483 list_next = eina_list_next;
1487 const Eina_List *l = items;
1489 /* Recovery last focused sub item */
1490 if (elm_widget_focus_get(obj))
1491 for (; l; l = list_next(l))
1493 Evas_Object *cur = list_data_get(l);
1494 if (elm_widget_focus_get(cur)) break;
1497 const Eina_List *start = l;
1498 Evas_Object *to_focus = NULL;
1500 /* Interate sub items */
1501 /* Go to end of list */
1502 for (; l; l = list_next(l))
1504 Evas_Object *tmp = NULL;
1505 Evas_Object *cur = list_data_get(l);
1507 if (elm_widget_parent_get(cur) != obj)
1510 /* Try Focus cycle in subitem */
1511 if (elm_widget_focus_next_get(cur, dir, &tmp))
1516 else if ((tmp) && (!to_focus))
1522 /* Get First possible */
1523 for (; l != start; l = list_next(l))
1525 Evas_Object *tmp = NULL;
1526 Evas_Object *cur = list_data_get(l);
1528 if (elm_widget_parent_get(cur) != obj)
1531 /* Try Focus cycle in subitem */
1532 elm_widget_focus_next_get(cur, dir, &tmp);
1545 elm_widget_signal_emit(Evas_Object *obj,
1546 const char *emission,
1550 if (!sd->signal_func) return;
1551 sd->signal_func(obj, emission, source);
1555 _edje_signal_callback(void *data,
1556 Evas_Object *obj __UNUSED__,
1557 const char *emission,
1560 Edje_Signal_Data *esd = data;
1561 esd->func(esd->data, esd->obj, emission, source);
1565 elm_widget_signal_callback_add(Evas_Object *obj,
1566 const char *emission,
1568 Edje_Signal_Cb func,
1571 Edje_Signal_Data *esd;
1573 if (!sd->callback_add_func) return;
1574 EINA_SAFETY_ON_NULL_RETURN(func);
1576 esd = ELM_NEW(Edje_Signal_Data);
1581 esd->emission = eina_stringshare_add(emission);
1582 esd->source = eina_stringshare_add(source);
1584 sd->edje_signals = eina_list_append(sd->edje_signals, esd);
1585 sd->callback_add_func(obj, emission, source, _edje_signal_callback, esd);
1589 elm_widget_signal_callback_del(Evas_Object *obj,
1590 const char *emission,
1592 Edje_Signal_Cb func)
1594 Edje_Signal_Data *esd;
1597 API_ENTRY return NULL;
1598 if (!sd->callback_del_func) return NULL;
1600 EINA_LIST_FOREACH(sd->edje_signals, l, esd)
1602 if ((esd->func == func) && (!strcmp(esd->emission, emission)) &&
1603 (!strcmp(esd->source, source)))
1605 sd->edje_signals = eina_list_remove_list(sd->edje_signals, l);
1606 eina_stringshare_del(esd->emission);
1607 eina_stringshare_del(esd->source);
1613 sd->callback_del_func(obj, emission, source, _edje_signal_callback, esd);
1618 elm_widget_focus_set(Evas_Object *obj,
1625 sd->focus_order = focus_order;
1626 sd->focused = EINA_TRUE;
1627 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1631 sd->focus_func(obj);
1638 if ((_is_focusable(sd->resize_obj)) &&
1639 (!elm_widget_disabled_get(sd->resize_obj)))
1641 elm_widget_focus_set(sd->resize_obj, first);
1647 EINA_LIST_FOREACH(sd->subobjs, l, child)
1649 if ((_is_focusable(child)) &&
1650 (!elm_widget_disabled_get(child)))
1652 elm_widget_focus_set(child, first);
1662 EINA_LIST_REVERSE_FOREACH(sd->subobjs, l, child)
1664 if ((_is_focusable(child)) &&
1665 (!elm_widget_disabled_get(child)))
1667 elm_widget_focus_set(child, first);
1673 if ((_is_focusable(sd->resize_obj)) &&
1674 (!elm_widget_disabled_get(sd->resize_obj)))
1676 elm_widget_focus_set(sd->resize_obj, first);
1684 elm_widget_parent_get(const Evas_Object *obj)
1686 API_ENTRY return NULL;
1687 return sd->parent_obj;
1691 elm_widget_focused_object_clear(Evas_Object *obj)
1694 if (!sd->focused) return;
1695 if (elm_widget_focus_get(sd->resize_obj))
1696 elm_widget_focused_object_clear(sd->resize_obj);
1701 EINA_LIST_FOREACH(sd->subobjs, l, child)
1703 if (elm_widget_focus_get(child))
1705 elm_widget_focused_object_clear(child);
1710 sd->focused = EINA_FALSE;
1711 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1712 if (sd->focus_func) sd->focus_func(obj);
1716 elm_widget_focus_steal(Evas_Object *obj)
1718 Evas_Object *parent, *o;
1721 if (sd->focused) return;
1722 if (sd->disabled) return;
1723 if (!sd->can_focus) return;
1727 o = elm_widget_parent_get(parent);
1729 sd = evas_object_smart_data_get(o);
1730 if (sd->focused) break;
1733 if (!elm_widget_parent_get(parent))
1734 elm_widget_focused_object_clear(parent);
1737 parent = elm_widget_parent_get(parent);
1738 sd = evas_object_smart_data_get(parent);
1739 if ((sd->resize_obj) && (elm_widget_focus_get(sd->resize_obj)))
1740 elm_widget_focused_object_clear(sd->resize_obj);
1745 EINA_LIST_FOREACH(sd->subobjs, l, child)
1747 if (elm_widget_focus_get(child))
1749 elm_widget_focused_object_clear(child);
1760 elm_widget_activate(Evas_Object *obj)
1763 elm_widget_change(obj);
1764 if (sd->activate_func) sd->activate_func(obj);
1768 elm_widget_change(Evas_Object *obj)
1771 elm_widget_change(elm_widget_parent_get(obj));
1772 if (sd->on_change_func) sd->on_change_func(sd->on_change_data, obj);
1776 elm_widget_disabled_set(Evas_Object *obj,
1781 if (sd->disabled == disabled) return;
1782 sd->disabled = disabled;
1785 Evas_Object *o, *parent;
1790 o = elm_widget_parent_get(parent);
1794 if (elm_widget_focus_get(obj))
1795 elm_widget_focus_cycle(parent, ELM_FOCUS_NEXT);
1797 if (sd->disable_func) sd->disable_func(obj);
1801 elm_widget_disabled_get(const Evas_Object *obj)
1804 return sd->disabled;
1808 elm_widget_show_region_set(Evas_Object *obj,
1813 Eina_Bool forceshow)
1815 Evas_Object *parent_obj, *child_obj;
1816 Evas_Coord px, py, cx, cy;
1819 if (!forceshow && (x == sd->rx) && (y == sd->ry)
1820 && (w == sd->rw) && (h == sd->rh)) return;
1825 if (sd->on_show_region_func)
1826 sd->on_show_region_func(sd->on_show_region_data, obj);
1830 parent_obj = sd->parent_obj;
1831 child_obj = sd->obj;
1832 if ((!parent_obj) || (!_elm_widget_is(parent_obj))) break;
1833 sd = evas_object_smart_data_get(parent_obj);
1836 evas_object_geometry_get(parent_obj, &px, &py, NULL, NULL);
1837 evas_object_geometry_get(child_obj, &cx, &cy, NULL, NULL);
1846 if (sd->on_show_region_func)
1848 sd->on_show_region_func(sd->on_show_region_data, parent_obj);
1855 elm_widget_show_region_get(const Evas_Object *obj,
1871 * Get the focus region of the given widget.
1873 * The focus region is the area of a widget that should brought into the
1874 * visible area when the widget is focused. Mostly used to show the part of
1875 * an entry where the cursor is, for example. The area returned is relative
1876 * to the object @p obj.
1877 * If the @p obj doesn't have the proper on_focus_region_hook set, this
1878 * function will return the full size of the object.
1880 * @param obj The widget object
1881 * @param x Where to store the x coordinate of the area
1882 * @param y Where to store the y coordinate of the area
1883 * @param w Where to store the width of the area
1884 * @param h Where to store the height of the area
1889 elm_widget_focus_region_get(const Evas_Object *obj,
1899 sd = evas_object_smart_data_get(obj);
1900 if (!sd || !_elm_widget_is(obj) || !sd->on_focus_region_func)
1902 evas_object_geometry_get(obj, NULL, NULL, w, h);
1907 sd->on_focus_region_func(obj, x, y, w, h);
1911 elm_widget_scroll_hold_push(Evas_Object *obj)
1915 if (sd->scroll_hold == 1)
1916 evas_object_smart_callback_call(obj, "scroll-hold-on", obj);
1917 if (sd->parent_obj) elm_widget_scroll_hold_push(sd->parent_obj);
1918 // FIXME: on delete/reparent hold pop
1922 elm_widget_scroll_hold_pop(Evas_Object *obj)
1926 if (sd->scroll_hold < 0) sd->scroll_hold = 0;
1927 if (!sd->scroll_hold)
1928 evas_object_smart_callback_call(obj, "scroll-hold-off", obj);
1929 if (sd->parent_obj) elm_widget_scroll_hold_pop(sd->parent_obj);
1933 elm_widget_scroll_hold_get(const Evas_Object *obj)
1936 return sd->scroll_hold;
1940 elm_widget_scroll_freeze_push(Evas_Object *obj)
1943 sd->scroll_freeze++;
1944 if (sd->scroll_freeze == 1)
1945 evas_object_smart_callback_call(obj, "scroll-freeze-on", obj);
1946 if (sd->parent_obj) elm_widget_scroll_freeze_push(sd->parent_obj);
1947 // FIXME: on delete/reparent freeze pop
1951 elm_widget_scroll_freeze_pop(Evas_Object *obj)
1954 sd->scroll_freeze--;
1955 if (sd->scroll_freeze < 0) sd->scroll_freeze = 0;
1956 if (!sd->scroll_freeze)
1957 evas_object_smart_callback_call(obj, "scroll-freeze-off", obj);
1958 if (sd->parent_obj) elm_widget_scroll_freeze_pop(sd->parent_obj);
1962 elm_widget_scroll_freeze_get(const Evas_Object *obj)
1965 return sd->scroll_freeze;
1969 elm_widget_scale_set(Evas_Object *obj,
1973 if (scale <= 0.0) scale = 0.0;
1974 if (sd->scale != scale)
1977 elm_widget_theme(obj);
1982 elm_widget_scale_get(const Evas_Object *obj)
1984 API_ENTRY return 1.0;
1985 // FIXME: save walking up the tree by storing/caching parent scale
1986 if (sd->scale == 0.0)
1989 return elm_widget_scale_get(sd->parent_obj);
1997 elm_widget_theme_set(Evas_Object *obj,
2001 if (sd->theme != th)
2003 if (sd->theme) elm_theme_free(sd->theme);
2006 elm_widget_theme(obj);
2011 elm_widget_theme_get(const Evas_Object *obj)
2013 API_ENTRY return NULL;
2017 return elm_widget_theme_get(sd->parent_obj);
2025 elm_widget_style_set(Evas_Object *obj,
2030 if (eina_stringshare_replace(&sd->style, style))
2031 elm_widget_theme(obj);
2035 elm_widget_style_get(const Evas_Object *obj)
2037 API_ENTRY return NULL;
2038 if (sd->style) return sd->style;
2043 elm_widget_type_set(Evas_Object *obj,
2047 eina_stringshare_replace(&sd->type, type);
2051 elm_widget_type_get(const Evas_Object *obj)
2053 API_ENTRY return NULL;
2054 if (sd->type) return sd->type;
2059 elm_widget_tooltip_add(Evas_Object *obj,
2063 sd->tooltips = eina_list_append(sd->tooltips, tt);
2067 elm_widget_tooltip_del(Evas_Object *obj,
2071 sd->tooltips = eina_list_remove(sd->tooltips, tt);
2075 elm_widget_cursor_add(Evas_Object *obj,
2079 sd->cursors = eina_list_append(sd->cursors, cur);
2083 elm_widget_cursor_del(Evas_Object *obj,
2087 sd->cursors = eina_list_remove(sd->cursors, cur);
2091 elm_widget_drag_lock_x_set(Evas_Object *obj,
2095 if (sd->drag_x_locked == lock) return;
2096 sd->drag_x_locked = lock;
2097 if (sd->drag_x_locked) _propagate_x_drag_lock(obj, 1);
2098 else _propagate_x_drag_lock(obj, -1);
2102 elm_widget_drag_lock_y_set(Evas_Object *obj,
2106 if (sd->drag_y_locked == lock) return;
2107 sd->drag_y_locked = lock;
2108 if (sd->drag_y_locked) _propagate_y_drag_lock(obj, 1);
2109 else _propagate_y_drag_lock(obj, -1);
2113 elm_widget_drag_lock_x_get(const Evas_Object *obj)
2115 API_ENTRY return EINA_FALSE;
2116 return sd->drag_x_locked;
2120 elm_widget_drag_lock_y_get(const Evas_Object *obj)
2122 API_ENTRY return EINA_FALSE;
2123 return sd->drag_y_locked;
2127 elm_widget_drag_child_locked_x_get(const Evas_Object *obj)
2130 return sd->child_drag_x_locked;
2134 elm_widget_drag_child_locked_y_get(const Evas_Object *obj)
2137 return sd->child_drag_y_locked;
2141 elm_widget_theme_object_set(Evas_Object *obj,
2144 const char *welement,
2147 API_ENTRY return EINA_FALSE;
2148 return _elm_theme_object_set(obj, edj, wname, welement, wstyle);
2152 elm_widget_type_check(const Evas_Object *obj,
2155 const char *provided, *expected = "(unknown)";
2156 static int abort_on_warn = -1;
2157 provided = elm_widget_type_get(obj);
2158 if (EINA_LIKELY(provided == type)) return EINA_TRUE;
2159 if (type) expected = type;
2160 if ((!provided) || (!provided[0]))
2162 provided = evas_object_type_get(obj);
2163 if ((!provided) || (!provided[0]))
2164 provided = "(unknown)";
2166 ERR("Passing Object: %p, of type: '%s' when expecting type: '%s'", obj, provided, expected);
2167 if (abort_on_warn == -1)
2169 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
2170 else abort_on_warn = 0;
2172 if (abort_on_warn == 1) abort();
2179 * Split string in words
2181 * @param str Source string
2182 * @return List of const words
2184 * @see elm_widget_stringlist_free()
2188 elm_widget_stringlist_get(const char *str)
2190 Eina_List *list = NULL;
2192 if (!str) return NULL;
2193 for (b = s = str; 1; s++)
2195 if ((*s == ' ') || (!*s))
2197 char *t = malloc(s - b + 1);
2200 strncpy(t, b, s - b);
2202 list = eina_list_append(list, eina_stringshare_add(t));
2213 elm_widget_stringlist_free(Eina_List *list)
2216 EINA_LIST_FREE(list, s) eina_stringshare_del(s);
2222 * Allocate a new Elm_Widget_Item-derived structure.
2224 * The goal of this structure is to provide common ground for actions
2225 * that a widget item have, such as the owner widget, callback to
2226 * notify deletion, data pointer and maybe more.
2228 * @param widget the owner widget that holds this item, must be an elm_widget!
2229 * @param alloc_size any number greater than sizeof(Elm_Widget_Item) that will
2230 * be used to allocate memory.
2232 * @return allocated memory that is already zeroed out, or NULL on errors.
2234 * @see elm_widget_item_new() convenience macro.
2235 * @see elm_widget_item_del() to release memory.
2238 EAPI Elm_Widget_Item *
2239 _elm_widget_item_new(Evas_Object *widget,
2242 if (!_elm_widget_is(widget))
2245 Elm_Widget_Item *item;
2247 EINA_SAFETY_ON_TRUE_RETURN_VAL(alloc_size < sizeof(Elm_Widget_Item), NULL);
2248 EINA_SAFETY_ON_TRUE_RETURN_VAL(!_elm_widget_is(widget), NULL);
2250 item = calloc(1, alloc_size);
2251 EINA_SAFETY_ON_NULL_RETURN_VAL(item, NULL);
2253 EINA_MAGIC_SET(item, ELM_WIDGET_ITEM_MAGIC);
2254 item->widget = widget;
2261 * Releases widget item memory, calling back del_cb() if it exists.
2263 * If there is a Elm_Widget_Item::del_cb, then it will be called prior
2264 * to memory release. Note that elm_widget_item_pre_notify_del() calls
2265 * this function and then unset it, thus being useful for 2 step
2266 * cleanup whenever the del_cb may use any of the data that must be
2267 * deleted from item.
2269 * The Elm_Widget_Item::view will be deleted (evas_object_del()) if it
2272 * @param item a valid #Elm_Widget_Item to be deleted.
2273 * @see elm_widget_item_del() convenience macro.
2277 _elm_widget_item_del(Elm_Widget_Item *item)
2279 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2282 item->del_cb((void *)item->data, item->widget, item);
2285 evas_object_del(item->view);
2287 EINA_MAGIC_SET(item, EINA_MAGIC_NONE);
2294 * Notify object will be deleted without actually deleting it.
2296 * This function will callback Elm_Widget_Item::del_cb if it is set
2297 * and then unset it so it is not called twice (ie: from
2298 * elm_widget_item_del()).
2300 * @param item a valid #Elm_Widget_Item to be notified
2301 * @see elm_widget_item_pre_notify_del() convenience macro.
2305 _elm_widget_item_pre_notify_del(Elm_Widget_Item *item)
2307 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2308 if (!item->del_cb) return;
2309 item->del_cb((void *)item->data, item->widget, item);
2310 item->del_cb = NULL;
2316 * Set the function to notify when item is being deleted.
2318 * This function will complain if there was a callback set already,
2319 * however it will set the new one.
2321 * The callback will be called from elm_widget_item_pre_notify_del()
2322 * or elm_widget_item_del() will be called with:
2323 * - data: the Elm_Widget_Item::data value.
2324 * - obj: the Elm_Widget_Item::widget evas object.
2325 * - event_info: the item being deleted.
2327 * @param item a valid #Elm_Widget_Item to be notified
2328 * @see elm_widget_item_del_cb_set() convenience macro.
2332 _elm_widget_item_del_cb_set(Elm_Widget_Item *item,
2333 Evas_Smart_Cb del_cb)
2335 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2337 if ((item->del_cb) && (item->del_cb != del_cb))
2338 WRN("You're replacing a previously set del_cb %p of item %p with %p",
2339 item->del_cb, item, del_cb);
2341 item->del_cb = del_cb;
2347 * Set user-data in this item.
2349 * User data may be used to identify this item or just store any
2350 * application data. It is automatically given as the first parameter
2351 * of the deletion notify callback.
2353 * @param item a valid #Elm_Widget_Item to store data in.
2354 * @param data user data to store.
2355 * @see elm_widget_item_del_cb_set() convenience macro.
2359 _elm_widget_item_data_set(Elm_Widget_Item *item,
2362 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2363 if ((item->data) && (item->data != data))
2364 DBG("Replacing item %p data %p with %p", item, item->data, data);
2371 * Retrieves user-data of this item.
2373 * @param item a valid #Elm_Widget_Item to get data from.
2374 * @see elm_widget_item_data_set()
2378 _elm_widget_item_data_get(const Elm_Widget_Item *item)
2380 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2381 return (void *)item->data;
2384 typedef struct _Elm_Widget_Item_Tooltip Elm_Widget_Item_Tooltip;
2386 struct _Elm_Widget_Item_Tooltip
2388 Elm_Widget_Item *item;
2389 Elm_Tooltip_Item_Content_Cb func;
2390 Evas_Smart_Cb del_cb;
2394 static Evas_Object *
2395 _elm_widget_item_tooltip_label_create(void *data,
2397 void *item __UNUSED__)
2399 Evas_Object *label = elm_label_add(obj);
2402 elm_object_style_set(label, "tooltip");
2403 elm_label_label_set(label, data);
2408 _elm_widget_item_tooltip_label_del_cb(void *data,
2409 Evas_Object *obj __UNUSED__,
2410 void *event_info __UNUSED__)
2412 eina_stringshare_del(data);
2418 * Set the text to be shown in the widget item.
2420 * @param item Target item
2421 * @param text The text to set in the content
2423 * Setup the text as tooltip to object. The item can have only one tooltip,
2424 * so any previous tooltip data is removed.
2429 _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item,
2432 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2433 EINA_SAFETY_ON_NULL_RETURN(text);
2435 text = eina_stringshare_add(text);
2436 _elm_widget_item_tooltip_content_cb_set
2437 (item, _elm_widget_item_tooltip_label_create, text,
2438 _elm_widget_item_tooltip_label_del_cb);
2441 static Evas_Object *
2442 _elm_widget_item_tooltip_create(void *data,
2445 Elm_Widget_Item_Tooltip *wit = data;
2446 return wit->func((void *)wit->data, obj, wit->item);
2450 _elm_widget_item_tooltip_del_cb(void *data,
2452 void *event_info __UNUSED__)
2454 Elm_Widget_Item_Tooltip *wit = data;
2455 if (wit->del_cb) wit->del_cb((void *)wit->data, obj, wit->item);
2462 * Set the content to be shown in the tooltip item
2464 * Setup the tooltip to item. The item can have only one tooltip,
2465 * so any previous tooltip data is removed. @p func(with @p data) will
2466 * be called every time that need show the tooltip and it should
2467 * return a valid Evas_Object. This object is then managed fully by
2468 * tooltip system and is deleted when the tooltip is gone.
2470 * @param item the widget item being attached a tooltip.
2471 * @param func the function used to create the tooltip contents.
2472 * @param data what to provide to @a func as callback data/context.
2473 * @param del_cb called when data is not needed anymore, either when
2474 * another callback replaces @func, the tooltip is unset with
2475 * elm_widget_item_tooltip_unset() or the owner @a item
2476 * dies. This callback receives as the first parameter the
2477 * given @a data, and @c event_info is the item.
2482 _elm_widget_item_tooltip_content_cb_set(Elm_Widget_Item *item,
2483 Elm_Tooltip_Item_Content_Cb func,
2485 Evas_Smart_Cb del_cb)
2487 Elm_Widget_Item_Tooltip *wit;
2489 ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, error_noitem);
2493 _elm_widget_item_tooltip_unset(item);
2497 wit = ELM_NEW(Elm_Widget_Item_Tooltip);
2498 if (!wit) goto error;
2502 wit->del_cb = del_cb;
2504 elm_object_sub_tooltip_content_cb_set
2505 (item->view, item->widget, _elm_widget_item_tooltip_create, wit,
2506 _elm_widget_item_tooltip_del_cb);
2511 if (del_cb) del_cb((void *)data, NULL, item);
2514 if (del_cb) del_cb((void *)data, item->widget, item);
2520 * Unset tooltip from item
2522 * @param item widget item to remove previously set tooltip.
2524 * Remove tooltip from item. The callback provided as del_cb to
2525 * elm_widget_item_tooltip_content_cb_set() will be called to notify
2526 * it is not used anymore.
2528 * @see elm_widget_item_tooltip_content_cb_set()
2533 _elm_widget_item_tooltip_unset(Elm_Widget_Item *item)
2535 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2536 elm_object_tooltip_unset(item->view);
2542 * Sets a different style for this item tooltip.
2544 * @note before you set a style you should define a tooltip with
2545 * elm_widget_item_tooltip_content_cb_set() or
2546 * elm_widget_item_tooltip_text_set()
2548 * @param item widget item with tooltip already set.
2549 * @param style the theme style to use (default, transparent, ...)
2554 _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item,
2557 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2558 elm_object_tooltip_style_set(item->view, style);
2564 * Get the style for this item tooltip.
2566 * @param item widget item with tooltip already set.
2567 * @return style the theme style in use, defaults to "default". If the
2568 * object does not have a tooltip set, then NULL is returned.
2573 _elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item)
2575 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2576 return elm_object_tooltip_style_get(item->view);
2580 _elm_widget_item_cursor_set(Elm_Widget_Item *item,
2583 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2584 elm_object_sub_cursor_set(item->view, item->widget, cursor);
2588 _elm_widget_item_cursor_get(const Elm_Widget_Item *item)
2590 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2591 return elm_object_cursor_get(item->view);
2595 _elm_widget_item_cursor_unset(Elm_Widget_Item *item)
2597 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2598 elm_object_cursor_unset(item->view);
2604 * Sets a different style for this item cursor.
2606 * @note before you set a style you should define a cursor with
2607 * elm_widget_item_cursor_set()
2609 * @param item widget item with cursor already set.
2610 * @param style the theme style to use (default, transparent, ...)
2615 _elm_widget_item_cursor_style_set(Elm_Widget_Item *item,
2618 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2619 elm_object_cursor_style_set(item->view, style);
2625 * Get the style for this item cursor.
2627 * @param item widget item with cursor already set.
2628 * @return style the theme style in use, defaults to "default". If the
2629 * object does not have a cursor set, then NULL is returned.
2634 _elm_widget_item_cursor_style_get(const Elm_Widget_Item *item)
2636 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2637 return elm_object_cursor_style_get(item->view);
2643 * Set if the cursor set should be searched on the theme or should use
2644 * the provided by the engine, only.
2646 * @note before you set if should look on theme you should define a cursor
2647 * with elm_object_cursor_set(). By default it will only look for cursors
2648 * provided by the engine.
2650 * @param item widget item with cursor already set.
2651 * @param engine_only boolean to define it cursors should be looked only
2652 * between the provided by the engine or searched on widget's theme as well.
2657 _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item,
2658 Eina_Bool engine_only)
2660 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2661 elm_object_cursor_engine_only_set(item->view, engine_only);
2667 * Get the cursor engine only usage for this item cursor.
2669 * @param item widget item with cursor already set.
2670 * @return engine_only boolean to define it cursors should be looked only
2671 * between the provided by the engine or searched on widget's theme as well. If
2672 * the object does not have a cursor set, then EINA_FALSE is returned.
2677 _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item)
2679 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, EINA_FALSE);
2680 return elm_object_cursor_engine_only_get(item->view);
2683 // smart object funcs
2685 _smart_reconfigure(Smart_Data *sd)
2689 evas_object_move(sd->resize_obj, sd->x, sd->y);
2690 evas_object_resize(sd->resize_obj, sd->w, sd->h);
2694 evas_object_move(sd->hover_obj, sd->x, sd->y);
2695 evas_object_resize(sd->hover_obj, sd->w, sd->h);
2700 _smart_add(Evas_Object *obj)
2704 sd = calloc(1, sizeof(Smart_Data));
2707 sd->x = sd->y = sd->w = sd->h = 0;
2709 sd->mirrored_auto_mode = EINA_TRUE; /* will follow system locale settings */
2710 evas_object_smart_data_set(obj, sd);
2713 static Evas_Object *
2714 _newest_focus_order_get(Evas_Object *obj,
2715 unsigned int *newest_focus_order,
2716 Eina_Bool can_focus_only)
2719 Evas_Object *child, *ret, *best;
2721 API_ENTRY return NULL;
2722 if (!evas_object_visible_get(obj)) return NULL;
2724 if (*newest_focus_order < sd->focus_order)
2726 *newest_focus_order = sd->focus_order;
2729 EINA_LIST_FOREACH(sd->subobjs, l, child)
2731 ret = _newest_focus_order_get(child, newest_focus_order, can_focus_only);
2737 if ((!best) || (!elm_widget_can_focus_get(best)))
2744 _if_focused_revert(Evas_Object *obj,
2745 Eina_Bool can_focus_only)
2748 Evas_Object *newest = NULL;
2749 unsigned int newest_focus_order = 0;
2753 if (!sd->focused) return;
2754 if (!sd->parent_obj) return;
2756 top = elm_widget_top_get(sd->parent_obj);
2759 newest = _newest_focus_order_get(top, &newest_focus_order, can_focus_only);
2762 elm_object_unfocus(newest);
2763 elm_object_focus(newest);
2769 _smart_del(Evas_Object *obj)
2772 Edje_Signal_Data *esd;
2776 if (sd->del_pre_func) sd->del_pre_func(obj);
2779 sobj = sd->resize_obj;
2780 sd->resize_obj = NULL;
2781 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2782 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2783 evas_object_del(sobj);
2787 sobj = sd->hover_obj;
2788 sd->hover_obj = NULL;
2789 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2790 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2791 evas_object_del(sobj);
2793 EINA_LIST_FREE(sd->subobjs, sobj)
2795 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2796 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2797 evas_object_del(sobj);
2799 eina_list_free(sd->tooltips); /* should be empty anyway */
2800 eina_list_free(sd->cursors); /* should be empty anyway */
2801 EINA_LIST_FREE(sd->edje_signals, esd)
2803 eina_stringshare_del(esd->emission);
2804 eina_stringshare_del(esd->source);
2807 eina_list_free(sd->event_cb); /* should be empty anyway */
2808 if (sd->del_func) sd->del_func(obj);
2809 if (sd->style) eina_stringshare_del(sd->style);
2810 if (sd->type) eina_stringshare_del(sd->type);
2811 if (sd->theme) elm_theme_free(sd->theme);
2812 _if_focused_revert(obj, EINA_TRUE);
2817 _smart_move(Evas_Object *obj,
2824 _smart_reconfigure(sd);
2828 _smart_resize(Evas_Object *obj,
2835 _smart_reconfigure(sd);
2839 _smart_show(Evas_Object *obj)
2844 if ((list = evas_object_smart_members_get(obj)))
2846 EINA_LIST_FREE(list, o)
2848 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2849 evas_object_show(o);
2855 _smart_hide(Evas_Object *obj)
2860 list = evas_object_smart_members_get(obj);
2861 EINA_LIST_FREE(list, o)
2863 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2864 evas_object_hide(o);
2869 _smart_color_set(Evas_Object *obj,
2878 if ((list = evas_object_smart_members_get(obj)))
2880 EINA_LIST_FREE(list, o)
2882 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2883 evas_object_color_set(o, r, g, b, a);
2889 _smart_clip_set(Evas_Object *obj,
2895 if ((list = evas_object_smart_members_get(obj)))
2897 EINA_LIST_FREE(list, o)
2899 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2900 evas_object_clip_set(o, clip);
2906 _smart_clip_unset(Evas_Object *obj)
2911 if ((list = evas_object_smart_members_get(obj)))
2913 EINA_LIST_FREE(list, o)
2915 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2916 evas_object_clip_unset(o);
2922 _smart_calculate(Evas_Object *obj)
2925 if (sd->changed_func) sd->changed_func(obj);
2928 /* never need to touch this */
2932 if (_e_smart) return;
2934 static const Evas_Smart_Class sc =
2937 EVAS_SMART_CLASS_VERSION,
2955 _e_smart = evas_smart_class_new(&sc);
2959 /* happy debug functions */
2962 _sub_obj_tree_dump(const Evas_Object *obj,
2967 for (i = 0; i < lvl * 3; i++)
2970 if (_elm_widget_is(obj))
2974 printf("+ %s(%p)\n",
2978 _sub_obj_tree_dump(sd->resize_obj, lvl + 1);
2979 EINA_LIST_FOREACH(sd->subobjs, l, obj)
2981 if (obj != sd->resize_obj)
2982 _sub_obj_tree_dump(obj, lvl + 1);
2986 printf("+ %s(%p)\n", evas_object_type_get(obj), obj);
2990 _sub_obj_tree_dot_dump(const Evas_Object *obj,
2993 if (!_elm_widget_is(obj))
2997 Eina_Bool visible = evas_object_visible_get(obj);
2998 Eina_Bool disabled = elm_widget_disabled_get(obj);
2999 Eina_Bool focused = elm_widget_focus_get(obj);
3000 Eina_Bool can_focus = elm_widget_can_focus_get(obj);
3004 fprintf(output, "\"%p\" -- \"%p\" [ color=black", sd->parent_obj, obj);
3007 fprintf(output, ", style=bold");
3010 fprintf(output, ", color=gray28");
3012 fprintf(output, " ];\n");
3015 fprintf(output, "\"%p\" [ label = \"{%p|%s|%s|visible: %d|"
3016 "disabled: %d|focused: %d/%d|focus order:%d}\"", obj, obj, sd->type,
3017 evas_object_name_get(obj), visible, disabled, focused, can_focus,
3021 fprintf(output, ", style=bold");
3024 fprintf(output, ", fontcolor=gray28");
3026 if ((disabled) || (!visible))
3027 fprintf(output, ", color=gray");
3029 fprintf(output, " ];\n");
3033 EINA_LIST_FOREACH(sd->subobjs, l, o)
3034 _sub_obj_tree_dot_dump(o, output);
3039 elm_widget_tree_dump(const Evas_Object *top)
3042 _sub_obj_tree_dump(top, 0);
3050 elm_widget_tree_dot_dump(const Evas_Object *top,
3054 if (!_elm_widget_is(top))
3056 fprintf(output, "graph " " { node [shape=record];\n");
3057 _sub_obj_tree_dot_dump(top, output);
3058 fprintf(output, "}\n");