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 (_elm_widget_is(sobj))
869 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
872 sd2->parent_obj = NULL;
873 if (sd2->resize_obj == sobj)
874 sd2->resize_obj = NULL;
876 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
879 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
880 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
881 if ((sd->child_can_focus) && (_is_focusable(sobj)))
885 sd->child_can_focus = EINA_FALSE;
886 EINA_LIST_FOREACH(sd->subobjs, l, subobj)
888 if (_is_focusable(subobj))
890 sd->child_can_focus = EINA_TRUE;
897 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
898 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
900 if (_elm_widget_is(sobj))
901 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
903 evas_object_smart_callback_call(obj, "sub-object-del", sobj);
907 elm_widget_resize_object_set(Evas_Object *obj,
911 // orphan previous resize obj
914 evas_object_clip_unset(sd->resize_obj);
915 evas_object_data_del(sd->resize_obj, "elm-parent");
916 if (_elm_widget_is(sd->resize_obj))
918 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
919 if (sd2) sd2->parent_obj = NULL;
920 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_HIDE,
923 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_DEL,
925 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_MOUSE_DOWN,
926 _sub_obj_mouse_down, sd);
927 evas_object_smart_member_del(sd->resize_obj);
928 if (_elm_widget_is(sd->resize_obj))
930 if (elm_widget_focus_get(sd->resize_obj)) _unfocus_parents(obj);
933 // orphan new resize obj
936 evas_object_data_del(sobj, "elm-parent");
937 if (_elm_widget_is(sobj))
939 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
940 if (sd2) sd2->parent_obj = NULL;
941 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_HIDE,
944 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
946 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_MOUSE_DOWN,
947 _sub_obj_mouse_down, sd);
948 evas_object_smart_member_del(sobj);
949 if (_elm_widget_is(sobj))
951 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
954 // set the resize obj up
955 sd->resize_obj = sobj;
958 if (_elm_widget_is(sd->resize_obj))
960 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
961 if (sd2) sd2->parent_obj = obj;
962 evas_object_event_callback_add(sobj, EVAS_CALLBACK_HIDE,
965 evas_object_clip_set(sobj, evas_object_clip_get(obj));
966 evas_object_smart_member_add(sobj, obj);
967 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
969 evas_object_event_callback_add(sobj, EVAS_CALLBACK_MOUSE_DOWN,
970 _sub_obj_mouse_down, sd);
971 _smart_reconfigure(sd);
972 evas_object_data_set(sobj, "elm-parent", obj);
973 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
974 if (_elm_widget_is(sobj))
976 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
982 elm_widget_hover_object_set(Evas_Object *obj,
988 evas_object_event_callback_del_full(sd->hover_obj, EVAS_CALLBACK_DEL,
991 sd->hover_obj = sobj;
994 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
996 _smart_reconfigure(sd);
1001 elm_widget_can_focus_set(Evas_Object *obj,
1002 Eina_Bool can_focus)
1005 sd->can_focus = can_focus;
1008 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN,
1010 (void *)(long)EVAS_CALLBACK_KEY_DOWN);
1011 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_UP,
1013 (void *)(long)EVAS_CALLBACK_KEY_UP);
1014 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOUSE_WHEEL,
1016 (void *)(long)EVAS_CALLBACK_MOUSE_WHEEL);
1020 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_DOWN,
1022 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_UP,
1024 evas_object_event_callback_del(obj, EVAS_CALLBACK_MOUSE_WHEEL,
1030 elm_widget_can_focus_get(const Evas_Object *obj)
1032 API_ENTRY return EINA_FALSE;
1033 return sd->can_focus;
1037 elm_widget_child_can_focus_get(const Evas_Object *obj)
1039 API_ENTRY return EINA_FALSE;
1040 return sd->child_can_focus;
1044 elm_widget_highlight_ignore_set(Evas_Object *obj,
1048 sd->highlight_ignore = !!ignore;
1052 elm_widget_highlight_ignore_get(const Evas_Object *obj)
1054 API_ENTRY return EINA_FALSE;
1055 return sd->highlight_ignore;
1059 elm_widget_highlight_in_theme_set(Evas_Object *obj,
1060 Eina_Bool highlight)
1063 sd->highlight_in_theme = !!highlight;
1064 /* FIXME: if focused, it should switch from one mode to the other */
1068 elm_widget_highlight_in_theme_get(const Evas_Object *obj)
1070 API_ENTRY return EINA_FALSE;
1071 return sd->highlight_in_theme;
1075 elm_widget_focus_get(const Evas_Object *obj)
1077 API_ENTRY return EINA_FALSE;
1082 elm_widget_focused_object_get(const Evas_Object *obj)
1084 const Evas_Object *subobj;
1086 API_ENTRY return NULL;
1088 if (!sd->focused) return NULL;
1089 EINA_LIST_FOREACH(sd->subobjs, l, subobj)
1091 Evas_Object *fobj = elm_widget_focused_object_get(subobj);
1092 if (fobj) return fobj;
1094 return (Evas_Object *)obj;
1098 elm_widget_top_get(const Evas_Object *obj)
1100 API_ENTRY return NULL;
1101 if (sd->parent_obj) return elm_widget_top_get(sd->parent_obj);
1102 return (Evas_Object *)obj;
1106 elm_widget_is(const Evas_Object *obj)
1108 return _elm_widget_is(obj);
1112 elm_widget_parent_widget_get(const Evas_Object *obj)
1114 Evas_Object *parent;
1116 if (_elm_widget_is(obj))
1118 Smart_Data *sd = evas_object_smart_data_get(obj);
1119 if (!sd) return NULL;
1120 parent = sd->parent_obj;
1124 parent = evas_object_data_get(obj, "elm-parent");
1125 if (!parent) parent = evas_object_smart_parent_get(obj);
1130 Evas_Object *elm_parent;
1131 if (_elm_widget_is(parent)) break;
1132 elm_parent = evas_object_data_get(parent, "elm-parent");
1133 if (elm_parent) parent = elm_parent;
1134 else parent = evas_object_smart_parent_get(parent);
1140 elm_widget_event_callback_add(Evas_Object *obj,
1145 EINA_SAFETY_ON_NULL_RETURN(func);
1146 Elm_Event_Cb_Data *ecb = ELM_NEW(Elm_Event_Cb_Data);
1149 sd->event_cb = eina_list_append(sd->event_cb, ecb);
1153 elm_widget_event_callback_del(Evas_Object *obj,
1157 API_ENTRY return NULL;
1158 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
1160 Elm_Event_Cb_Data *ecd;
1161 EINA_LIST_FOREACH(sd->event_cb, l, ecd)
1162 if ((ecd->func == func) && (ecd->data == data))
1165 sd->event_cb = eina_list_remove_list(sd->event_cb, l);
1166 return (void *)data;
1172 elm_widget_event_propagate(Evas_Object *obj,
1173 Evas_Callback_Type type,
1175 Evas_Event_Flags *event_flags)
1177 API_ENTRY return EINA_FALSE; //TODO reduce.
1178 if (!_elm_widget_is(obj)) return EINA_FALSE;
1179 Evas_Object *parent = obj;
1180 Elm_Event_Cb_Data *ecd;
1181 Eina_List *l, *l_prev;
1184 (!(event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD))))
1186 sd = evas_object_smart_data_get(parent);
1187 if ((!sd) || (!_elm_widget_is(obj)))
1188 return EINA_FALSE; //Not Elm Widget
1190 if (sd->event_func && (sd->event_func(parent, obj, type, event_info)))
1193 EINA_LIST_FOREACH_SAFE(sd->event_cb, l, l_prev, ecd)
1195 if (ecd->func((void *)ecd->data, parent, obj, type, event_info) ||
1196 (event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD)))
1199 parent = sd->parent_obj;
1208 * Set custom focus chain.
1210 * This function i set one new and overwrite any previous custom focus chain
1211 * with the list of objects. The previous list will be deleted and this list
1212 * will be managed. After setted, don't modity it.
1214 * @note On focus cycle, only will be evaluated children of this container.
1216 * @param obj The container widget
1217 * @param objs Chain of objects to pass focus
1221 elm_widget_focus_custom_chain_set(Evas_Object *obj,
1225 if (!sd->focus_next_func)
1228 elm_widget_focus_custom_chain_unset(obj);
1233 EINA_LIST_FOREACH(objs, l, o)
1235 evas_object_event_callback_add(o, EVAS_CALLBACK_DEL,
1236 _elm_object_focus_chain_del_cb, sd);
1239 sd->focus_chain = objs;
1245 * Get custom focus chain
1247 * @param obj The container widget
1250 EAPI const Eina_List *
1251 elm_widget_focus_custom_chain_get(const Evas_Object *obj)
1253 API_ENTRY return NULL;
1254 return (const Eina_List *)sd->focus_chain;
1260 * Unset custom focus chain
1262 * @param obj The container widget
1266 elm_widget_focus_custom_chain_unset(Evas_Object *obj)
1269 Eina_List *l, *l_next;
1272 EINA_LIST_FOREACH_SAFE(sd->focus_chain, l, l_next, o)
1274 evas_object_event_callback_del_full(o, EVAS_CALLBACK_DEL,
1275 _elm_object_focus_chain_del_cb, sd);
1276 sd->focus_chain = eina_list_remove_list(sd->focus_chain, l);
1283 * Append object to custom focus chain.
1285 * @note If relative_child equal to NULL or not in custom chain, the object
1286 * will be added in end.
1288 * @note On focus cycle, only will be evaluated children of this container.
1290 * @param obj The container widget
1291 * @param child The child to be added in custom chain
1292 * @param relative_child The relative object to position the child
1296 elm_widget_focus_custom_chain_append(Evas_Object *obj,
1298 Evas_Object *relative_child)
1301 EINA_SAFETY_ON_NULL_RETURN(child);
1302 if (!sd->focus_next_func)
1305 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1306 _elm_object_focus_chain_del_cb, sd);
1308 if (!relative_child)
1310 sd->focus_chain = eina_list_append(sd->focus_chain, child);
1314 sd->focus_chain = eina_list_append_relative(sd->focus_chain, child, relative_child);
1321 * Prepend object to custom focus chain.
1323 * @note If relative_child equal to NULL or not in custom chain, the object
1324 * will be added in begin.
1326 * @note On focus cycle, only will be evaluated children of this container.
1328 * @param obj The container widget
1329 * @param child The child to be added in custom chain
1330 * @param relative_child The relative object to position the child
1334 elm_widget_focus_custom_chain_prepend(Evas_Object *obj,
1336 Evas_Object *relative_child)
1339 EINA_SAFETY_ON_NULL_RETURN(child);
1340 if (!sd->focus_next_func)
1343 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1344 _elm_object_focus_chain_del_cb, sd);
1346 if (!relative_child)
1348 sd->focus_chain = eina_list_prepend(sd->focus_chain, child);
1352 sd->focus_chain = eina_list_prepend_relative(sd->focus_chain, child, relative_child);
1359 * Give focus to next object in object tree.
1361 * Give focus to next object in focus chain of one object sub-tree.
1362 * If the last object of chain already have focus, the focus will go to the
1363 * first object of chain.
1365 * @param obj The widget root of sub-tree
1366 * @param dir Direction to cycle the focus
1371 elm_widget_focus_cycle(Evas_Object *obj,
1372 Elm_Focus_Direction dir)
1374 Evas_Object *target = NULL;
1375 if (!_elm_widget_is(obj))
1377 elm_widget_focus_next_get(obj, dir, &target);
1379 elm_widget_focus_steal(target);
1385 * Give focus to near object in one direction.
1387 * Give focus to near object in direction of one object.
1388 * If none focusable object in given direction, the focus will not change.
1390 * @param obj The reference widget
1391 * @param x Horizontal component of direction to focus
1392 * @param y Vertical component of direction to focus
1397 elm_widget_focus_direction_go(Evas_Object *obj __UNUSED__,
1407 * Get next object in focus chain of object tree.
1409 * Get next object in focus chain of one object sub-tree.
1410 * Return the next object by reference. If don't have any candidate to receive
1411 * focus before chain end, the first candidate will be returned.
1413 * @param obj The widget root of sub-tree
1414 * @param dir Direction os focus chain
1415 * @param next The next object in focus chain
1416 * @return EINA_TRUE if don't need focus chain restart/loop back
1417 * to use 'next' obj.
1422 elm_widget_focus_next_get(const Evas_Object *obj,
1423 Elm_Focus_Direction dir,
1430 API_ENTRY return EINA_FALSE;
1432 /* Ignore if disabled */
1433 if ((!evas_object_visible_get(obj)) || (elm_widget_disabled_get(obj)))
1437 if (sd->focus_next_func)
1438 return sd->focus_next_func(obj, dir, next);
1440 if (!elm_widget_can_focus_get(obj))
1444 *next = (Evas_Object *)obj;
1445 return !elm_widget_focus_get(obj);
1451 * Get next object in focus chain of object tree in list.
1453 * Get next object in focus chain of one object sub-tree ordered by one list.
1454 * Return the next object by reference. If don't have any candidate to receive
1455 * focus before list end, the first candidate will be returned.
1457 * @param obj The widget root of sub-tree
1458 * @param dir Direction os focus chain
1459 * @param items list with ordered objects
1460 * @param list_data_get function to get the object from one item of list
1461 * @param next The next object in focus chain
1462 * @return EINA_TRUE if don't need focus chain restart/loop back
1463 * to use 'next' obj.
1468 elm_widget_focus_list_next_get(const Evas_Object *obj,
1469 const Eina_List *items,
1470 void *(*list_data_get)(const Eina_List * list),
1471 Elm_Focus_Direction dir,
1474 Eina_List *(*list_next)(const Eina_List * list);
1480 if (!_elm_widget_is(obj))
1487 if (dir == ELM_FOCUS_PREVIOUS)
1489 items = eina_list_last(items);
1490 list_next = eina_list_prev;
1492 else if (dir == ELM_FOCUS_NEXT)
1493 list_next = eina_list_next;
1497 const Eina_List *l = items;
1499 /* Recovery last focused sub item */
1500 if (elm_widget_focus_get(obj))
1501 for (; l; l = list_next(l))
1503 Evas_Object *cur = list_data_get(l);
1504 if (elm_widget_focus_get(cur)) break;
1507 const Eina_List *start = l;
1508 Evas_Object *to_focus = NULL;
1510 /* Interate sub items */
1511 /* Go to end of list */
1512 for (; l; l = list_next(l))
1514 Evas_Object *tmp = NULL;
1515 Evas_Object *cur = list_data_get(l);
1517 if (elm_widget_parent_get(cur) != obj)
1520 /* Try Focus cycle in subitem */
1521 if (elm_widget_focus_next_get(cur, dir, &tmp))
1526 else if ((tmp) && (!to_focus))
1532 /* Get First possible */
1533 for (; l != start; l = list_next(l))
1535 Evas_Object *tmp = NULL;
1536 Evas_Object *cur = list_data_get(l);
1538 if (elm_widget_parent_get(cur) != obj)
1541 /* Try Focus cycle in subitem */
1542 elm_widget_focus_next_get(cur, dir, &tmp);
1555 elm_widget_signal_emit(Evas_Object *obj,
1556 const char *emission,
1560 if (!sd->signal_func) return;
1561 sd->signal_func(obj, emission, source);
1565 _edje_signal_callback(void *data,
1566 Evas_Object *obj __UNUSED__,
1567 const char *emission,
1570 Edje_Signal_Data *esd = data;
1571 esd->func(esd->data, esd->obj, emission, source);
1575 elm_widget_signal_callback_add(Evas_Object *obj,
1576 const char *emission,
1578 Edje_Signal_Cb func,
1581 Edje_Signal_Data *esd;
1583 if (!sd->callback_add_func) return;
1584 EINA_SAFETY_ON_NULL_RETURN(func);
1586 esd = ELM_NEW(Edje_Signal_Data);
1591 esd->emission = eina_stringshare_add(emission);
1592 esd->source = eina_stringshare_add(source);
1594 sd->edje_signals = eina_list_append(sd->edje_signals, esd);
1595 sd->callback_add_func(obj, emission, source, _edje_signal_callback, esd);
1599 elm_widget_signal_callback_del(Evas_Object *obj,
1600 const char *emission,
1602 Edje_Signal_Cb func)
1604 Edje_Signal_Data *esd;
1607 API_ENTRY return NULL;
1608 if (!sd->callback_del_func) return NULL;
1610 EINA_LIST_FOREACH(sd->edje_signals, l, esd)
1612 if ((esd->func == func) && (!strcmp(esd->emission, emission)) &&
1613 (!strcmp(esd->source, source)))
1615 sd->edje_signals = eina_list_remove_list(sd->edje_signals, l);
1616 eina_stringshare_del(esd->emission);
1617 eina_stringshare_del(esd->source);
1623 sd->callback_del_func(obj, emission, source, _edje_signal_callback, esd);
1628 elm_widget_focus_set(Evas_Object *obj,
1635 sd->focus_order = focus_order;
1636 sd->focused = EINA_TRUE;
1637 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1641 sd->focus_func(obj);
1648 if ((_is_focusable(sd->resize_obj)) &&
1649 (!elm_widget_disabled_get(sd->resize_obj)))
1651 elm_widget_focus_set(sd->resize_obj, first);
1657 EINA_LIST_FOREACH(sd->subobjs, l, child)
1659 if ((_is_focusable(child)) &&
1660 (!elm_widget_disabled_get(child)))
1662 elm_widget_focus_set(child, first);
1672 EINA_LIST_REVERSE_FOREACH(sd->subobjs, l, child)
1674 if ((_is_focusable(child)) &&
1675 (!elm_widget_disabled_get(child)))
1677 elm_widget_focus_set(child, first);
1683 if ((_is_focusable(sd->resize_obj)) &&
1684 (!elm_widget_disabled_get(sd->resize_obj)))
1686 elm_widget_focus_set(sd->resize_obj, first);
1694 elm_widget_parent_get(const Evas_Object *obj)
1696 API_ENTRY return NULL;
1697 return sd->parent_obj;
1701 elm_widget_focused_object_clear(Evas_Object *obj)
1704 if (!sd->focused) return;
1705 if (elm_widget_focus_get(sd->resize_obj))
1706 elm_widget_focused_object_clear(sd->resize_obj);
1711 EINA_LIST_FOREACH(sd->subobjs, l, child)
1713 if (elm_widget_focus_get(child))
1715 elm_widget_focused_object_clear(child);
1720 sd->focused = EINA_FALSE;
1721 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1722 if (sd->focus_func) sd->focus_func(obj);
1726 elm_widget_focus_steal(Evas_Object *obj)
1728 Evas_Object *parent, *o;
1731 if (sd->focused) return;
1732 if (sd->disabled) return;
1733 if (!sd->can_focus) return;
1737 o = elm_widget_parent_get(parent);
1739 sd = evas_object_smart_data_get(o);
1740 if (sd->focused) break;
1743 if (!elm_widget_parent_get(parent))
1744 elm_widget_focused_object_clear(parent);
1747 parent = elm_widget_parent_get(parent);
1748 sd = evas_object_smart_data_get(parent);
1749 if ((sd->resize_obj) && (elm_widget_focus_get(sd->resize_obj)))
1750 elm_widget_focused_object_clear(sd->resize_obj);
1755 EINA_LIST_FOREACH(sd->subobjs, l, child)
1757 if (elm_widget_focus_get(child))
1759 elm_widget_focused_object_clear(child);
1770 elm_widget_activate(Evas_Object *obj)
1773 elm_widget_change(obj);
1774 if (sd->activate_func) sd->activate_func(obj);
1778 elm_widget_change(Evas_Object *obj)
1781 elm_widget_change(elm_widget_parent_get(obj));
1782 if (sd->on_change_func) sd->on_change_func(sd->on_change_data, obj);
1786 elm_widget_disabled_set(Evas_Object *obj,
1791 if (sd->disabled == disabled) return;
1792 sd->disabled = disabled;
1795 Evas_Object *o, *parent;
1800 o = elm_widget_parent_get(parent);
1804 if (elm_widget_focus_get(obj))
1805 elm_widget_focus_cycle(parent, ELM_FOCUS_NEXT);
1807 if (sd->disable_func) sd->disable_func(obj);
1811 elm_widget_disabled_get(const Evas_Object *obj)
1814 return sd->disabled;
1818 elm_widget_show_region_set(Evas_Object *obj,
1823 Eina_Bool forceshow)
1825 Evas_Object *parent_obj, *child_obj;
1826 Evas_Coord px, py, cx, cy;
1829 if (!forceshow && (x == sd->rx) && (y == sd->ry)
1830 && (w == sd->rw) && (h == sd->rh)) return;
1835 if (sd->on_show_region_func)
1836 sd->on_show_region_func(sd->on_show_region_data, obj);
1840 parent_obj = sd->parent_obj;
1841 child_obj = sd->obj;
1842 if ((!parent_obj) || (!_elm_widget_is(parent_obj))) break;
1843 sd = evas_object_smart_data_get(parent_obj);
1846 evas_object_geometry_get(parent_obj, &px, &py, NULL, NULL);
1847 evas_object_geometry_get(child_obj, &cx, &cy, NULL, NULL);
1856 if (sd->on_show_region_func)
1858 sd->on_show_region_func(sd->on_show_region_data, parent_obj);
1865 elm_widget_show_region_get(const Evas_Object *obj,
1881 * Get the focus region of the given widget.
1883 * The focus region is the area of a widget that should brought into the
1884 * visible area when the widget is focused. Mostly used to show the part of
1885 * an entry where the cursor is, for example. The area returned is relative
1886 * to the object @p obj.
1887 * If the @p obj doesn't have the proper on_focus_region_hook set, this
1888 * function will return the full size of the object.
1890 * @param obj The widget object
1891 * @param x Where to store the x coordinate of the area
1892 * @param y Where to store the y coordinate of the area
1893 * @param w Where to store the width of the area
1894 * @param h Where to store the height of the area
1899 elm_widget_focus_region_get(const Evas_Object *obj,
1909 sd = evas_object_smart_data_get(obj);
1910 if (!sd || !_elm_widget_is(obj) || !sd->on_focus_region_func)
1912 evas_object_geometry_get(obj, NULL, NULL, w, h);
1917 sd->on_focus_region_func(obj, x, y, w, h);
1921 elm_widget_scroll_hold_push(Evas_Object *obj)
1925 if (sd->scroll_hold == 1)
1926 evas_object_smart_callback_call(obj, "scroll-hold-on", obj);
1927 if (sd->parent_obj) elm_widget_scroll_hold_push(sd->parent_obj);
1928 // FIXME: on delete/reparent hold pop
1932 elm_widget_scroll_hold_pop(Evas_Object *obj)
1936 if (sd->scroll_hold < 0) sd->scroll_hold = 0;
1937 if (!sd->scroll_hold)
1938 evas_object_smart_callback_call(obj, "scroll-hold-off", obj);
1939 if (sd->parent_obj) elm_widget_scroll_hold_pop(sd->parent_obj);
1943 elm_widget_scroll_hold_get(const Evas_Object *obj)
1946 return sd->scroll_hold;
1950 elm_widget_scroll_freeze_push(Evas_Object *obj)
1953 sd->scroll_freeze++;
1954 if (sd->scroll_freeze == 1)
1955 evas_object_smart_callback_call(obj, "scroll-freeze-on", obj);
1956 if (sd->parent_obj) elm_widget_scroll_freeze_push(sd->parent_obj);
1957 // FIXME: on delete/reparent freeze pop
1961 elm_widget_scroll_freeze_pop(Evas_Object *obj)
1964 sd->scroll_freeze--;
1965 if (sd->scroll_freeze < 0) sd->scroll_freeze = 0;
1966 if (!sd->scroll_freeze)
1967 evas_object_smart_callback_call(obj, "scroll-freeze-off", obj);
1968 if (sd->parent_obj) elm_widget_scroll_freeze_pop(sd->parent_obj);
1972 elm_widget_scroll_freeze_get(const Evas_Object *obj)
1975 return sd->scroll_freeze;
1979 elm_widget_scale_set(Evas_Object *obj,
1983 if (scale <= 0.0) scale = 0.0;
1984 if (sd->scale != scale)
1987 elm_widget_theme(obj);
1992 elm_widget_scale_get(const Evas_Object *obj)
1994 API_ENTRY return 1.0;
1995 // FIXME: save walking up the tree by storing/caching parent scale
1996 if (sd->scale == 0.0)
1999 return elm_widget_scale_get(sd->parent_obj);
2007 elm_widget_theme_set(Evas_Object *obj,
2011 if (sd->theme != th)
2013 if (sd->theme) elm_theme_free(sd->theme);
2016 elm_widget_theme(obj);
2021 elm_widget_theme_get(const Evas_Object *obj)
2023 API_ENTRY return NULL;
2027 return elm_widget_theme_get(sd->parent_obj);
2035 elm_widget_style_set(Evas_Object *obj,
2040 if (eina_stringshare_replace(&sd->style, style))
2041 elm_widget_theme(obj);
2045 elm_widget_style_get(const Evas_Object *obj)
2047 API_ENTRY return NULL;
2048 if (sd->style) return sd->style;
2053 elm_widget_type_set(Evas_Object *obj,
2057 eina_stringshare_replace(&sd->type, type);
2061 elm_widget_type_get(const Evas_Object *obj)
2063 API_ENTRY return NULL;
2064 if (sd->type) return sd->type;
2069 elm_widget_tooltip_add(Evas_Object *obj,
2073 sd->tooltips = eina_list_append(sd->tooltips, tt);
2077 elm_widget_tooltip_del(Evas_Object *obj,
2081 sd->tooltips = eina_list_remove(sd->tooltips, tt);
2085 elm_widget_cursor_add(Evas_Object *obj,
2089 sd->cursors = eina_list_append(sd->cursors, cur);
2093 elm_widget_cursor_del(Evas_Object *obj,
2097 sd->cursors = eina_list_remove(sd->cursors, cur);
2101 elm_widget_drag_lock_x_set(Evas_Object *obj,
2105 if (sd->drag_x_locked == lock) return;
2106 sd->drag_x_locked = lock;
2107 if (sd->drag_x_locked) _propagate_x_drag_lock(obj, 1);
2108 else _propagate_x_drag_lock(obj, -1);
2112 elm_widget_drag_lock_y_set(Evas_Object *obj,
2116 if (sd->drag_y_locked == lock) return;
2117 sd->drag_y_locked = lock;
2118 if (sd->drag_y_locked) _propagate_y_drag_lock(obj, 1);
2119 else _propagate_y_drag_lock(obj, -1);
2123 elm_widget_drag_lock_x_get(const Evas_Object *obj)
2125 API_ENTRY return EINA_FALSE;
2126 return sd->drag_x_locked;
2130 elm_widget_drag_lock_y_get(const Evas_Object *obj)
2132 API_ENTRY return EINA_FALSE;
2133 return sd->drag_y_locked;
2137 elm_widget_drag_child_locked_x_get(const Evas_Object *obj)
2140 return sd->child_drag_x_locked;
2144 elm_widget_drag_child_locked_y_get(const Evas_Object *obj)
2147 return sd->child_drag_y_locked;
2151 elm_widget_theme_object_set(Evas_Object *obj,
2154 const char *welement,
2157 API_ENTRY return EINA_FALSE;
2158 return _elm_theme_object_set(obj, edj, wname, welement, wstyle);
2162 elm_widget_type_check(const Evas_Object *obj,
2165 const char *provided, *expected = "(unknown)";
2166 static int abort_on_warn = -1;
2167 provided = elm_widget_type_get(obj);
2168 if (EINA_LIKELY(provided == type)) return EINA_TRUE;
2169 if (type) expected = type;
2170 if ((!provided) || (!provided[0]))
2172 provided = evas_object_type_get(obj);
2173 if ((!provided) || (!provided[0]))
2174 provided = "(unknown)";
2176 ERR("Passing Object: %p, of type: '%s' when expecting type: '%s'", obj, provided, expected);
2177 if (abort_on_warn == -1)
2179 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
2180 else abort_on_warn = 0;
2182 if (abort_on_warn == 1) abort();
2189 * Split string in words
2191 * @param str Source string
2192 * @return List of const words
2194 * @see elm_widget_stringlist_free()
2198 elm_widget_stringlist_get(const char *str)
2200 Eina_List *list = NULL;
2202 if (!str) return NULL;
2203 for (b = s = str; 1; s++)
2205 if ((*s == ' ') || (!*s))
2207 char *t = malloc(s - b + 1);
2210 strncpy(t, b, s - b);
2212 list = eina_list_append(list, eina_stringshare_add(t));
2223 elm_widget_stringlist_free(Eina_List *list)
2226 EINA_LIST_FREE(list, s) eina_stringshare_del(s);
2232 * Allocate a new Elm_Widget_Item-derived structure.
2234 * The goal of this structure is to provide common ground for actions
2235 * that a widget item have, such as the owner widget, callback to
2236 * notify deletion, data pointer and maybe more.
2238 * @param widget the owner widget that holds this item, must be an elm_widget!
2239 * @param alloc_size any number greater than sizeof(Elm_Widget_Item) that will
2240 * be used to allocate memory.
2242 * @return allocated memory that is already zeroed out, or NULL on errors.
2244 * @see elm_widget_item_new() convenience macro.
2245 * @see elm_widget_item_del() to release memory.
2248 EAPI Elm_Widget_Item *
2249 _elm_widget_item_new(Evas_Object *widget,
2252 if (!_elm_widget_is(widget))
2255 Elm_Widget_Item *item;
2257 EINA_SAFETY_ON_TRUE_RETURN_VAL(alloc_size < sizeof(Elm_Widget_Item), NULL);
2258 EINA_SAFETY_ON_TRUE_RETURN_VAL(!_elm_widget_is(widget), NULL);
2260 item = calloc(1, alloc_size);
2261 EINA_SAFETY_ON_NULL_RETURN_VAL(item, NULL);
2263 EINA_MAGIC_SET(item, ELM_WIDGET_ITEM_MAGIC);
2264 item->widget = widget;
2271 * Releases widget item memory, calling back del_cb() if it exists.
2273 * If there is a Elm_Widget_Item::del_cb, then it will be called prior
2274 * to memory release. Note that elm_widget_item_pre_notify_del() calls
2275 * this function and then unset it, thus being useful for 2 step
2276 * cleanup whenever the del_cb may use any of the data that must be
2277 * deleted from item.
2279 * The Elm_Widget_Item::view will be deleted (evas_object_del()) if it
2282 * @param item a valid #Elm_Widget_Item to be deleted.
2283 * @see elm_widget_item_del() convenience macro.
2287 _elm_widget_item_del(Elm_Widget_Item *item)
2289 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2292 item->del_cb((void *)item->data, item->widget, item);
2295 evas_object_del(item->view);
2297 EINA_MAGIC_SET(item, EINA_MAGIC_NONE);
2304 * Notify object will be deleted without actually deleting it.
2306 * This function will callback Elm_Widget_Item::del_cb if it is set
2307 * and then unset it so it is not called twice (ie: from
2308 * elm_widget_item_del()).
2310 * @param item a valid #Elm_Widget_Item to be notified
2311 * @see elm_widget_item_pre_notify_del() convenience macro.
2315 _elm_widget_item_pre_notify_del(Elm_Widget_Item *item)
2317 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2318 if (!item->del_cb) return;
2319 item->del_cb((void *)item->data, item->widget, item);
2320 item->del_cb = NULL;
2326 * Set the function to notify when item is being deleted.
2328 * This function will complain if there was a callback set already,
2329 * however it will set the new one.
2331 * The callback will be called from elm_widget_item_pre_notify_del()
2332 * or elm_widget_item_del() will be called with:
2333 * - data: the Elm_Widget_Item::data value.
2334 * - obj: the Elm_Widget_Item::widget evas object.
2335 * - event_info: the item being deleted.
2337 * @param item a valid #Elm_Widget_Item to be notified
2338 * @see elm_widget_item_del_cb_set() convenience macro.
2342 _elm_widget_item_del_cb_set(Elm_Widget_Item *item,
2343 Evas_Smart_Cb del_cb)
2345 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2347 if ((item->del_cb) && (item->del_cb != del_cb))
2348 WRN("You're replacing a previously set del_cb %p of item %p with %p",
2349 item->del_cb, item, del_cb);
2351 item->del_cb = del_cb;
2357 * Set user-data in this item.
2359 * User data may be used to identify this item or just store any
2360 * application data. It is automatically given as the first parameter
2361 * of the deletion notify callback.
2363 * @param item a valid #Elm_Widget_Item to store data in.
2364 * @param data user data to store.
2365 * @see elm_widget_item_del_cb_set() convenience macro.
2369 _elm_widget_item_data_set(Elm_Widget_Item *item,
2372 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2373 if ((item->data) && (item->data != data))
2374 DBG("Replacing item %p data %p with %p", item, item->data, data);
2381 * Retrieves user-data of this item.
2383 * @param item a valid #Elm_Widget_Item to get data from.
2384 * @see elm_widget_item_data_set()
2388 _elm_widget_item_data_get(const Elm_Widget_Item *item)
2390 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2391 return (void *)item->data;
2394 typedef struct _Elm_Widget_Item_Tooltip Elm_Widget_Item_Tooltip;
2396 struct _Elm_Widget_Item_Tooltip
2398 Elm_Widget_Item *item;
2399 Elm_Tooltip_Item_Content_Cb func;
2400 Evas_Smart_Cb del_cb;
2404 static Evas_Object *
2405 _elm_widget_item_tooltip_label_create(void *data,
2407 void *item __UNUSED__)
2409 Evas_Object *label = elm_label_add(obj);
2412 elm_object_style_set(label, "tooltip");
2413 elm_label_label_set(label, data);
2418 _elm_widget_item_tooltip_label_del_cb(void *data,
2419 Evas_Object *obj __UNUSED__,
2420 void *event_info __UNUSED__)
2422 eina_stringshare_del(data);
2428 * Set the text to be shown in the widget item.
2430 * @param item Target item
2431 * @param text The text to set in the content
2433 * Setup the text as tooltip to object. The item can have only one tooltip,
2434 * so any previous tooltip data is removed.
2439 _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item,
2442 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2443 EINA_SAFETY_ON_NULL_RETURN(text);
2445 text = eina_stringshare_add(text);
2446 _elm_widget_item_tooltip_content_cb_set
2447 (item, _elm_widget_item_tooltip_label_create, text,
2448 _elm_widget_item_tooltip_label_del_cb);
2451 static Evas_Object *
2452 _elm_widget_item_tooltip_create(void *data,
2455 Elm_Widget_Item_Tooltip *wit = data;
2456 return wit->func((void *)wit->data, obj, wit->item);
2460 _elm_widget_item_tooltip_del_cb(void *data,
2462 void *event_info __UNUSED__)
2464 Elm_Widget_Item_Tooltip *wit = data;
2465 if (wit->del_cb) wit->del_cb((void *)wit->data, obj, wit->item);
2472 * Set the content to be shown in the tooltip item
2474 * Setup the tooltip to item. The item can have only one tooltip,
2475 * so any previous tooltip data is removed. @p func(with @p data) will
2476 * be called every time that need show the tooltip and it should
2477 * return a valid Evas_Object. This object is then managed fully by
2478 * tooltip system and is deleted when the tooltip is gone.
2480 * @param item the widget item being attached a tooltip.
2481 * @param func the function used to create the tooltip contents.
2482 * @param data what to provide to @a func as callback data/context.
2483 * @param del_cb called when data is not needed anymore, either when
2484 * another callback replaces @func, the tooltip is unset with
2485 * elm_widget_item_tooltip_unset() or the owner @a item
2486 * dies. This callback receives as the first parameter the
2487 * given @a data, and @c event_info is the item.
2492 _elm_widget_item_tooltip_content_cb_set(Elm_Widget_Item *item,
2493 Elm_Tooltip_Item_Content_Cb func,
2495 Evas_Smart_Cb del_cb)
2497 Elm_Widget_Item_Tooltip *wit;
2499 ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, error_noitem);
2503 _elm_widget_item_tooltip_unset(item);
2507 wit = ELM_NEW(Elm_Widget_Item_Tooltip);
2508 if (!wit) goto error;
2512 wit->del_cb = del_cb;
2514 elm_object_sub_tooltip_content_cb_set
2515 (item->view, item->widget, _elm_widget_item_tooltip_create, wit,
2516 _elm_widget_item_tooltip_del_cb);
2521 if (del_cb) del_cb((void *)data, NULL, item);
2524 if (del_cb) del_cb((void *)data, item->widget, item);
2530 * Unset tooltip from item
2532 * @param item widget item to remove previously set tooltip.
2534 * Remove tooltip from item. The callback provided as del_cb to
2535 * elm_widget_item_tooltip_content_cb_set() will be called to notify
2536 * it is not used anymore.
2538 * @see elm_widget_item_tooltip_content_cb_set()
2543 _elm_widget_item_tooltip_unset(Elm_Widget_Item *item)
2545 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2546 elm_object_tooltip_unset(item->view);
2552 * Sets a different style for this item tooltip.
2554 * @note before you set a style you should define a tooltip with
2555 * elm_widget_item_tooltip_content_cb_set() or
2556 * elm_widget_item_tooltip_text_set()
2558 * @param item widget item with tooltip already set.
2559 * @param style the theme style to use (default, transparent, ...)
2564 _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item,
2567 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2568 elm_object_tooltip_style_set(item->view, style);
2574 * Get the style for this item tooltip.
2576 * @param item widget item with tooltip already set.
2577 * @return style the theme style in use, defaults to "default". If the
2578 * object does not have a tooltip set, then NULL is returned.
2583 _elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item)
2585 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2586 return elm_object_tooltip_style_get(item->view);
2590 _elm_widget_item_cursor_set(Elm_Widget_Item *item,
2593 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2594 elm_object_sub_cursor_set(item->view, item->widget, cursor);
2598 _elm_widget_item_cursor_get(const Elm_Widget_Item *item)
2600 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2601 return elm_object_cursor_get(item->view);
2605 _elm_widget_item_cursor_unset(Elm_Widget_Item *item)
2607 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2608 elm_object_cursor_unset(item->view);
2614 * Sets a different style for this item cursor.
2616 * @note before you set a style you should define a cursor with
2617 * elm_widget_item_cursor_set()
2619 * @param item widget item with cursor already set.
2620 * @param style the theme style to use (default, transparent, ...)
2625 _elm_widget_item_cursor_style_set(Elm_Widget_Item *item,
2628 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2629 elm_object_cursor_style_set(item->view, style);
2635 * Get the style for this item cursor.
2637 * @param item widget item with cursor already set.
2638 * @return style the theme style in use, defaults to "default". If the
2639 * object does not have a cursor set, then NULL is returned.
2644 _elm_widget_item_cursor_style_get(const Elm_Widget_Item *item)
2646 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2647 return elm_object_cursor_style_get(item->view);
2653 * Set if the cursor set should be searched on the theme or should use
2654 * the provided by the engine, only.
2656 * @note before you set if should look on theme you should define a cursor
2657 * with elm_object_cursor_set(). By default it will only look for cursors
2658 * provided by the engine.
2660 * @param item widget item with cursor already set.
2661 * @param engine_only boolean to define it cursors should be looked only
2662 * between the provided by the engine or searched on widget's theme as well.
2667 _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item,
2668 Eina_Bool engine_only)
2670 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2671 elm_object_cursor_engine_only_set(item->view, engine_only);
2677 * Get the cursor engine only usage for this item cursor.
2679 * @param item widget item with cursor already set.
2680 * @return engine_only boolean to define it cursors should be looked only
2681 * between the provided by the engine or searched on widget's theme as well. If
2682 * the object does not have a cursor set, then EINA_FALSE is returned.
2687 _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item)
2689 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, EINA_FALSE);
2690 return elm_object_cursor_engine_only_get(item->view);
2693 // smart object funcs
2695 _smart_reconfigure(Smart_Data *sd)
2699 evas_object_move(sd->resize_obj, sd->x, sd->y);
2700 evas_object_resize(sd->resize_obj, sd->w, sd->h);
2704 evas_object_move(sd->hover_obj, sd->x, sd->y);
2705 evas_object_resize(sd->hover_obj, sd->w, sd->h);
2710 _smart_add(Evas_Object *obj)
2714 sd = calloc(1, sizeof(Smart_Data));
2717 sd->x = sd->y = sd->w = sd->h = 0;
2719 sd->mirrored_auto_mode = EINA_TRUE; /* will follow system locale settings */
2720 evas_object_smart_data_set(obj, sd);
2723 static Evas_Object *
2724 _newest_focus_order_get(Evas_Object *obj,
2725 unsigned int *newest_focus_order,
2726 Eina_Bool can_focus_only)
2729 Evas_Object *child, *ret, *best;
2731 API_ENTRY return NULL;
2732 if (!evas_object_visible_get(obj)) return NULL;
2734 if (*newest_focus_order < sd->focus_order)
2736 *newest_focus_order = sd->focus_order;
2739 EINA_LIST_FOREACH(sd->subobjs, l, child)
2741 ret = _newest_focus_order_get(child, newest_focus_order, can_focus_only);
2747 if ((!best) || (!elm_widget_can_focus_get(best)))
2754 _if_focused_revert(Evas_Object *obj,
2755 Eina_Bool can_focus_only)
2758 Evas_Object *newest = NULL;
2759 unsigned int newest_focus_order = 0;
2763 if (!sd->focused) return;
2764 if (!sd->parent_obj) return;
2766 top = elm_widget_top_get(sd->parent_obj);
2769 newest = _newest_focus_order_get(top, &newest_focus_order, can_focus_only);
2772 elm_object_unfocus(newest);
2773 elm_object_focus(newest);
2779 _smart_del(Evas_Object *obj)
2782 Edje_Signal_Data *esd;
2786 if (sd->del_pre_func) sd->del_pre_func(obj);
2789 sobj = sd->resize_obj;
2790 sd->resize_obj = NULL;
2791 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2792 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2793 evas_object_del(sobj);
2797 sobj = sd->hover_obj;
2798 sd->hover_obj = NULL;
2799 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2800 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2801 evas_object_del(sobj);
2803 EINA_LIST_FREE(sd->subobjs, sobj)
2805 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2806 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2807 evas_object_del(sobj);
2809 eina_list_free(sd->tooltips); /* should be empty anyway */
2810 eina_list_free(sd->cursors); /* should be empty anyway */
2811 EINA_LIST_FREE(sd->edje_signals, esd)
2813 eina_stringshare_del(esd->emission);
2814 eina_stringshare_del(esd->source);
2817 eina_list_free(sd->event_cb); /* should be empty anyway */
2818 if (sd->del_func) sd->del_func(obj);
2819 if (sd->style) eina_stringshare_del(sd->style);
2820 if (sd->type) eina_stringshare_del(sd->type);
2821 if (sd->theme) elm_theme_free(sd->theme);
2822 _if_focused_revert(obj, EINA_TRUE);
2827 _smart_move(Evas_Object *obj,
2834 _smart_reconfigure(sd);
2838 _smart_resize(Evas_Object *obj,
2845 _smart_reconfigure(sd);
2849 _smart_show(Evas_Object *obj)
2854 if ((list = evas_object_smart_members_get(obj)))
2856 EINA_LIST_FREE(list, o)
2858 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2859 evas_object_show(o);
2865 _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");