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 elm_widget_focus_hide_handle(obj);
222 _sub_obj_mouse_down(void *data __UNUSED__,
225 void *event_info __UNUSED__)
227 elm_widget_focus_mouse_down_handle(obj);
231 _propagate_x_drag_lock(Evas_Object *obj,
237 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
240 sd2->child_drag_x_locked += dir;
241 _propagate_x_drag_lock(sd->parent_obj, dir);
247 _propagate_y_drag_lock(Evas_Object *obj,
253 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
256 sd2->child_drag_y_locked += dir;
257 _propagate_y_drag_lock(sd->parent_obj, dir);
263 _propagate_event(void *data,
269 Evas_Callback_Type type = (Evas_Callback_Type)(long)data;
270 Evas_Event_Flags *event_flags = NULL;
274 case EVAS_CALLBACK_KEY_DOWN:
276 Evas_Event_Key_Down *ev = event_info;
277 event_flags = &(ev->event_flags);
281 case EVAS_CALLBACK_KEY_UP:
283 Evas_Event_Key_Up *ev = event_info;
284 event_flags = &(ev->event_flags);
288 case EVAS_CALLBACK_MOUSE_WHEEL:
290 Evas_Event_Mouse_Wheel *ev = event_info;
291 event_flags = &(ev->event_flags);
299 elm_widget_event_propagate(obj, type, event_info, event_flags);
303 _parent_focus(Evas_Object *obj)
306 if (sd->focused) return;
308 Evas_Object *o = elm_widget_parent_get(obj);
309 sd->focus_order_on_calc = EINA_TRUE;
311 if (o) _parent_focus(o);
313 if (!sd->focus_order_on_calc)
314 return; /* we don't want to override it if by means of any of the
315 callbacks below one gets to calculate our order
319 sd->focus_order = focus_order;
320 sd->focused = EINA_TRUE;
321 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
322 if (sd->focus_func) sd->focus_func(obj);
324 _elm_widget_focus_region_show(obj);
326 sd->focus_order_on_calc = EINA_FALSE;
330 _elm_object_focus_chain_del_cb(void *data,
333 void *event_info __UNUSED__)
335 Smart_Data *sd = data;
337 sd->focus_chain = eina_list_remove(sd->focus_chain, obj);
340 // exposed util funcs to elm
342 _elm_widget_type_clear(void)
346 EINA_LIST_FREE(widtypes, ptr)
348 eina_stringshare_del(*ptr);
354 _elm_widget_focus_region_show(const Evas_Object *obj)
356 Evas_Coord x, y, w, h, ox, oy;
362 o = elm_widget_parent_get(obj);
365 elm_widget_focus_region_get(obj, &x, &y, &w, &h);
366 evas_object_geometry_get(obj, &ox, &oy, NULL, NULL);
370 sd2 = evas_object_smart_data_get(o);
371 if (sd2->focus_region_func)
373 sd2->focus_region_func(o, x, y, w, h);
374 elm_widget_focus_region_get(o, &x, &y, &w, &h);
378 evas_object_geometry_get(o, &px, &py, NULL, NULL);
384 o = elm_widget_parent_get(o);
389 * @defgroup Widget Widget
392 * Exposed api for making widgets
395 elm_widget_type_register(const char **ptr)
397 widtypes = eina_list_append(widtypes, (void *)ptr);
401 elm_widget_api_check(int ver)
403 if (ver != ELM_INTERNAL_API_VERSION)
405 CRITICAL("Elementary widget api versions do not match");
412 elm_widget_add(Evas *evas)
416 obj = evas_object_smart_add(evas, _e_smart);
417 elm_widget_mirrored_set(obj, elm_mirrored_get());
422 elm_widget_del_hook_set(Evas_Object *obj,
423 void (*func)(Evas_Object *obj))
430 elm_widget_del_pre_hook_set(Evas_Object *obj,
431 void (*func)(Evas_Object *obj))
434 sd->del_pre_func = func;
438 elm_widget_focus_hook_set(Evas_Object *obj,
439 void (*func)(Evas_Object *obj))
442 sd->focus_func = func;
446 elm_widget_activate_hook_set(Evas_Object *obj,
447 void (*func)(Evas_Object *obj))
450 sd->activate_func = func;
454 elm_widget_disable_hook_set(Evas_Object *obj,
455 void (*func)(Evas_Object *obj))
458 sd->disable_func = func;
462 elm_widget_theme_hook_set(Evas_Object *obj,
463 void (*func)(Evas_Object *obj))
466 sd->theme_func = func;
470 elm_widget_event_hook_set(Evas_Object *obj,
471 Eina_Bool (*func)(Evas_Object *obj,
473 Evas_Callback_Type type,
477 sd->event_func = func;
481 elm_widget_changed_hook_set(Evas_Object *obj,
482 void (*func)(Evas_Object *obj))
485 sd->changed_func = func;
489 elm_widget_signal_emit_hook_set(Evas_Object *obj,
490 void (*func)(Evas_Object *obj,
491 const char *emission,
495 sd->signal_func = func;
499 elm_widget_signal_callback_add_hook_set(Evas_Object *obj,
500 void (*func)(Evas_Object *obj,
501 const char *emission,
503 Edje_Signal_Cb func_cb,
507 sd->callback_add_func = func;
511 elm_widget_signal_callback_del_hook_set(Evas_Object *obj,
512 void (*func)(Evas_Object *obj,
513 const char *emission,
515 Edje_Signal_Cb func_cb,
519 sd->callback_del_func = func;
523 elm_widget_theme(Evas_Object *obj)
531 EINA_LIST_FOREACH(sd->subobjs, l, child) elm_widget_theme(child);
532 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
533 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
534 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
535 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
536 if (sd->theme_func) sd->theme_func(obj);
540 elm_widget_theme_specific(Evas_Object *obj,
548 Elm_Theme *th2, *thdef;
551 thdef = elm_theme_default_get();
556 if (!th2) th2 = thdef;
564 if (th2 == thdef) break;
565 th2 = th2->ref_theme;
566 if (!th2) th2 = thdef;
570 EINA_LIST_FOREACH(sd->subobjs, l, child)
571 elm_widget_theme_specific(child, th, force);
572 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
573 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
574 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
575 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
576 if (sd->theme_func) sd->theme_func(obj);
582 * Set hook to get next object in object focus chain.
584 * @param obj The widget object.
585 * @param func The hook to be used with this widget.
590 elm_widget_focus_next_hook_set(Evas_Object *obj,
591 Eina_Bool (*func)(const Evas_Object *obj,
592 Elm_Focus_Direction dir,
596 sd->focus_next_func = func;
600 * Returns the widget's mirrored mode.
602 * @param obj The widget.
603 * @return mirrored mode of the object.
607 elm_widget_mirrored_get(const Evas_Object *obj)
609 API_ENTRY return EINA_FALSE;
610 return sd->is_mirrored;
614 * Sets the widget's mirrored mode.
616 * @param obj The widget.
617 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
620 elm_widget_mirrored_set(Evas_Object *obj,
624 if (sd->is_mirrored != mirrored)
626 sd->is_mirrored = mirrored;
627 elm_widget_theme(obj);
633 * Resets the mirrored mode from the system mirror mode for widgets that are in
634 * automatic mirroring mode. This function does not call elm_widget_theme.
636 * @param obj The widget.
637 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
640 _elm_widget_mirrored_reload(Evas_Object *obj)
643 Eina_Bool mirrored = elm_mirrored_get();
644 if (elm_widget_mirrored_automatic_get(obj) && (sd->is_mirrored != mirrored))
646 sd->is_mirrored = mirrored;
651 * Returns the widget's mirrored mode setting.
653 * @param obj The widget.
654 * @return mirrored mode setting of the object.
658 elm_widget_mirrored_automatic_get(const Evas_Object *obj)
660 API_ENTRY return EINA_FALSE;
661 return sd->mirrored_auto_mode;
665 * Sets the widget's mirrored mode setting.
666 * When widget in automatic mode, it follows the system mirrored mode set by
667 * elm_mirrored_set().
668 * @param obj The widget.
669 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
672 elm_widget_mirrored_automatic_set(Evas_Object *obj,
676 if (sd->mirrored_auto_mode != automatic)
678 sd->mirrored_auto_mode = automatic;
682 elm_widget_mirrored_set(obj, elm_mirrored_get());
688 elm_widget_on_focus_hook_set(Evas_Object *obj,
689 void (*func)(void *data,
694 sd->on_focus_func = func;
695 sd->on_focus_data = data;
699 elm_widget_on_change_hook_set(Evas_Object *obj,
700 void (*func)(void *data,
705 sd->on_change_func = func;
706 sd->on_change_data = data;
710 elm_widget_on_show_region_hook_set(Evas_Object *obj,
711 void (*func)(void *data,
716 sd->on_show_region_func = func;
717 sd->on_show_region_data = data;
723 * Set the hook to use to show the focused region.
725 * Whenever a new widget gets focused or it's needed to show the focused
726 * area of the current one, this hook will be called on objects that may
727 * want to move their children into their visible area.
728 * The area given in the hook function is relative to the @p obj widget.
730 * @param obj The widget object
731 * @param func The function to call to show the specified area.
736 elm_widget_focus_region_hook_set(Evas_Object *obj,
737 void (*func)(Evas_Object *obj,
744 sd->focus_region_func = func;
750 * Set the hook to retrieve the focused region of a widget.
752 * This hook will be called by elm_widget_focus_region_get() whenever
753 * it's needed to get the focused area of a widget. The area must be relative
754 * to the widget itself and if no hook is set, it will default to the entire
757 * @param obj The widget object
758 * @param func The function used to retrieve the focus region.
763 elm_widget_on_focus_region_hook_set(Evas_Object *obj,
764 void (*func)(const Evas_Object *obj,
771 sd->on_focus_region_func = func;
775 elm_widget_data_set(Evas_Object *obj,
783 elm_widget_data_get(const Evas_Object *obj)
785 API_ENTRY return NULL;
790 elm_widget_sub_object_add(Evas_Object *obj,
794 double scale, pscale = elm_widget_scale_get(sobj);
795 Elm_Theme *th, *pth = elm_widget_theme_get(sobj);
796 Eina_Bool mirrored, pmirrored = elm_widget_mirrored_get(obj);
798 if (_elm_widget_is(sobj))
800 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
803 if (sd2->parent_obj == obj)
806 elm_widget_sub_object_del(sd2->parent_obj, sobj);
807 sd2->parent_obj = obj;
808 if (!sd->child_can_focus && (_is_focusable(sobj)))
809 sd->child_can_focus = EINA_TRUE;
814 void *data = evas_object_data_get(sobj, "elm-parent");
817 if (data == obj) return;
818 evas_object_event_callback_del(sobj, EVAS_CALLBACK_DEL,
823 sd->subobjs = eina_list_append(sd->subobjs, sobj);
824 evas_object_data_set(sobj, "elm-parent", obj);
825 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
826 if (_elm_widget_is(sobj))
827 evas_object_event_callback_add(sobj, EVAS_CALLBACK_HIDE, _sub_obj_hide, sd);
828 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
829 scale = elm_widget_scale_get(sobj);
830 th = elm_widget_theme_get(sobj);
831 mirrored = elm_widget_mirrored_get(sobj);
832 if ((scale != pscale) || (th != pth) || (pmirrored != mirrored)) elm_widget_theme(sobj);
833 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
837 elm_widget_sub_object_del(Evas_Object *obj,
840 Evas_Object *sobj_parent;
844 sobj_parent = evas_object_data_del(sobj, "elm-parent");
845 if (sobj_parent != obj)
847 static int abort_on_warn = -1;
848 ERR("removing sub object %p from parent %p, "
849 "but elm-parent is different %p!",
850 sobj, obj, sobj_parent);
851 if (EINA_UNLIKELY(abort_on_warn == -1))
853 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
854 else abort_on_warn = 0;
856 if (abort_on_warn == 1) abort();
858 if (!sd->child_can_focus)
860 if (_is_focusable(sobj)) sd->child_can_focus = 0;
862 if (_elm_widget_is(sobj))
864 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
867 sd2->parent_obj = NULL;
868 if (sd2->resize_obj == sobj)
869 sd2->resize_obj = NULL;
871 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
874 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
875 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
878 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
879 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
881 if (_elm_widget_is(sobj))
882 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
884 evas_object_smart_callback_call(obj, "sub-object-del", sobj);
888 elm_widget_resize_object_set(Evas_Object *obj,
892 // orphan previous resize obj
895 evas_object_clip_unset(sd->resize_obj);
896 evas_object_data_del(sd->resize_obj, "elm-parent");
897 if (_elm_widget_is(sd->resize_obj))
899 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
900 if (sd2) sd2->parent_obj = NULL;
901 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_HIDE,
904 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_DEL,
906 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_MOUSE_DOWN,
907 _sub_obj_mouse_down, sd);
908 evas_object_smart_member_del(sd->resize_obj);
909 if (_elm_widget_is(sd->resize_obj))
911 if (elm_widget_focus_get(sd->resize_obj)) _unfocus_parents(obj);
914 // orphan new resize obj
917 evas_object_data_del(sobj, "elm-parent");
918 if (_elm_widget_is(sobj))
920 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
921 if (sd2) sd2->parent_obj = NULL;
922 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
925 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
927 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_MOUSE_DOWN,
928 _sub_obj_mouse_down, sd);
929 evas_object_smart_member_del(sobj);
930 if (_elm_widget_is(sobj))
932 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
935 // set the resize obj up
936 sd->resize_obj = sobj;
939 if (_elm_widget_is(sd->resize_obj))
941 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
942 if (sd2) sd2->parent_obj = obj;
943 evas_object_event_callback_add(sobj, EVAS_CALLBACK_HIDE,
946 evas_object_clip_set(sobj, evas_object_clip_get(obj));
947 evas_object_smart_member_add(sobj, obj);
948 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
950 evas_object_event_callback_add(sobj, EVAS_CALLBACK_MOUSE_DOWN,
951 _sub_obj_mouse_down, sd);
952 _smart_reconfigure(sd);
953 evas_object_data_set(sobj, "elm-parent", obj);
954 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
955 if (_elm_widget_is(sobj))
957 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
963 elm_widget_hover_object_set(Evas_Object *obj,
969 evas_object_event_callback_del_full(sd->hover_obj, EVAS_CALLBACK_DEL,
972 sd->hover_obj = sobj;
975 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
977 _smart_reconfigure(sd);
982 elm_widget_can_focus_set(Evas_Object *obj,
986 sd->can_focus = can_focus;
989 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN,
991 (void *)(long)EVAS_CALLBACK_KEY_DOWN);
992 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_UP,
994 (void *)(long)EVAS_CALLBACK_KEY_UP);
995 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOUSE_WHEEL,
997 (void *)(long)EVAS_CALLBACK_MOUSE_WHEEL);
1001 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_DOWN,
1003 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_UP,
1005 evas_object_event_callback_del(obj, EVAS_CALLBACK_MOUSE_WHEEL,
1011 elm_widget_can_focus_get(const Evas_Object *obj)
1013 API_ENTRY return EINA_FALSE;
1014 return sd->can_focus;
1018 elm_widget_child_can_focus_get(const Evas_Object *obj)
1020 API_ENTRY return EINA_FALSE;
1021 return sd->child_can_focus;
1025 elm_widget_highlight_ignore_set(Evas_Object *obj,
1029 sd->highlight_ignore = !!ignore;
1033 elm_widget_highlight_ignore_get(const Evas_Object *obj)
1035 API_ENTRY return EINA_FALSE;
1036 return sd->highlight_ignore;
1040 elm_widget_highlight_in_theme_set(Evas_Object *obj,
1041 Eina_Bool highlight)
1044 sd->highlight_in_theme = !!highlight;
1045 /* FIXME: if focused, it should switch from one mode to the other */
1049 elm_widget_highlight_in_theme_get(const Evas_Object *obj)
1051 API_ENTRY return EINA_FALSE;
1052 return sd->highlight_in_theme;
1056 elm_widget_focus_get(const Evas_Object *obj)
1058 API_ENTRY return EINA_FALSE;
1063 elm_widget_focused_object_get(const Evas_Object *obj)
1065 const Evas_Object *subobj;
1067 API_ENTRY return NULL;
1069 if (!sd->focused) return NULL;
1070 EINA_LIST_FOREACH(sd->subobjs, l, subobj)
1072 Evas_Object *fobj = elm_widget_focused_object_get(subobj);
1073 if (fobj) return fobj;
1075 return (Evas_Object *)obj;
1079 elm_widget_top_get(const Evas_Object *obj)
1081 API_ENTRY return NULL;
1082 if (sd->parent_obj) return elm_widget_top_get(sd->parent_obj);
1083 return (Evas_Object *)obj;
1087 elm_widget_is(const Evas_Object *obj)
1089 return _elm_widget_is(obj);
1093 elm_widget_parent_widget_get(const Evas_Object *obj)
1095 Evas_Object *parent;
1097 if (_elm_widget_is(obj))
1099 Smart_Data *sd = evas_object_smart_data_get(obj);
1100 if (!sd) return NULL;
1101 parent = sd->parent_obj;
1105 parent = evas_object_data_get(obj, "elm-parent");
1106 if (!parent) parent = evas_object_smart_parent_get(obj);
1111 Evas_Object *elm_parent;
1112 if (_elm_widget_is(parent)) break;
1113 elm_parent = evas_object_data_get(parent, "elm-parent");
1114 if (elm_parent) parent = elm_parent;
1115 else parent = evas_object_smart_parent_get(parent);
1121 elm_widget_event_callback_add(Evas_Object *obj,
1126 EINA_SAFETY_ON_NULL_RETURN(func);
1127 Elm_Event_Cb_Data *ecb = ELM_NEW(Elm_Event_Cb_Data);
1130 sd->event_cb = eina_list_append(sd->event_cb, ecb);
1134 elm_widget_event_callback_del(Evas_Object *obj,
1138 API_ENTRY return NULL;
1139 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
1141 Elm_Event_Cb_Data *ecd;
1142 EINA_LIST_FOREACH(sd->event_cb, l, ecd)
1143 if ((ecd->func == func) && (ecd->data == data))
1146 sd->event_cb = eina_list_remove_list(sd->event_cb, l);
1147 return (void *)data;
1153 elm_widget_event_propagate(Evas_Object *obj,
1154 Evas_Callback_Type type,
1156 Evas_Event_Flags *event_flags)
1158 API_ENTRY return EINA_FALSE; //TODO reduce.
1159 if (!_elm_widget_is(obj)) return EINA_FALSE;
1160 Evas_Object *parent = obj;
1161 Elm_Event_Cb_Data *ecd;
1162 Eina_List *l, *l_prev;
1165 (!(event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD))))
1167 sd = evas_object_smart_data_get(parent);
1168 if ((!sd) || (!_elm_widget_is(obj)))
1169 return EINA_FALSE; //Not Elm Widget
1171 if (sd->event_func && (sd->event_func(parent, obj, type, event_info)))
1174 EINA_LIST_FOREACH_SAFE(sd->event_cb, l, l_prev, ecd)
1176 if (ecd->func((void *)ecd->data, parent, obj, type, event_info) ||
1177 (event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD)))
1180 parent = sd->parent_obj;
1189 * Set custom focus chain.
1191 * This function i set one new and overwrite any previous custom focus chain
1192 * with the list of objects. The previous list will be deleted and this list
1193 * will be managed. After setted, don't modity it.
1195 * @note On focus cycle, only will be evaluated children of this container.
1197 * @param obj The container widget
1198 * @param objs Chain of objects to pass focus
1202 elm_widget_focus_custom_chain_set(Evas_Object *obj,
1206 if (!sd->focus_next_func)
1209 elm_widget_focus_custom_chain_unset(obj);
1214 EINA_LIST_FOREACH(objs, l, o)
1216 evas_object_event_callback_add(o, EVAS_CALLBACK_DEL,
1217 _elm_object_focus_chain_del_cb, sd);
1220 sd->focus_chain = objs;
1226 * Get custom focus chain
1228 * @param obj The container widget
1231 EAPI const Eina_List *
1232 elm_widget_focus_custom_chain_get(const Evas_Object *obj)
1234 API_ENTRY return NULL;
1235 return (const Eina_List *)sd->focus_chain;
1241 * Unset custom focus chain
1243 * @param obj The container widget
1247 elm_widget_focus_custom_chain_unset(Evas_Object *obj)
1250 Eina_List *l, *l_next;
1253 EINA_LIST_FOREACH_SAFE(sd->focus_chain, l, l_next, o)
1255 evas_object_event_callback_del_full(o, EVAS_CALLBACK_DEL,
1256 _elm_object_focus_chain_del_cb, sd);
1257 sd->focus_chain = eina_list_remove_list(sd->focus_chain, l);
1264 * Append object to custom focus chain.
1266 * @note If relative_child equal to NULL or not in custom chain, the object
1267 * will be added in end.
1269 * @note On focus cycle, only will be evaluated children of this container.
1271 * @param obj The container widget
1272 * @param child The child to be added in custom chain
1273 * @param relative_child The relative object to position the child
1277 elm_widget_focus_custom_chain_append(Evas_Object *obj,
1279 Evas_Object *relative_child)
1282 EINA_SAFETY_ON_NULL_RETURN(child);
1283 if (!sd->focus_next_func)
1286 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1287 _elm_object_focus_chain_del_cb, sd);
1289 if (!relative_child)
1291 sd->focus_chain = eina_list_append(sd->focus_chain, child);
1295 sd->focus_chain = eina_list_append_relative(sd->focus_chain, child, relative_child);
1302 * Prepend object to custom focus chain.
1304 * @note If relative_child equal to NULL or not in custom chain, the object
1305 * will be added in begin.
1307 * @note On focus cycle, only will be evaluated children of this container.
1309 * @param obj The container widget
1310 * @param child The child to be added in custom chain
1311 * @param relative_child The relative object to position the child
1315 elm_widget_focus_custom_chain_prepend(Evas_Object *obj,
1317 Evas_Object *relative_child)
1320 EINA_SAFETY_ON_NULL_RETURN(child);
1321 if (!sd->focus_next_func)
1324 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1325 _elm_object_focus_chain_del_cb, sd);
1327 if (!relative_child)
1329 sd->focus_chain = eina_list_prepend(sd->focus_chain, child);
1333 sd->focus_chain = eina_list_prepend_relative(sd->focus_chain, child, relative_child);
1340 * Give focus to next object in object tree.
1342 * Give focus to next object in focus chain of one object sub-tree.
1343 * If the last object of chain already have focus, the focus will go to the
1344 * first object of chain.
1346 * @param obj The widget root of sub-tree
1347 * @param dir Direction to cycle the focus
1352 elm_widget_focus_cycle(Evas_Object *obj,
1353 Elm_Focus_Direction dir)
1355 Evas_Object *target = NULL;
1356 if (!_elm_widget_is(obj))
1358 elm_widget_focus_next_get(obj, dir, &target);
1360 elm_widget_focus_steal(target);
1366 * Give focus to near object in one direction.
1368 * Give focus to near object in direction of one object.
1369 * If none focusable object in given direction, the focus will not change.
1371 * @param obj The reference widget
1372 * @param x Horizontal component of direction to focus
1373 * @param y Vertical component of direction to focus
1378 elm_widget_focus_direction_go(Evas_Object *obj __UNUSED__,
1388 * Get next object in focus chain of object tree.
1390 * Get next object in focus chain of one object sub-tree.
1391 * Return the next object by reference. If don't have any candidate to receive
1392 * focus before chain end, the first candidate will be returned.
1394 * @param obj The widget root of sub-tree
1395 * @param dir Direction os focus chain
1396 * @param next The next object in focus chain
1397 * @return EINA_TRUE if don't need focus chain restart/loop back
1398 * to use 'next' obj.
1403 elm_widget_focus_next_get(const Evas_Object *obj,
1404 Elm_Focus_Direction dir,
1411 API_ENTRY return EINA_FALSE;
1413 /* Ignore if disabled */
1414 if ((!evas_object_visible_get(obj)) || (elm_widget_disabled_get(obj)))
1418 if (sd->focus_next_func)
1419 return sd->focus_next_func(obj, dir, next);
1421 if (!elm_widget_can_focus_get(obj))
1425 *next = (Evas_Object *)obj;
1426 return !elm_widget_focus_get(obj);
1432 * Get next object in focus chain of object tree in list.
1434 * Get next object in focus chain of one object sub-tree ordered by one list.
1435 * Return the next object by reference. If don't have any candidate to receive
1436 * focus before list end, the first candidate will be returned.
1438 * @param obj The widget root of sub-tree
1439 * @param dir Direction os focus chain
1440 * @param items list with ordered objects
1441 * @param list_data_get function to get the object from one item of list
1442 * @param next The next object in focus chain
1443 * @return EINA_TRUE if don't need focus chain restart/loop back
1444 * to use 'next' obj.
1449 elm_widget_focus_list_next_get(const Evas_Object *obj,
1450 const Eina_List *items,
1451 void *(*list_data_get)(const Eina_List * list),
1452 Elm_Focus_Direction dir,
1455 Eina_List *(*list_next)(const Eina_List * list);
1461 if (!_elm_widget_is(obj))
1468 if (dir == ELM_FOCUS_PREVIOUS)
1470 items = eina_list_last(items);
1471 list_next = eina_list_prev;
1473 else if (dir == ELM_FOCUS_NEXT)
1474 list_next = eina_list_next;
1478 const Eina_List *l = items;
1480 /* Recovery last focused sub item */
1481 if (elm_widget_focus_get(obj))
1482 for (; l; l = list_next(l))
1484 Evas_Object *cur = list_data_get(l);
1485 if (elm_widget_focus_get(cur)) break;
1488 const Eina_List *start = l;
1489 Evas_Object *to_focus = NULL;
1491 /* Interate sub items */
1492 /* Go to end of list */
1493 for (; l; l = list_next(l))
1495 Evas_Object *tmp = NULL;
1496 Evas_Object *cur = list_data_get(l);
1498 if (elm_widget_parent_get(cur) != obj)
1501 /* Try Focus cycle in subitem */
1502 if (elm_widget_focus_next_get(cur, dir, &tmp))
1507 else if ((tmp) && (!to_focus))
1513 /* Get First possible */
1514 for (; l != start; l = list_next(l))
1516 Evas_Object *tmp = NULL;
1517 Evas_Object *cur = list_data_get(l);
1519 if (elm_widget_parent_get(cur) != obj)
1522 /* Try Focus cycle in subitem */
1523 elm_widget_focus_next_get(cur, dir, &tmp);
1536 elm_widget_signal_emit(Evas_Object *obj,
1537 const char *emission,
1541 if (!sd->signal_func) return;
1542 sd->signal_func(obj, emission, source);
1546 _edje_signal_callback(void *data,
1547 Evas_Object *obj __UNUSED__,
1548 const char *emission,
1551 Edje_Signal_Data *esd = data;
1552 esd->func(esd->data, esd->obj, emission, source);
1556 elm_widget_signal_callback_add(Evas_Object *obj,
1557 const char *emission,
1559 Edje_Signal_Cb func,
1562 Edje_Signal_Data *esd;
1564 if (!sd->callback_add_func) return;
1565 EINA_SAFETY_ON_NULL_RETURN(func);
1567 esd = ELM_NEW(Edje_Signal_Data);
1572 esd->emission = eina_stringshare_add(emission);
1573 esd->source = eina_stringshare_add(source);
1575 sd->edje_signals = eina_list_append(sd->edje_signals, esd);
1576 sd->callback_add_func(obj, emission, source, _edje_signal_callback, esd);
1580 elm_widget_signal_callback_del(Evas_Object *obj,
1581 const char *emission,
1583 Edje_Signal_Cb func)
1585 Edje_Signal_Data *esd;
1588 API_ENTRY return NULL;
1589 if (!sd->callback_del_func) return NULL;
1591 EINA_LIST_FOREACH(sd->edje_signals, l, esd)
1593 if ((esd->func == func) && (!strcmp(esd->emission, emission)) &&
1594 (!strcmp(esd->source, source)))
1596 sd->edje_signals = eina_list_remove_list(sd->edje_signals, l);
1597 eina_stringshare_del(esd->emission);
1598 eina_stringshare_del(esd->source);
1604 sd->callback_del_func(obj, emission, source, _edje_signal_callback, esd);
1609 elm_widget_focus_set(Evas_Object *obj,
1616 sd->focus_order = focus_order;
1617 sd->focused = EINA_TRUE;
1618 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1622 sd->focus_func(obj);
1629 if ((_is_focusable(sd->resize_obj)) &&
1630 (!elm_widget_disabled_get(sd->resize_obj)))
1632 elm_widget_focus_set(sd->resize_obj, first);
1638 EINA_LIST_FOREACH(sd->subobjs, l, child)
1640 if ((_is_focusable(child)) &&
1641 (!elm_widget_disabled_get(child)))
1643 elm_widget_focus_set(child, first);
1653 EINA_LIST_REVERSE_FOREACH(sd->subobjs, l, child)
1655 if ((_is_focusable(child)) &&
1656 (!elm_widget_disabled_get(child)))
1658 elm_widget_focus_set(child, first);
1664 if ((_is_focusable(sd->resize_obj)) &&
1665 (!elm_widget_disabled_get(sd->resize_obj)))
1667 elm_widget_focus_set(sd->resize_obj, first);
1675 elm_widget_parent_get(const Evas_Object *obj)
1677 API_ENTRY return NULL;
1678 return sd->parent_obj;
1682 elm_widget_focused_object_clear(Evas_Object *obj)
1685 if (!sd->focused) return;
1686 if (elm_widget_focus_get(sd->resize_obj))
1687 elm_widget_focused_object_clear(sd->resize_obj);
1692 EINA_LIST_FOREACH(sd->subobjs, l, child)
1694 if (elm_widget_focus_get(child))
1696 elm_widget_focused_object_clear(child);
1701 sd->focused = EINA_FALSE;
1702 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1703 if (sd->focus_func) sd->focus_func(obj);
1707 elm_widget_focus_steal(Evas_Object *obj)
1709 Evas_Object *parent, *o;
1712 if (sd->focused) return;
1713 if (sd->disabled) return;
1717 o = elm_widget_parent_get(parent);
1719 sd = evas_object_smart_data_get(o);
1720 if (sd->focused) break;
1723 if (!elm_widget_parent_get(parent))
1724 elm_widget_focused_object_clear(parent);
1727 parent = elm_widget_parent_get(parent);
1728 sd = evas_object_smart_data_get(parent);
1729 if ((sd->resize_obj) && (elm_widget_focus_get(sd->resize_obj)))
1730 elm_widget_focused_object_clear(sd->resize_obj);
1735 EINA_LIST_FOREACH(sd->subobjs, l, child)
1737 if (elm_widget_focus_get(child))
1739 elm_widget_focused_object_clear(child);
1750 elm_widget_activate(Evas_Object *obj)
1753 elm_widget_change(obj);
1754 if (sd->activate_func) sd->activate_func(obj);
1758 elm_widget_change(Evas_Object *obj)
1761 elm_widget_change(elm_widget_parent_get(obj));
1762 if (sd->on_change_func) sd->on_change_func(sd->on_change_data, obj);
1766 elm_widget_disabled_set(Evas_Object *obj,
1771 if (sd->disabled == disabled) return;
1772 sd->disabled = !!disabled;
1775 Evas_Object *o, *parent;
1780 o = elm_widget_parent_get(parent);
1784 if (elm_widget_focus_get(obj))
1785 elm_widget_focus_cycle(parent, ELM_FOCUS_NEXT);
1787 if (sd->disable_func) sd->disable_func(obj);
1791 elm_widget_disabled_get(const Evas_Object *obj)
1794 return sd->disabled;
1798 elm_widget_show_region_set(Evas_Object *obj,
1804 Evas_Object *parent_obj, *child_obj;
1805 Evas_Coord px, py, cx, cy;
1808 if ((x == sd->rx) && (y == sd->ry) && (w == sd->rw) && (h == sd->rh)) return;
1813 if (sd->on_show_region_func)
1814 sd->on_show_region_func(sd->on_show_region_data, obj);
1818 parent_obj = sd->parent_obj;
1819 child_obj = sd->obj;
1820 if ((!parent_obj) || (!_elm_widget_is(parent_obj))) break;
1821 sd = evas_object_smart_data_get(parent_obj);
1824 evas_object_geometry_get(parent_obj, &px, &py, NULL, NULL);
1825 evas_object_geometry_get(child_obj, &cx, &cy, NULL, NULL);
1834 if (sd->on_show_region_func)
1836 sd->on_show_region_func(sd->on_show_region_data, parent_obj);
1843 elm_widget_show_region_get(const Evas_Object *obj,
1859 * Get the focus region of the given widget.
1861 * The focus region is the area of a widget that should brought into the
1862 * visible area when the widget is focused. Mostly used to show the part of
1863 * an entry where the cursor is, for example. The area returned is relative
1864 * to the object @p obj.
1865 * If the @p obj doesn't have the proper on_focus_region_hook set, this
1866 * function will return the full size of the object.
1868 * @param obj The widget object
1869 * @param x Where to store the x coordinate of the area
1870 * @param y Where to store the y coordinate of the area
1871 * @param w Where to store the width of the area
1872 * @param h Where to store the height of the area
1877 elm_widget_focus_region_get(const Evas_Object *obj,
1887 sd = evas_object_smart_data_get(obj);
1888 if (!sd || !_elm_widget_is(obj) || !sd->on_focus_region_func)
1890 evas_object_geometry_get(obj, NULL, NULL, w, h);
1895 sd->on_focus_region_func(obj, x, y, w, h);
1899 elm_widget_scroll_hold_push(Evas_Object *obj)
1903 if (sd->scroll_hold == 1)
1904 evas_object_smart_callback_call(obj, "scroll-hold-on", obj);
1905 if (sd->parent_obj) elm_widget_scroll_hold_push(sd->parent_obj);
1906 // FIXME: on delete/reparent hold pop
1910 elm_widget_scroll_hold_pop(Evas_Object *obj)
1914 if (sd->scroll_hold < 0) sd->scroll_hold = 0;
1915 if (!sd->scroll_hold)
1916 evas_object_smart_callback_call(obj, "scroll-hold-off", obj);
1917 if (sd->parent_obj) elm_widget_scroll_hold_pop(sd->parent_obj);
1921 elm_widget_scroll_hold_get(const Evas_Object *obj)
1924 return sd->scroll_hold;
1928 elm_widget_scroll_freeze_push(Evas_Object *obj)
1931 sd->scroll_freeze++;
1932 if (sd->scroll_freeze == 1)
1933 evas_object_smart_callback_call(obj, "scroll-freeze-on", obj);
1934 if (sd->parent_obj) elm_widget_scroll_freeze_push(sd->parent_obj);
1935 // FIXME: on delete/reparent freeze pop
1939 elm_widget_scroll_freeze_pop(Evas_Object *obj)
1942 sd->scroll_freeze--;
1943 if (sd->scroll_freeze < 0) sd->scroll_freeze = 0;
1944 if (!sd->scroll_freeze)
1945 evas_object_smart_callback_call(obj, "scroll-freeze-off", obj);
1946 if (sd->parent_obj) elm_widget_scroll_freeze_pop(sd->parent_obj);
1950 elm_widget_scroll_freeze_get(const Evas_Object *obj)
1953 return sd->scroll_freeze;
1957 elm_widget_scale_set(Evas_Object *obj,
1961 if (scale <= 0.0) scale = 0.0;
1962 if (sd->scale != scale)
1965 elm_widget_theme(obj);
1970 elm_widget_scale_get(const Evas_Object *obj)
1972 API_ENTRY return 1.0;
1973 // FIXME: save walking up the tree by storing/caching parent scale
1974 if (sd->scale == 0.0)
1977 return elm_widget_scale_get(sd->parent_obj);
1985 elm_widget_theme_set(Evas_Object *obj,
1989 if (sd->theme != th)
1991 if (sd->theme) elm_theme_free(sd->theme);
1994 elm_widget_theme(obj);
1999 elm_widget_theme_get(const Evas_Object *obj)
2001 API_ENTRY return NULL;
2005 return elm_widget_theme_get(sd->parent_obj);
2013 elm_widget_style_set(Evas_Object *obj,
2018 if (eina_stringshare_replace(&sd->style, style))
2019 elm_widget_theme(obj);
2023 elm_widget_style_get(const Evas_Object *obj)
2025 API_ENTRY return NULL;
2026 if (sd->style) return sd->style;
2031 elm_widget_type_set(Evas_Object *obj,
2035 eina_stringshare_replace(&sd->type, type);
2039 elm_widget_type_get(const Evas_Object *obj)
2041 API_ENTRY return NULL;
2042 if (sd->type) return sd->type;
2047 elm_widget_tooltip_add(Evas_Object *obj,
2051 sd->tooltips = eina_list_append(sd->tooltips, tt);
2055 elm_widget_tooltip_del(Evas_Object *obj,
2059 sd->tooltips = eina_list_remove(sd->tooltips, tt);
2063 elm_widget_cursor_add(Evas_Object *obj,
2067 sd->cursors = eina_list_append(sd->cursors, cur);
2071 elm_widget_cursor_del(Evas_Object *obj,
2075 sd->cursors = eina_list_remove(sd->cursors, cur);
2079 elm_widget_drag_lock_x_set(Evas_Object *obj,
2083 if (sd->drag_x_locked == lock) return;
2084 sd->drag_x_locked = lock;
2085 if (sd->drag_x_locked) _propagate_x_drag_lock(obj, 1);
2086 else _propagate_x_drag_lock(obj, -1);
2090 elm_widget_drag_lock_y_set(Evas_Object *obj,
2094 if (sd->drag_y_locked == lock) return;
2095 sd->drag_y_locked = lock;
2096 if (sd->drag_y_locked) _propagate_y_drag_lock(obj, 1);
2097 else _propagate_y_drag_lock(obj, -1);
2101 elm_widget_drag_lock_x_get(const Evas_Object *obj)
2103 API_ENTRY return EINA_FALSE;
2104 return sd->drag_x_locked;
2108 elm_widget_drag_lock_y_get(const Evas_Object *obj)
2110 API_ENTRY return EINA_FALSE;
2111 return sd->drag_y_locked;
2115 elm_widget_drag_child_locked_x_get(const Evas_Object *obj)
2118 return sd->child_drag_x_locked;
2122 elm_widget_drag_child_locked_y_get(const Evas_Object *obj)
2125 return sd->child_drag_y_locked;
2129 elm_widget_theme_object_set(Evas_Object *obj,
2132 const char *welement,
2135 API_ENTRY return EINA_FALSE;
2136 return _elm_theme_object_set(obj, edj, wname, welement, wstyle);
2140 elm_widget_type_check(const Evas_Object *obj,
2143 const char *provided, *expected = "(unknown)";
2144 static int abort_on_warn = -1;
2145 provided = elm_widget_type_get(obj);
2146 if (EINA_LIKELY(provided == type)) return EINA_TRUE;
2147 if (type) expected = type;
2148 if ((!provided) || (!provided[0]))
2150 provided = evas_object_type_get(obj);
2151 if ((!provided) || (!provided[0]))
2152 provided = "(unknown)";
2154 ERR("Passing Object: %p, of type: '%s' when expecting type: '%s'", obj, provided, expected);
2155 if (abort_on_warn == -1)
2157 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
2158 else abort_on_warn = 0;
2160 if (abort_on_warn == 1) abort();
2167 * Split string in words
2169 * @param str Source string
2170 * @return List of const words
2172 * @see elm_widget_stringlist_free()
2176 elm_widget_stringlist_get(const char *str)
2178 Eina_List *list = NULL;
2180 if (!str) return NULL;
2181 for (b = s = str; 1; s++)
2183 if ((*s == ' ') || (!*s))
2185 char *t = malloc(s - b + 1);
2188 strncpy(t, b, s - b);
2190 list = eina_list_append(list, eina_stringshare_add(t));
2201 elm_widget_stringlist_free(Eina_List *list)
2204 EINA_LIST_FREE(list, s) eina_stringshare_del(s);
2208 elm_widget_focus_hide_handle(Evas_Object *obj)
2210 _if_focused_revert(obj, EINA_TRUE);
2214 elm_widget_focus_mouse_down_handle(Evas_Object *obj)
2216 Evas_Object *o = obj;
2219 if (_elm_widget_is(o)) break;
2220 o = evas_object_smart_parent_get(o);
2224 if (!_is_focusable(o)) return;
2225 elm_widget_focus_steal(o);
2231 * Allocate a new Elm_Widget_Item-derived structure.
2233 * The goal of this structure is to provide common ground for actions
2234 * that a widget item have, such as the owner widget, callback to
2235 * notify deletion, data pointer and maybe more.
2237 * @param widget the owner widget that holds this item, must be an elm_widget!
2238 * @param alloc_size any number greater than sizeof(Elm_Widget_Item) that will
2239 * be used to allocate memory.
2241 * @return allocated memory that is already zeroed out, or NULL on errors.
2243 * @see elm_widget_item_new() convenience macro.
2244 * @see elm_widget_item_del() to release memory.
2247 EAPI Elm_Widget_Item *
2248 _elm_widget_item_new(Evas_Object *widget,
2251 if (!_elm_widget_is(widget))
2254 Elm_Widget_Item *item;
2256 EINA_SAFETY_ON_TRUE_RETURN_VAL(alloc_size < sizeof(Elm_Widget_Item), NULL);
2257 EINA_SAFETY_ON_TRUE_RETURN_VAL(!_elm_widget_is(widget), NULL);
2259 item = calloc(1, alloc_size);
2260 EINA_SAFETY_ON_NULL_RETURN_VAL(item, NULL);
2262 EINA_MAGIC_SET(item, ELM_WIDGET_ITEM_MAGIC);
2263 item->widget = widget;
2270 * Releases widget item memory, calling back del_cb() if it exists.
2272 * If there is a Elm_Widget_Item::del_cb, then it will be called prior
2273 * to memory release. Note that elm_widget_item_pre_notify_del() calls
2274 * this function and then unset it, thus being useful for 2 step
2275 * cleanup whenever the del_cb may use any of the data that must be
2276 * deleted from item.
2278 * The Elm_Widget_Item::view will be deleted (evas_object_del()) if it
2281 * @param item a valid #Elm_Widget_Item to be deleted.
2282 * @see elm_widget_item_del() convenience macro.
2286 _elm_widget_item_del(Elm_Widget_Item *item)
2288 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2291 item->del_cb((void *)item->data, item->widget, item);
2294 evas_object_del(item->view);
2296 EINA_MAGIC_SET(item, EINA_MAGIC_NONE);
2303 * Notify object will be deleted without actually deleting it.
2305 * This function will callback Elm_Widget_Item::del_cb if it is set
2306 * and then unset it so it is not called twice (ie: from
2307 * elm_widget_item_del()).
2309 * @param item a valid #Elm_Widget_Item to be notified
2310 * @see elm_widget_item_pre_notify_del() convenience macro.
2314 _elm_widget_item_pre_notify_del(Elm_Widget_Item *item)
2316 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2317 if (!item->del_cb) return;
2318 item->del_cb((void *)item->data, item->widget, item);
2319 item->del_cb = NULL;
2325 * Set the function to notify when item is being deleted.
2327 * This function will complain if there was a callback set already,
2328 * however it will set the new one.
2330 * The callback will be called from elm_widget_item_pre_notify_del()
2331 * or elm_widget_item_del() will be called with:
2332 * - data: the Elm_Widget_Item::data value.
2333 * - obj: the Elm_Widget_Item::widget evas object.
2334 * - event_info: the item being deleted.
2336 * @param item a valid #Elm_Widget_Item to be notified
2337 * @see elm_widget_item_del_cb_set() convenience macro.
2341 _elm_widget_item_del_cb_set(Elm_Widget_Item *item,
2342 Evas_Smart_Cb del_cb)
2344 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2346 if ((item->del_cb) && (item->del_cb != del_cb))
2347 WRN("You're replacing a previously set del_cb %p of item %p with %p",
2348 item->del_cb, item, del_cb);
2350 item->del_cb = del_cb;
2356 * Set user-data in this item.
2358 * User data may be used to identify this item or just store any
2359 * application data. It is automatically given as the first parameter
2360 * of the deletion notify callback.
2362 * @param item a valid #Elm_Widget_Item to store data in.
2363 * @param data user data to store.
2364 * @see elm_widget_item_del_cb_set() convenience macro.
2368 _elm_widget_item_data_set(Elm_Widget_Item *item,
2371 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2372 if ((item->data) && (item->data != data))
2373 DBG("Replacing item %p data %p with %p", item, item->data, data);
2380 * Retrieves user-data of this item.
2382 * @param item a valid #Elm_Widget_Item to get data from.
2383 * @see elm_widget_item_data_set()
2387 _elm_widget_item_data_get(const Elm_Widget_Item *item)
2389 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2390 return (void *)item->data;
2393 typedef struct _Elm_Widget_Item_Tooltip Elm_Widget_Item_Tooltip;
2395 struct _Elm_Widget_Item_Tooltip
2397 Elm_Widget_Item *item;
2398 Elm_Tooltip_Item_Content_Cb func;
2399 Evas_Smart_Cb del_cb;
2403 static Evas_Object *
2404 _elm_widget_item_tooltip_label_create(void *data,
2406 void *item __UNUSED__)
2408 Evas_Object *label = elm_label_add(obj);
2411 elm_object_style_set(label, "tooltip");
2412 elm_label_label_set(label, data);
2417 _elm_widget_item_tooltip_label_del_cb(void *data,
2418 Evas_Object *obj __UNUSED__,
2419 void *event_info __UNUSED__)
2421 eina_stringshare_del(data);
2427 * Set the text to be shown in the widget item.
2429 * @param item Target item
2430 * @param text The text to set in the content
2432 * Setup the text as tooltip to object. The item can have only one tooltip,
2433 * so any previous tooltip data is removed.
2438 _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item,
2441 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2442 EINA_SAFETY_ON_NULL_RETURN(text);
2444 text = eina_stringshare_add(text);
2445 _elm_widget_item_tooltip_content_cb_set
2446 (item, _elm_widget_item_tooltip_label_create, text,
2447 _elm_widget_item_tooltip_label_del_cb);
2450 static Evas_Object *
2451 _elm_widget_item_tooltip_create(void *data,
2454 Elm_Widget_Item_Tooltip *wit = data;
2455 return wit->func((void *)wit->data, obj, wit->item);
2459 _elm_widget_item_tooltip_del_cb(void *data,
2461 void *event_info __UNUSED__)
2463 Elm_Widget_Item_Tooltip *wit = data;
2464 if (wit->del_cb) wit->del_cb((void *)wit->data, obj, wit->item);
2471 * Set the content to be shown in the tooltip item
2473 * Setup the tooltip to item. The item can have only one tooltip,
2474 * so any previous tooltip data is removed. @p func(with @p data) will
2475 * be called every time that need show the tooltip and it should
2476 * return a valid Evas_Object. This object is then managed fully by
2477 * tooltip system and is deleted when the tooltip is gone.
2479 * @param item the widget item being attached a tooltip.
2480 * @param func the function used to create the tooltip contents.
2481 * @param data what to provide to @a func as callback data/context.
2482 * @param del_cb called when data is not needed anymore, either when
2483 * another callback replaces @func, the tooltip is unset with
2484 * elm_widget_item_tooltip_unset() or the owner @a item
2485 * dies. This callback receives as the first parameter the
2486 * given @a data, and @c event_info is the item.
2491 _elm_widget_item_tooltip_content_cb_set(Elm_Widget_Item *item,
2492 Elm_Tooltip_Item_Content_Cb func,
2494 Evas_Smart_Cb del_cb)
2496 Elm_Widget_Item_Tooltip *wit;
2498 ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, error_noitem);
2502 _elm_widget_item_tooltip_unset(item);
2506 wit = ELM_NEW(Elm_Widget_Item_Tooltip);
2507 if (!wit) goto error;
2511 wit->del_cb = del_cb;
2513 elm_object_sub_tooltip_content_cb_set
2514 (item->view, item->widget, _elm_widget_item_tooltip_create, wit,
2515 _elm_widget_item_tooltip_del_cb);
2520 if (del_cb) del_cb((void *)data, NULL, item);
2523 if (del_cb) del_cb((void *)data, item->widget, item);
2529 * Unset tooltip from item
2531 * @param item widget item to remove previously set tooltip.
2533 * Remove tooltip from item. The callback provided as del_cb to
2534 * elm_widget_item_tooltip_content_cb_set() will be called to notify
2535 * it is not used anymore.
2537 * @see elm_widget_item_tooltip_content_cb_set()
2542 _elm_widget_item_tooltip_unset(Elm_Widget_Item *item)
2544 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2545 elm_object_tooltip_unset(item->view);
2551 * Sets a different style for this item tooltip.
2553 * @note before you set a style you should define a tooltip with
2554 * elm_widget_item_tooltip_content_cb_set() or
2555 * elm_widget_item_tooltip_text_set()
2557 * @param item widget item with tooltip already set.
2558 * @param style the theme style to use (default, transparent, ...)
2563 _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item,
2566 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2567 elm_object_tooltip_style_set(item->view, style);
2573 * Get the style for this item tooltip.
2575 * @param item widget item with tooltip already set.
2576 * @return style the theme style in use, defaults to "default". If the
2577 * object does not have a tooltip set, then NULL is returned.
2582 _elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item)
2584 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2585 return elm_object_tooltip_style_get(item->view);
2589 _elm_widget_item_cursor_set(Elm_Widget_Item *item,
2592 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2593 elm_object_sub_cursor_set(item->view, item->widget, cursor);
2597 _elm_widget_item_cursor_get(const Elm_Widget_Item *item)
2599 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2600 return elm_object_cursor_get(item->view);
2604 _elm_widget_item_cursor_unset(Elm_Widget_Item *item)
2606 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2607 elm_object_cursor_unset(item->view);
2613 * Sets a different style for this item cursor.
2615 * @note before you set a style you should define a cursor with
2616 * elm_widget_item_cursor_set()
2618 * @param item widget item with cursor already set.
2619 * @param style the theme style to use (default, transparent, ...)
2624 _elm_widget_item_cursor_style_set(Elm_Widget_Item *item,
2627 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2628 elm_object_cursor_style_set(item->view, style);
2634 * Get the style for this item cursor.
2636 * @param item widget item with cursor already set.
2637 * @return style the theme style in use, defaults to "default". If the
2638 * object does not have a cursor set, then NULL is returned.
2643 _elm_widget_item_cursor_style_get(const Elm_Widget_Item *item)
2645 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2646 return elm_object_cursor_style_get(item->view);
2652 * Set if the cursor set should be searched on the theme or should use
2653 * the provided by the engine, only.
2655 * @note before you set if should look on theme you should define a cursor
2656 * with elm_object_cursor_set(). By default it will only look for cursors
2657 * provided by the engine.
2659 * @param item widget item with cursor already set.
2660 * @param engine_only boolean to define it cursors should be looked only
2661 * between the provided by the engine or searched on widget's theme as well.
2666 _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item,
2667 Eina_Bool engine_only)
2669 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2670 elm_object_cursor_engine_only_set(item->view, engine_only);
2676 * Get the cursor engine only usage for this item cursor.
2678 * @param item widget item with cursor already set.
2679 * @return engine_only boolean to define it cursors should be looked only
2680 * between the provided by the engine or searched on widget's theme as well. If
2681 * the object does not have a cursor set, then EINA_FALSE is returned.
2686 _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item)
2688 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, EINA_FALSE);
2689 return elm_object_cursor_engine_only_get(item->view);
2692 // smart object funcs
2694 _smart_reconfigure(Smart_Data *sd)
2698 evas_object_move(sd->resize_obj, sd->x, sd->y);
2699 evas_object_resize(sd->resize_obj, sd->w, sd->h);
2703 evas_object_move(sd->hover_obj, sd->x, sd->y);
2704 evas_object_resize(sd->hover_obj, sd->w, sd->h);
2709 _smart_add(Evas_Object *obj)
2713 sd = calloc(1, sizeof(Smart_Data));
2716 sd->x = sd->y = sd->w = sd->h = 0;
2718 sd->mirrored_auto_mode = EINA_TRUE; /* will follow system locale settings */
2719 evas_object_smart_data_set(obj, sd);
2722 static Evas_Object *
2723 _newest_focus_order_get(Evas_Object *obj,
2724 unsigned int *newest_focus_order,
2725 Eina_Bool can_focus_only)
2728 Evas_Object *child, *ret, *best;
2730 API_ENTRY return NULL;
2731 if (!evas_object_visible_get(obj)) return NULL;
2733 if (*newest_focus_order < sd->focus_order)
2735 *newest_focus_order = sd->focus_order;
2738 EINA_LIST_FOREACH(sd->subobjs, l, child)
2740 ret = _newest_focus_order_get(child, newest_focus_order, can_focus_only);
2746 if ((!best) || (!elm_widget_can_focus_get(best)))
2753 _if_focused_revert(Evas_Object *obj,
2754 Eina_Bool can_focus_only)
2757 Evas_Object *newest = NULL;
2758 unsigned int newest_focus_order = 0;
2762 if (!sd->focused) return;
2763 if (!sd->parent_obj) return;
2765 top = elm_widget_top_get(sd->parent_obj);
2768 newest = _newest_focus_order_get(top, &newest_focus_order, can_focus_only);
2771 elm_object_unfocus(newest);
2772 elm_object_focus(newest);
2778 _smart_del(Evas_Object *obj)
2781 Edje_Signal_Data *esd;
2785 if (sd->del_pre_func) sd->del_pre_func(obj);
2788 sobj = sd->resize_obj;
2789 sd->resize_obj = NULL;
2790 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2791 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2792 evas_object_del(sobj);
2796 sobj = sd->hover_obj;
2797 sd->hover_obj = NULL;
2798 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2799 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2800 evas_object_del(sobj);
2802 EINA_LIST_FREE(sd->subobjs, sobj)
2804 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2805 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2806 evas_object_del(sobj);
2808 eina_list_free(sd->tooltips); /* should be empty anyway */
2809 eina_list_free(sd->cursors); /* should be empty anyway */
2810 EINA_LIST_FREE(sd->edje_signals, esd)
2812 eina_stringshare_del(esd->emission);
2813 eina_stringshare_del(esd->source);
2816 eina_list_free(sd->event_cb); /* should be empty anyway */
2817 if (sd->del_func) sd->del_func(obj);
2818 if (sd->style) eina_stringshare_del(sd->style);
2819 if (sd->type) eina_stringshare_del(sd->type);
2820 if (sd->theme) elm_theme_free(sd->theme);
2821 _if_focused_revert(obj, EINA_TRUE);
2826 _smart_move(Evas_Object *obj,
2833 _smart_reconfigure(sd);
2837 _smart_resize(Evas_Object *obj,
2844 _smart_reconfigure(sd);
2848 _smart_show(Evas_Object *obj)
2853 if ((list = evas_object_smart_members_get(obj)))
2855 EINA_LIST_FREE(list, o)
2857 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2858 evas_object_show(o);
2864 _smart_hide(Evas_Object *obj)
2870 list = evas_object_smart_members_get(obj);
2871 EINA_LIST_FREE(list, o)
2873 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2874 evas_object_hide(o);
2879 _smart_color_set(Evas_Object *obj,
2888 if ((list = evas_object_smart_members_get(obj)))
2890 EINA_LIST_FREE(list, o)
2892 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2893 evas_object_color_set(o, r, g, b, a);
2899 _smart_clip_set(Evas_Object *obj,
2905 if ((list = evas_object_smart_members_get(obj)))
2907 EINA_LIST_FREE(list, o)
2909 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2910 evas_object_clip_set(o, clip);
2916 _smart_clip_unset(Evas_Object *obj)
2921 if ((list = evas_object_smart_members_get(obj)))
2923 EINA_LIST_FREE(list, o)
2925 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2926 evas_object_clip_unset(o);
2932 _smart_calculate(Evas_Object *obj)
2935 if (sd->changed_func) sd->changed_func(obj);
2938 /* never need to touch this */
2942 if (_e_smart) return;
2944 static const Evas_Smart_Class sc =
2947 EVAS_SMART_CLASS_VERSION,
2965 _e_smart = evas_smart_class_new(&sc);
2969 /* happy debug functions */
2972 _sub_obj_tree_dump(const Evas_Object *obj,
2977 for (i = 0; i < lvl * 3; i++)
2980 if (_elm_widget_is(obj))
2984 printf("+ %s(%p)\n",
2988 _sub_obj_tree_dump(sd->resize_obj, lvl + 1);
2989 EINA_LIST_FOREACH(sd->subobjs, l, obj)
2991 if (obj != sd->resize_obj)
2992 _sub_obj_tree_dump(obj, lvl + 1);
2996 printf("+ %s(%p)\n", evas_object_type_get(obj), obj);
3000 _sub_obj_tree_dot_dump(const Evas_Object *obj,
3003 if (!_elm_widget_is(obj))
3007 Eina_Bool visible = evas_object_visible_get(obj);
3008 Eina_Bool disabled = elm_widget_disabled_get(obj);
3009 Eina_Bool focused = elm_widget_focus_get(obj);
3010 Eina_Bool can_focus = elm_widget_can_focus_get(obj);
3014 fprintf(output, "\"%p\" -- \"%p\" [ color=black", sd->parent_obj, obj);
3017 fprintf(output, ", style=bold");
3020 fprintf(output, ", color=gray28");
3022 fprintf(output, " ];\n");
3025 fprintf(output, "\"%p\" [ label = \"{%p|%s|%s|visible: %d|"
3026 "disabled: %d|focused: %d/%d|focus order:%d}\"", obj, obj, sd->type,
3027 evas_object_name_get(obj), visible, disabled, focused, can_focus,
3031 fprintf(output, ", style=bold");
3034 fprintf(output, ", fontcolor=gray28");
3036 if ((disabled) || (!visible))
3037 fprintf(output, ", color=gray");
3039 fprintf(output, " ];\n");
3043 EINA_LIST_FOREACH(sd->subobjs, l, o)
3044 _sub_obj_tree_dot_dump(o, output);
3049 elm_widget_tree_dump(const Evas_Object *top)
3052 _sub_obj_tree_dump(top, 0);
3060 elm_widget_tree_dot_dump(const Evas_Object *top,
3064 if (!_elm_widget_is(top))
3066 fprintf(output, "graph " " { node [shape=record];\n");
3067 _sub_obj_tree_dot_dump(top, output);
3068 fprintf(output, "}\n");