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, Evas_Object *source, Evas_Callback_Type type, void *event_info);
34 void (*signal_func) (Evas_Object *obj, const char *emission,
36 void (*callback_add_func) (Evas_Object *obj, const char *emission,
37 const char *source, void (*func) (void *data,
38 Evas_Object *o, const char *emission,
39 const char *source), void *data);
40 void (*callback_del_func) (Evas_Object *obj, const char *emission,
41 const char *source, void (*func) (void *data,
42 Evas_Object *o, const char *emission,
43 const char *source), void *data);
44 void (*changed_func) (Evas_Object *obj);
45 Eina_Bool (*focus_next_func) (const Evas_Object *obj, Elm_Focus_Direction dir,
47 void (*on_focus_func) (void *data, Evas_Object *obj);
49 void (*on_change_func) (void *data, Evas_Object *obj);
51 void (*on_show_region_func) (void *data, Evas_Object *obj);
52 void *on_show_region_data;
53 void (*focus_region_func) (Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h);
54 void (*on_focus_region_func) (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
56 Evas_Coord rx, ry, rw, rh;
62 unsigned int focus_order;
63 Eina_Bool focus_order_on_calc;
65 int child_drag_x_locked;
66 int child_drag_y_locked;
68 Eina_List *edje_signals;
70 Eina_Bool drag_x_locked : 1;
71 Eina_Bool drag_y_locked : 1;
73 Eina_Bool can_focus : 1;
74 Eina_Bool child_can_focus : 1;
75 Eina_Bool focused : 1;
76 Eina_Bool highlight_ignore : 1;
77 Eina_Bool highlight_in_theme : 1;
78 Eina_Bool disabled : 1;
79 Eina_Bool is_mirrored : 1;
80 Eina_Bool mirrored_auto_mode : 1; /* This is TRUE by default */
82 Eina_List *focus_chain;
86 struct _Edje_Signal_Data
95 struct _Elm_Event_Cb_Data {
100 /* local subsystem functions */
101 static void _smart_reconfigure(Smart_Data *sd);
102 static void _smart_add(Evas_Object *obj);
103 static void _smart_del(Evas_Object *obj);
104 static void _smart_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
105 static void _smart_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
106 static void _smart_show(Evas_Object *obj);
107 static void _smart_hide(Evas_Object *obj);
108 static void _smart_color_set(Evas_Object *obj, int r, int g, int b, int a);
109 static void _smart_clip_set(Evas_Object *obj, Evas_Object * clip);
110 static void _smart_clip_unset(Evas_Object *obj);
111 static void _smart_calculate(Evas_Object *obj);
112 static void _smart_init(void);
114 static void _if_focused_revert(Evas_Object *obj, Eina_Bool can_focus_only);
115 static Evas_Object *_newest_focus_order_get(Evas_Object *obj, unsigned int *newest_focus_order, Eina_Bool can_focus_only);
117 /* local subsystem globals */
118 static Evas_Smart *_e_smart = NULL;
119 static Eina_List *widtypes = NULL;
121 static unsigned int focus_order = 0;
124 static inline Eina_Bool
125 _elm_widget_is(const Evas_Object *obj)
127 const char *type = evas_object_type_get(obj);
128 return type == SMART_NAME;
131 static inline Eina_Bool
132 _is_focusable(Evas_Object *obj)
134 API_ENTRY return EINA_FALSE;
135 return sd->can_focus || (sd->child_can_focus);
139 _unfocus_parents(Evas_Object *obj)
141 for (; obj; obj = elm_widget_parent_get(obj))
143 Smart_Data *sd = evas_object_smart_data_get(obj);
145 if (!sd->focused) return;
151 _focus_parents(Evas_Object *obj)
153 for (; obj; obj = elm_widget_parent_get(obj))
155 Smart_Data *sd = evas_object_smart_data_get(obj);
157 if (sd->focused) return;
163 _sub_obj_del(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
165 Smart_Data *sd = data;
167 if (_elm_widget_is(obj))
169 if (elm_widget_focus_get(obj)) _unfocus_parents(sd->obj);
171 if (obj == sd->resize_obj)
172 sd->resize_obj = NULL;
173 else if (obj == sd->hover_obj)
174 sd->hover_obj = NULL;
176 sd->subobjs = eina_list_remove(sd->subobjs, obj);
177 evas_object_smart_callback_call(sd->obj, "sub-object-del", obj);
181 _sub_obj_mouse_down(void *data __UNUSED__, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
183 Evas_Object *o = obj;
186 if (_elm_widget_is(o)) break;
187 o = evas_object_smart_parent_get(o);
191 if (!_is_focusable(o)) return;
192 elm_widget_focus_steal(o);
196 _propagate_x_drag_lock(Evas_Object *obj, int dir)
198 Smart_Data *sd = evas_object_smart_data_get(obj);
201 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
204 sd2->child_drag_x_locked += dir;
205 _propagate_x_drag_lock(sd->parent_obj, dir);
211 _propagate_y_drag_lock(Evas_Object *obj, int dir)
213 Smart_Data *sd = evas_object_smart_data_get(obj);
216 Smart_Data *sd2 = evas_object_smart_data_get(sd->parent_obj);
219 sd2->child_drag_y_locked += dir;
220 _propagate_y_drag_lock(sd->parent_obj, dir);
226 _propagate_event(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info)
229 Evas_Callback_Type type = (Evas_Callback_Type)(long) data;
230 Evas_Event_Flags *event_flags = NULL;
234 case EVAS_CALLBACK_KEY_DOWN:
236 Evas_Event_Key_Down *ev = event_info;
237 event_flags = &(ev->event_flags);
240 case EVAS_CALLBACK_KEY_UP:
242 Evas_Event_Key_Up *ev = event_info;
243 event_flags = &(ev->event_flags);
246 case EVAS_CALLBACK_MOUSE_WHEEL:
248 Evas_Event_Mouse_Wheel *ev = event_info;
249 event_flags = &(ev->event_flags);
256 elm_widget_event_propagate(obj, type, event_info, event_flags);
260 _parent_focus(Evas_Object *obj)
264 Evas_Object *o = elm_widget_parent_get(obj);
265 sd->focus_order_on_calc = EINA_TRUE;
267 if (sd->focused) return;
273 ret = _newest_focus_order_get(o, &i, EINA_TRUE);
275 /* we don't want to bump a common widget ancestor's
276 focus_order *twice* while parent focusing */
277 if (!ret || (!i) || (i != focus_order))
281 if (!sd->focus_order_on_calc)
282 return; /* we don't want to override it if by means of any of the
283 callbacks below one gets to calculate our order
287 sd->focus_order = focus_order;
288 sd->focused = EINA_TRUE;
289 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
290 if (sd->focus_func) sd->focus_func(obj);
292 _elm_widget_focus_region_show(obj);
294 sd->focus_order_on_calc = EINA_FALSE;
298 _elm_object_focus_chain_del_cb(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
300 Smart_Data *sd = data;
302 sd->focus_chain = eina_list_remove(sd->focus_chain, obj);
305 // exposed util funcs to elm
307 _elm_widget_type_clear(void)
311 EINA_LIST_FREE(widtypes, ptr)
313 eina_stringshare_del(*ptr);
319 _elm_widget_focus_region_show(const Evas_Object *obj)
321 Evas_Coord x, y, w, h, ox, oy;
327 o = elm_widget_parent_get(obj);
330 elm_widget_focus_region_get(obj, &x, &y, &w, &h);
331 evas_object_geometry_get(obj, &ox, &oy, NULL, NULL);
335 sd2 = evas_object_smart_data_get(o);
336 if (sd2->focus_region_func)
338 sd2->focus_region_func(o, x, y, w, h);
339 elm_widget_focus_region_get(o, &x, &y, &w, &h);
343 evas_object_geometry_get(o, &px, &py, NULL, NULL);
349 o = elm_widget_parent_get(o);
354 * @defgroup Widget Widget
357 * Exposed api for making widgets
360 elm_widget_type_register(const char **ptr)
362 widtypes = eina_list_append(widtypes, (void *)ptr);
366 elm_widget_api_check(int ver)
368 if (ver != ELM_INTERNAL_API_VERSION)
370 CRITICAL("Elementary widget api versions do not match");
377 elm_widget_add(Evas *evas)
381 obj = evas_object_smart_add(evas, _e_smart);
382 elm_widget_mirrored_set(obj, elm_mirrored_get());
387 elm_widget_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
394 elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
397 sd->del_pre_func = func;
401 elm_widget_focus_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
404 sd->focus_func = func;
408 elm_widget_activate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
411 sd->activate_func = func;
415 elm_widget_disable_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
418 sd->disable_func = func;
422 elm_widget_theme_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
425 sd->theme_func = func;
429 elm_widget_event_hook_set(Evas_Object *obj, Eina_Bool (*func) (Evas_Object *obj, Evas_Object *source, Evas_Callback_Type type, void *event_info))
432 sd->event_func = func;
436 elm_widget_changed_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj))
439 sd->changed_func = func;
443 elm_widget_signal_emit_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source))
446 sd->signal_func = func;
450 elm_widget_signal_callback_add_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source, void (*func_cb) (void *data, Evas_Object *o, const char *emission, const char *source), void *data))
453 sd->callback_add_func = func;
457 elm_widget_signal_callback_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source, void (*func_cb) (void *data, Evas_Object *o, const char *emission, const char *source), void *data))
460 sd->callback_del_func = func;
464 elm_widget_theme(Evas_Object *obj)
472 EINA_LIST_FOREACH(sd->subobjs, l, child) elm_widget_theme(child);
473 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
474 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
475 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
476 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
477 if (sd->theme_func) sd->theme_func(obj);
481 elm_widget_theme_specific(Evas_Object *obj, Elm_Theme *th, Eina_Bool force)
487 Elm_Theme *th2, *thdef;
490 thdef = elm_theme_default_get();
495 if (!th2) th2 = thdef;
503 if (th2 == thdef) break;
504 th2 = th2->ref_theme;
505 if (!th2) th2 = thdef;
509 EINA_LIST_FOREACH(sd->subobjs, l, child)
510 elm_widget_theme_specific(child, th, force);
511 if (sd->resize_obj) elm_widget_theme(sd->resize_obj);
512 if (sd->hover_obj) elm_widget_theme(sd->hover_obj);
513 EINA_LIST_FOREACH(sd->tooltips, l, tt) elm_tooltip_theme(tt);
514 EINA_LIST_FOREACH(sd->cursors, l, cur) elm_cursor_theme(cur);
515 if (sd->theme_func) sd->theme_func(obj);
521 * Set hook to get next object in object focus chain.
523 * @param obj The widget object.
524 * @param func The hook to be used with this widget.
529 elm_widget_focus_next_hook_set(Evas_Object *obj, Eina_Bool (*func) (const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next))
532 sd->focus_next_func = func;
536 * Returns the widget's mirrored mode.
538 * @param obj The widget.
539 * @return mirrored mode of the object.
543 elm_widget_mirrored_get(const Evas_Object *obj)
545 API_ENTRY return EINA_FALSE;
546 return sd->is_mirrored;
550 * Sets the widget's mirrored mode.
552 * @param obj The widget.
553 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
556 elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored)
559 if (sd->is_mirrored != mirrored)
561 sd->is_mirrored = mirrored;
562 elm_widget_theme(obj);
568 * Resets the mirrored mode from the system mirror mode for widgets that are in
569 * automatic mirroring mode. This function does not call elm_widget_theme.
571 * @param obj The widget.
572 * @param mirrored EINA_TRUE to set mirrored mode. EINA_FALSE to unset.
575 _elm_widget_mirrored_reload(Evas_Object *obj)
578 Eina_Bool mirrored = elm_mirrored_get();
579 if (elm_widget_mirrored_automatic_get(obj) && (sd->is_mirrored != mirrored))
581 sd->is_mirrored = mirrored;
586 * Returns the widget's mirrored mode setting.
588 * @param obj The widget.
589 * @return mirrored mode setting of the object.
593 elm_widget_mirrored_automatic_get(const Evas_Object *obj)
595 API_ENTRY return EINA_FALSE;
596 return sd->mirrored_auto_mode;
600 * Sets the widget's mirrored mode setting.
601 * When widget in automatic mode, it follows the system mirrored mode set by
602 * elm_mirrored_set().
603 * @param obj The widget.
604 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
607 elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic)
610 if (sd->mirrored_auto_mode != automatic)
612 sd->mirrored_auto_mode = automatic;
616 elm_widget_mirrored_set(obj, elm_mirrored_get());
622 elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data)
625 sd->on_focus_func = func;
626 sd->on_focus_data = data;
630 elm_widget_on_change_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data)
633 sd->on_change_func = func;
634 sd->on_change_data = data;
638 elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data)
641 sd->on_show_region_func = func;
642 sd->on_show_region_data = data;
648 * Set the hook to use to show the focused region.
650 * Whenever a new widget gets focused or it's needed to show the focused
651 * area of the current one, this hook will be called on objects that may
652 * want to move their children into their visible area.
653 * The area given in the hook function is relative to the @p obj widget.
655 * @param obj The widget object
656 * @param func The function to call to show the specified area.
661 elm_widget_focus_region_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h))
664 sd->focus_region_func = func;
670 * Set the hook to retrieve the focused region of a widget.
672 * This hook will be called by elm_widget_focus_region_get() whenever
673 * it's needed to get the focused area of a widget. The area must be relative
674 * to the widget itself and if no hook is set, it will default to the entire
677 * @param obj The widget object
678 * @param func The function used to retrieve the focus region.
683 elm_widget_on_focus_region_hook_set(Evas_Object *obj, void (*func) (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h))
686 sd->on_focus_region_func = func;
690 elm_widget_data_set(Evas_Object *obj, void *data)
697 elm_widget_data_get(const Evas_Object *obj)
699 API_ENTRY return NULL;
704 elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj)
707 double scale, pscale = elm_widget_scale_get(sobj);
708 Elm_Theme *th, *pth = elm_widget_theme_get(sobj);
709 Eina_Bool mirrored, pmirrored = elm_widget_mirrored_get(obj);
711 if (_elm_widget_is(sobj))
713 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
716 if (sd2->parent_obj == obj)
718 elm_widget_sub_object_del(sd2->parent_obj, sobj);
719 sd2->parent_obj = obj;
720 if (!sd->child_can_focus && (_is_focusable(sobj)))
721 sd->child_can_focus = EINA_TRUE;
726 void *data = evas_object_data_get(sobj, "elm-parent");
729 if (data == obj) return;
730 evas_object_event_callback_del(sobj, EVAS_CALLBACK_DEL,
735 sd->subobjs = eina_list_append(sd->subobjs, sobj);
736 evas_object_data_set(sobj, "elm-parent", obj);
737 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
738 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
739 scale = elm_widget_scale_get(sobj);
740 th = elm_widget_theme_get(sobj);
741 mirrored = elm_widget_mirrored_get(sobj);
742 if ((scale != pscale) || (th != pth) || (pmirrored != mirrored)) elm_widget_theme(sobj);
743 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
747 elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj)
749 Evas_Object *sobj_parent;
753 sobj_parent = evas_object_data_del(sobj, "elm-parent");
754 if (sobj_parent != obj)
756 static int abort_on_warn = -1;
757 ERR("removing sub object %p from parent %p, "
758 "but elm-parent is different %p!",
759 sobj, obj, sobj_parent);
760 if (EINA_UNLIKELY(abort_on_warn == -1))
762 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
763 else abort_on_warn = 0;
765 if (abort_on_warn == 1) abort();
767 if (!sd->child_can_focus)
769 if (_is_focusable(sobj)) sd->child_can_focus = 0;
771 if (_elm_widget_is(sobj))
773 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
776 sd2->parent_obj = NULL;
777 if (sd2->resize_obj == sobj)
778 sd2->resize_obj = NULL;
780 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
783 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
784 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
787 sd->subobjs = eina_list_remove(sd->subobjs, sobj);
788 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
790 evas_object_smart_callback_call(obj, "sub-object-del", sobj);
794 elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj)
797 // orphan previous resize obj
800 evas_object_clip_unset(sd->resize_obj);
801 evas_object_data_del(sd->resize_obj, "elm-parent");
802 if (_elm_widget_is(sd->resize_obj))
804 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
805 if (sd2) sd2->parent_obj = NULL;
807 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_DEL,
809 evas_object_event_callback_del_full(sd->resize_obj, EVAS_CALLBACK_MOUSE_DOWN,
810 _sub_obj_mouse_down, sd);
811 evas_object_smart_member_del(sd->resize_obj);
812 if (_elm_widget_is(sd->resize_obj))
814 if (elm_widget_focus_get(sd->resize_obj)) _unfocus_parents(obj);
817 // orphan new resize obj
820 evas_object_data_del(sobj, "elm-parent");
821 if (_elm_widget_is(sobj))
823 Smart_Data *sd2 = evas_object_smart_data_get(sobj);
824 if (sd2) sd2->parent_obj = NULL;
826 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL,
828 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_MOUSE_DOWN,
829 _sub_obj_mouse_down, sd);
830 evas_object_smart_member_del(sobj);
831 if (_elm_widget_is(sobj))
833 if (elm_widget_focus_get(sobj)) _unfocus_parents(obj);
836 // set the resize obj up
837 sd->resize_obj = sobj;
840 if (_elm_widget_is(sd->resize_obj))
842 Smart_Data *sd2 = evas_object_smart_data_get(sd->resize_obj);
843 if (sd2) sd2->parent_obj = obj;
845 evas_object_clip_set(sobj, evas_object_clip_get(obj));
846 evas_object_smart_member_add(sobj, obj);
847 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
849 evas_object_event_callback_add(sobj, EVAS_CALLBACK_MOUSE_DOWN,
850 _sub_obj_mouse_down, sd);
851 _smart_reconfigure(sd);
852 evas_object_data_set(sobj, "elm-parent", obj);
853 evas_object_smart_callback_call(obj, "sub-object-add", sobj);
854 if (_elm_widget_is(sobj))
856 if (elm_widget_focus_get(sobj)) _focus_parents(obj);
862 elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj)
867 evas_object_event_callback_del_full(sd->hover_obj, EVAS_CALLBACK_DEL,
870 sd->hover_obj = sobj;
873 evas_object_event_callback_add(sobj, EVAS_CALLBACK_DEL,
875 _smart_reconfigure(sd);
880 elm_widget_can_focus_set(Evas_Object *obj, Eina_Bool can_focus)
883 sd->can_focus = can_focus;
886 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN,
888 (void *)(long) EVAS_CALLBACK_KEY_DOWN);
889 evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_UP,
891 (void *)(long) EVAS_CALLBACK_KEY_UP);
892 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOUSE_WHEEL,
894 (void *)(long)EVAS_CALLBACK_MOUSE_WHEEL);
898 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_DOWN,
900 evas_object_event_callback_del(obj, EVAS_CALLBACK_KEY_UP,
902 evas_object_event_callback_del(obj, EVAS_CALLBACK_MOUSE_WHEEL,
908 elm_widget_can_focus_get(const Evas_Object *obj)
910 API_ENTRY return EINA_FALSE;
911 return sd->can_focus;
915 elm_widget_child_can_focus_get(const Evas_Object *obj)
917 API_ENTRY return EINA_FALSE;
918 return sd->child_can_focus;
922 elm_widget_highlight_ignore_set(Evas_Object *obj, Eina_Bool ignore)
925 sd->highlight_ignore = !!ignore;
929 elm_widget_highlight_ignore_get(const Evas_Object *obj)
931 API_ENTRY return EINA_FALSE;
932 return sd->highlight_ignore;
936 elm_widget_highlight_in_theme_set(Evas_Object *obj, Eina_Bool highlight)
939 sd->highlight_in_theme = !!highlight;
940 /* FIXME: if focused, it should switch from one mode to the other */
944 elm_widget_highlight_in_theme_get(const Evas_Object *obj)
946 API_ENTRY return EINA_FALSE;
947 return sd->highlight_in_theme;
951 elm_widget_focus_get(const Evas_Object *obj)
953 API_ENTRY return EINA_FALSE;
958 elm_widget_focused_object_get(const Evas_Object *obj)
960 const Evas_Object *subobj;
962 API_ENTRY return NULL;
964 if (!sd->focused) return NULL;
965 EINA_LIST_FOREACH(sd->subobjs, l, subobj)
967 Evas_Object *fobj = elm_widget_focused_object_get(subobj);
968 if (fobj) return fobj;
970 return (Evas_Object *)obj;
974 elm_widget_top_get(const Evas_Object *obj)
976 API_ENTRY return NULL;
977 if (sd->parent_obj) return elm_widget_top_get(sd->parent_obj);
978 return (Evas_Object *)obj;
982 elm_widget_is(const Evas_Object *obj)
984 return _elm_widget_is(obj);
988 elm_widget_parent_widget_get(const Evas_Object *obj)
992 if (_elm_widget_is(obj))
994 Smart_Data *sd = evas_object_smart_data_get(obj);
995 if (!sd) return NULL;
996 parent = sd->parent_obj;
1000 parent = evas_object_data_get(obj, "elm-parent");
1001 if (!parent) parent = evas_object_smart_parent_get(obj);
1006 Evas_Object *elm_parent;
1007 if (_elm_widget_is(parent)) break;
1008 elm_parent = evas_object_data_get(parent, "elm-parent");
1009 if (elm_parent) parent = elm_parent;
1010 else parent = evas_object_smart_parent_get(parent);
1016 elm_widget_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data)
1019 EINA_SAFETY_ON_NULL_RETURN(func);
1020 Elm_Event_Cb_Data *ecb = ELM_NEW(Elm_Event_Cb_Data);
1023 sd->event_cb = eina_list_append(sd->event_cb, ecb);
1027 elm_widget_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data)
1029 API_ENTRY return NULL;
1030 EINA_SAFETY_ON_NULL_RETURN_VAL(func, NULL);
1032 Elm_Event_Cb_Data *ecd;
1033 EINA_LIST_FOREACH(sd->event_cb, l, ecd)
1034 if ((ecd->func == func) && (ecd->data == data))
1037 sd->event_cb = eina_list_remove_list(sd->event_cb, l);
1038 return (void *)data;
1044 elm_widget_event_propagate(Evas_Object *obj, Evas_Callback_Type type, void *event_info, Evas_Event_Flags *event_flags)
1046 API_ENTRY return EINA_FALSE; //TODO reduce.
1047 if (!_elm_widget_is(obj)) return EINA_FALSE;
1048 Evas_Object *parent = obj;
1049 Elm_Event_Cb_Data *ecd;
1050 Eina_List *l, *l_prev;
1053 (!(event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD))))
1055 sd = evas_object_smart_data_get(parent);
1056 if ((!sd) || (!_elm_widget_is(obj)))
1057 return EINA_FALSE; //Not Elm Widget
1059 if (sd->event_func && (sd->event_func(parent, obj, type, event_info)))
1062 EINA_LIST_FOREACH_SAFE(sd->event_cb, l, l_prev, ecd)
1064 if (ecd->func((void *)ecd->data, parent, obj, type, event_info) ||
1065 (event_flags && ((*event_flags) & EVAS_EVENT_FLAG_ON_HOLD)))
1068 parent = sd->parent_obj;
1077 * Set custom focus chain.
1079 * This function i set one new and overwrite any previous custom focus chain
1080 * with the list of objects. The previous list will be deleted and this list
1081 * will be managed. After setted, don't modity it.
1083 * @note On focus cycle, only will be evaluated children of this container.
1085 * @param obj The container widget
1086 * @param objs Chain of objects to pass focus
1090 elm_widget_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs)
1093 if (!sd->focus_next_func)
1096 elm_widget_focus_custom_chain_unset(obj);
1101 EINA_LIST_FOREACH(objs, l, o)
1103 evas_object_event_callback_add(o, EVAS_CALLBACK_DEL,
1104 _elm_object_focus_chain_del_cb, sd);
1107 sd->focus_chain = objs;
1113 * Get custom focus chain
1115 * @param obj The container widget
1118 EAPI const Eina_List *
1119 elm_widget_focus_custom_chain_get(const Evas_Object *obj)
1121 API_ENTRY return NULL;
1122 return (const Eina_List *) sd->focus_chain;
1128 * Unset custom focus chain
1130 * @param obj The container widget
1134 elm_widget_focus_custom_chain_unset(Evas_Object *obj)
1137 Eina_List *l, *l_next;
1140 EINA_LIST_FOREACH_SAFE(sd->focus_chain, l, l_next, o)
1142 evas_object_event_callback_del_full(o, EVAS_CALLBACK_DEL,
1143 _elm_object_focus_chain_del_cb, sd);
1144 sd->focus_chain = eina_list_remove_list(sd->focus_chain, l);
1151 * Append object to custom focus chain.
1153 * @note If relative_child equal to NULL or not in custom chain, the object
1154 * will be added in end.
1156 * @note On focus cycle, only will be evaluated children of this container.
1158 * @param obj The container widget
1159 * @param child The child to be added in custom chain
1160 * @param relative_child The relative object to position the child
1164 elm_widget_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child)
1167 EINA_SAFETY_ON_NULL_RETURN(child);
1168 if (!sd->focus_next_func)
1171 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1172 _elm_object_focus_chain_del_cb, sd);
1174 if (!relative_child)
1176 sd->focus_chain = eina_list_append(sd->focus_chain, child);
1180 sd->focus_chain = eina_list_append_relative(sd->focus_chain, child, relative_child);
1187 * Prepend object to custom focus chain.
1189 * @note If relative_child equal to NULL or not in custom chain, the object
1190 * will be added in begin.
1192 * @note On focus cycle, only will be evaluated children of this container.
1194 * @param obj The container widget
1195 * @param child The child to be added in custom chain
1196 * @param relative_child The relative object to position the child
1200 elm_widget_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child)
1203 EINA_SAFETY_ON_NULL_RETURN(child);
1204 if (!sd->focus_next_func)
1207 evas_object_event_callback_del_full(child, EVAS_CALLBACK_DEL,
1208 _elm_object_focus_chain_del_cb, sd);
1210 if (!relative_child)
1212 sd->focus_chain = eina_list_prepend(sd->focus_chain, child);
1216 sd->focus_chain = eina_list_prepend_relative(sd->focus_chain, child, relative_child);
1223 * Give focus to next object in object tree.
1225 * Give focus to next object in focus chain of one object sub-tree.
1226 * If the last object of chain already have focus, the focus will go to the
1227 * first object of chain.
1229 * @param obj The widget root of sub-tree
1230 * @param dir Direction to cycle the focus
1235 elm_widget_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir)
1237 Evas_Object *target = NULL;
1238 if (!_elm_widget_is(obj))
1240 elm_widget_focus_next_get(obj, dir, &target);
1242 elm_widget_focus_steal(target);
1248 * Give focus to near object in one direction.
1250 * Give focus to near object in direction of one object.
1251 * If none focusable object in given direction, the focus will not change.
1253 * @param obj The reference widget
1254 * @param x Horizontal component of direction to focus
1255 * @param y Vertical component of direction to focus
1260 elm_widget_focus_direction_go(Evas_Object *obj __UNUSED__, int x __UNUSED__, int y __UNUSED__)
1268 * Get next object in focus chain of object tree.
1270 * Get next object in focus chain of one object sub-tree.
1271 * Return the next object by reference. If don't have any candidate to receive
1272 * focus before chain end, the first candidate will be returned.
1274 * @param obj The widget root of sub-tree
1275 * @param dir Direction os focus chain
1276 * @param next The next object in focus chain
1277 * @return EINA_TRUE if don't need focus chain restart/loop back
1278 * to use 'next' obj.
1283 elm_widget_focus_next_get(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
1289 API_ENTRY return EINA_FALSE;
1291 /* Ignore if disabled */
1292 if ((!evas_object_visible_get(obj)) || (elm_widget_disabled_get(obj)))
1296 if (sd->focus_next_func)
1297 return sd->focus_next_func(obj, dir, next);
1299 if (!elm_widget_can_focus_get(obj))
1303 *next = (Evas_Object *)obj;
1304 return !elm_widget_focus_get(obj);
1311 * Get next object in focus chain of object tree in list.
1313 * Get next object in focus chain of one object sub-tree ordered by one list.
1314 * Return the next object by reference. If don't have any candidate to receive
1315 * focus before list end, the first candidate will be returned.
1317 * @param obj The widget root of sub-tree
1318 * @param dir Direction os focus chain
1319 * @param items list with ordered objects
1320 * @param list_data_get function to get the object from one item of list
1321 * @param next The next object in focus chain
1322 * @return EINA_TRUE if don't need focus chain restart/loop back
1323 * to use 'next' obj.
1328 elm_widget_focus_list_next_get(const Evas_Object *obj, const Eina_List *items, void *(*list_data_get) (const Eina_List *list), Elm_Focus_Direction dir, Evas_Object **next)
1330 Eina_List *(*list_next) (const Eina_List *list);
1336 if (!_elm_widget_is(obj))
1343 if (dir == ELM_FOCUS_PREVIOUS)
1345 items = eina_list_last(items);
1346 list_next = eina_list_prev;
1348 else if (dir == ELM_FOCUS_NEXT)
1349 list_next = eina_list_next;
1353 const Eina_List *l = items;
1355 /* Recovery last focused sub item */
1356 if (elm_widget_focus_get(obj))
1357 for (; l; l = list_next(l))
1359 Evas_Object *cur = list_data_get(l);
1360 if (elm_widget_focus_get(cur)) break;
1363 const Eina_List *start = l;
1364 Evas_Object *to_focus = NULL;
1366 /* Interate sub items */
1367 /* Go to end of list */
1368 for (; l; l = list_next(l))
1370 Evas_Object *tmp = NULL;
1371 Evas_Object *cur = list_data_get(l);
1373 if (elm_widget_parent_get(cur) != obj)
1376 /* Try Focus cycle in subitem */
1377 if (elm_widget_focus_next_get(cur, dir, &tmp))
1382 else if ((tmp) && (!to_focus))
1388 /* Get First possible */
1389 for (;l != start; l = list_next(l))
1391 Evas_Object *tmp = NULL;
1392 Evas_Object *cur = list_data_get(l);
1394 if (elm_widget_parent_get(cur) != obj)
1397 /* Try Focus cycle in subitem */
1398 elm_widget_focus_next_get(cur, dir, &tmp);
1411 elm_widget_signal_emit(Evas_Object *obj, const char *emission, const char *source)
1414 if (!sd->signal_func) return;
1415 sd->signal_func(obj, emission, source);
1419 _edje_signal_callback(void *data, Evas_Object *obj __UNUSED__, const char *emission, const char *source)
1421 Edje_Signal_Data *esd = data;
1422 esd->func(esd->data, esd->obj, emission, source);
1426 elm_widget_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data)
1428 Edje_Signal_Data *esd;
1430 if (!sd->callback_add_func) return;
1431 EINA_SAFETY_ON_NULL_RETURN(func);
1433 esd = ELM_NEW(Edje_Signal_Data);
1438 esd->emission = eina_stringshare_add(emission);
1439 esd->source = eina_stringshare_add(source);
1441 sd->edje_signals = eina_list_append(sd->edje_signals, esd);
1442 sd->callback_add_func(obj, emission, source, _edje_signal_callback, esd);
1446 elm_widget_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source))
1448 Edje_Signal_Data *esd;
1451 API_ENTRY return NULL;
1452 if (!sd->callback_del_func) return NULL;
1454 EINA_LIST_FOREACH(sd->edje_signals, l, esd)
1456 if ((esd->func == func) && (!strcmp(esd->emission, emission)) &&
1457 (!strcmp(esd->source, source)))
1459 sd->edje_signals = eina_list_remove_list(sd->edje_signals, l);
1460 eina_stringshare_del(esd->emission);
1461 eina_stringshare_del(esd->source);
1467 sd->callback_del_func(obj, emission, source, _edje_signal_callback, esd);
1472 elm_widget_focus_set(Evas_Object *obj, int first)
1478 sd->focus_order = focus_order;
1479 sd->focused = EINA_TRUE;
1480 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1484 sd->focus_func(obj);
1491 if ((_is_focusable(sd->resize_obj)) &&
1492 (!elm_widget_disabled_get(sd->resize_obj)))
1494 elm_widget_focus_set(sd->resize_obj, first);
1500 EINA_LIST_FOREACH(sd->subobjs, l, child)
1502 if ((_is_focusable(child)) &&
1503 (!elm_widget_disabled_get(child)))
1505 elm_widget_focus_set(child, first);
1515 EINA_LIST_REVERSE_FOREACH(sd->subobjs, l, child)
1517 if ((_is_focusable(child)) &&
1518 (!elm_widget_disabled_get(child)))
1520 elm_widget_focus_set(child, first);
1526 if ((_is_focusable(sd->resize_obj)) &&
1527 (!elm_widget_disabled_get(sd->resize_obj)))
1529 elm_widget_focus_set(sd->resize_obj, first);
1537 elm_widget_parent_get(const Evas_Object *obj)
1539 API_ENTRY return NULL;
1540 return sd->parent_obj;
1544 elm_widget_focused_object_clear(Evas_Object *obj)
1547 if (!sd->focused) return;
1548 if (elm_widget_focus_get(sd->resize_obj))
1549 elm_widget_focused_object_clear(sd->resize_obj);
1554 EINA_LIST_FOREACH(sd->subobjs, l, child)
1556 if (elm_widget_focus_get(child))
1558 elm_widget_focused_object_clear(child);
1563 sd->focused = EINA_FALSE;
1564 if (sd->on_focus_func) sd->on_focus_func(sd->on_focus_data, obj);
1565 if (sd->focus_func) sd->focus_func(obj);
1569 elm_widget_focus_steal(Evas_Object *obj)
1571 Evas_Object *parent, *o;
1574 if (sd->focused) return;
1575 if (sd->disabled) return;
1579 o = elm_widget_parent_get(parent);
1581 sd = evas_object_smart_data_get(o);
1582 if (sd->focused) break;
1585 if (!elm_widget_parent_get(parent))
1586 elm_widget_focused_object_clear(parent);
1589 parent = elm_widget_parent_get(parent);
1590 sd = evas_object_smart_data_get(parent);
1591 if (elm_widget_focus_get(sd->resize_obj))
1593 elm_widget_focused_object_clear(sd->resize_obj);
1599 EINA_LIST_FOREACH(sd->subobjs, l, child)
1601 if (elm_widget_focus_get(child))
1603 elm_widget_focused_object_clear(child);
1614 elm_widget_activate(Evas_Object *obj)
1617 elm_widget_change(obj);
1618 if (sd->activate_func) sd->activate_func(obj);
1622 elm_widget_change(Evas_Object *obj)
1625 elm_widget_change(elm_widget_parent_get(obj));
1626 if (sd->on_change_func) sd->on_change_func(sd->on_change_data, obj);
1630 elm_widget_disabled_set(Evas_Object *obj, int disabled)
1634 if (sd->disabled == disabled) return;
1635 sd->disabled = disabled;
1638 Evas_Object *o, *parent;
1643 o = elm_widget_parent_get(parent);
1647 if (elm_widget_focus_get(obj))
1648 elm_widget_focus_cycle(parent, ELM_FOCUS_NEXT);
1650 if (sd->disable_func) sd->disable_func(obj);
1654 elm_widget_disabled_get(const Evas_Object *obj)
1657 return sd->disabled;
1661 elm_widget_show_region_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
1663 Evas_Object *parent_obj, *child_obj;
1664 Evas_Coord px, py, cx, cy;
1667 if ((x == sd->rx) && (y == sd->ry) && (w == sd->rw) && (h == sd->rh)) return;
1672 if (sd->on_show_region_func)
1673 sd->on_show_region_func(sd->on_show_region_data, obj);
1677 parent_obj = sd->parent_obj;
1678 child_obj = sd->obj;
1679 sd = evas_object_smart_data_get(parent_obj);
1681 if ((!parent_obj) || (!sd) || (!_elm_widget_is(parent_obj))) break;
1683 evas_object_geometry_get(parent_obj, &px, &py, NULL, NULL);
1684 evas_object_geometry_get(child_obj, &cx, &cy, NULL, NULL);
1693 if (sd->on_show_region_func)
1695 sd->on_show_region_func(sd->on_show_region_data, parent_obj);
1702 elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
1714 * Get the focus region of the given widget.
1716 * The focus region is the area of a widget that should brought into the
1717 * visible area when the widget is focused. Mostly used to show the part of
1718 * an entry where the cursor is, for example. The area returned is relative
1719 * to the object @p obj.
1720 * If the @p obj doesn't have the proper on_focus_region_hook set, this
1721 * function will return the full size of the object.
1723 * @param obj The widget object
1724 * @param x Where to store the x coordinate of the area
1725 * @param y Where to store the y coordinate of the area
1726 * @param w Where to store the width of the area
1727 * @param h Where to store the height of the area
1732 elm_widget_focus_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
1738 sd = evas_object_smart_data_get(obj);
1739 if (!sd || !_elm_widget_is(obj) || !sd->on_focus_region_func)
1741 evas_object_geometry_get(obj, NULL, NULL, w, h);
1746 sd->on_focus_region_func(obj, x, y, w, h);
1750 elm_widget_scroll_hold_push(Evas_Object *obj)
1754 if (sd->scroll_hold == 1)
1755 evas_object_smart_callback_call(obj, "scroll-hold-on", obj);
1756 if (sd->parent_obj) elm_widget_scroll_hold_push(sd->parent_obj);
1757 // FIXME: on delete/reparent hold pop
1761 elm_widget_scroll_hold_pop(Evas_Object *obj)
1765 if (sd->scroll_hold < 0) sd->scroll_hold = 0;
1766 if (!sd->scroll_hold)
1767 evas_object_smart_callback_call(obj, "scroll-hold-off", obj);
1768 if (sd->parent_obj) elm_widget_scroll_hold_pop(sd->parent_obj);
1772 elm_widget_scroll_hold_get(const Evas_Object *obj)
1775 return sd->scroll_hold;
1779 elm_widget_scroll_freeze_push(Evas_Object *obj)
1782 sd->scroll_freeze++;
1783 if (sd->scroll_freeze == 1)
1784 evas_object_smart_callback_call(obj, "scroll-freeze-on", obj);
1785 if (sd->parent_obj) elm_widget_scroll_freeze_push(sd->parent_obj);
1786 // FIXME: on delete/reparent freeze pop
1790 elm_widget_scroll_freeze_pop(Evas_Object *obj)
1793 sd->scroll_freeze--;
1794 if (sd->scroll_freeze < 0) sd->scroll_freeze = 0;
1795 if (!sd->scroll_freeze)
1796 evas_object_smart_callback_call(obj, "scroll-freeze-off", obj);
1797 if (sd->parent_obj) elm_widget_scroll_freeze_pop(sd->parent_obj);
1801 elm_widget_scroll_freeze_get(const Evas_Object *obj)
1804 return sd->scroll_freeze;
1808 elm_widget_scale_set(Evas_Object *obj, double scale)
1811 if (scale <= 0.0) scale = 0.0;
1812 if (sd->scale != scale)
1815 elm_widget_theme(obj);
1820 elm_widget_scale_get(const Evas_Object *obj)
1822 API_ENTRY return 1.0;
1823 // FIXME: save walking up the tree by storing/caching parent scale
1824 if (sd->scale == 0.0)
1827 return elm_widget_scale_get(sd->parent_obj);
1835 elm_widget_theme_set(Evas_Object *obj, Elm_Theme *th)
1838 if (sd->theme != th)
1840 if (sd->theme) elm_theme_free(sd->theme);
1843 elm_widget_theme(obj);
1848 elm_widget_theme_get(const Evas_Object *obj)
1850 API_ENTRY return NULL;
1854 return elm_widget_theme_get(sd->parent_obj);
1862 elm_widget_style_set(Evas_Object *obj, const char *style)
1866 if (eina_stringshare_replace(&sd->style, style))
1867 elm_widget_theme(obj);
1871 elm_widget_style_get(const Evas_Object *obj)
1873 API_ENTRY return NULL;
1874 if (sd->style) return sd->style;
1879 elm_widget_type_set(Evas_Object *obj, const char *type)
1882 eina_stringshare_replace(&sd->type, type);
1886 elm_widget_type_get(const Evas_Object *obj)
1888 API_ENTRY return NULL;
1889 if (sd->type) return sd->type;
1894 elm_widget_tooltip_add(Evas_Object *obj, Elm_Tooltip *tt)
1897 sd->tooltips = eina_list_append(sd->tooltips, tt);
1901 elm_widget_tooltip_del(Evas_Object *obj, Elm_Tooltip *tt)
1904 sd->tooltips = eina_list_remove(sd->tooltips, tt);
1908 elm_widget_cursor_add(Evas_Object *obj, Elm_Cursor *cur)
1911 sd->cursors = eina_list_append(sd->cursors, cur);
1915 elm_widget_cursor_del(Evas_Object *obj, Elm_Cursor *cur)
1918 sd->cursors = eina_list_remove(sd->cursors, cur);
1922 elm_widget_drag_lock_x_set(Evas_Object *obj, Eina_Bool lock)
1925 if (sd->drag_x_locked == lock) return;
1926 sd->drag_x_locked = lock;
1927 if (sd->drag_x_locked) _propagate_x_drag_lock(obj, 1);
1928 else _propagate_x_drag_lock(obj, -1);
1932 elm_widget_drag_lock_y_set(Evas_Object *obj, Eina_Bool lock)
1935 if (sd->drag_y_locked == lock) return;
1936 sd->drag_y_locked = lock;
1937 if (sd->drag_y_locked) _propagate_y_drag_lock(obj, 1);
1938 else _propagate_y_drag_lock(obj, -1);
1942 elm_widget_drag_lock_x_get(const Evas_Object *obj)
1944 API_ENTRY return EINA_FALSE;
1945 return sd->drag_x_locked;
1949 elm_widget_drag_lock_y_get(const Evas_Object *obj)
1951 API_ENTRY return EINA_FALSE;
1952 return sd->drag_y_locked;
1956 elm_widget_drag_child_locked_x_get(const Evas_Object *obj)
1959 return sd->child_drag_x_locked;
1963 elm_widget_drag_child_locked_y_get(const Evas_Object *obj)
1966 return sd->child_drag_y_locked;
1970 elm_widget_theme_object_set(Evas_Object *obj, Evas_Object *edj, const char *wname, const char *welement, const char *wstyle)
1972 API_ENTRY return EINA_FALSE;
1973 return _elm_theme_object_set(obj, edj, wname, welement, wstyle);
1977 elm_widget_type_check(const Evas_Object *obj, const char *type)
1979 const char *provided, *expected = "(unknown)";
1980 static int abort_on_warn = -1;
1981 provided = elm_widget_type_get(obj);
1982 if (EINA_LIKELY(provided == type)) return EINA_TRUE;
1983 if (type) expected = type;
1984 if ((!provided) || (!provided[0]))
1986 provided = evas_object_type_get(obj);
1987 if ((!provided) || (!provided[0]))
1988 provided = "(unknown)";
1990 ERR("Passing Object: %p, of type: '%s' when expecting type: '%s'", obj, provided, expected);
1991 if (abort_on_warn == -1)
1993 if (getenv("ELM_ERROR_ABORT")) abort_on_warn = 1;
1994 else abort_on_warn = 0;
1996 if (abort_on_warn == 1) abort();
2003 * Split string in words
2005 * @param str Source string
2006 * @return List of const words
2008 * @see elm_widget_stringlist_free()
2012 elm_widget_stringlist_get(const char *str)
2014 Eina_List *list = NULL;
2016 if (!str) return NULL;
2017 for (b = s = str; 1; s++)
2019 if ((*s == ' ') || (!*s))
2021 char *t = malloc(s - b + 1);
2024 strncpy(t, b, s - b);
2026 list = eina_list_append(list, eina_stringshare_add(t));
2037 elm_widget_stringlist_free(Eina_List *list)
2040 EINA_LIST_FREE(list, s) eina_stringshare_del(s);
2046 * Allocate a new Elm_Widget_Item-derived structure.
2048 * The goal of this structure is to provide common ground for actions
2049 * that a widget item have, such as the owner widget, callback to
2050 * notify deletion, data pointer and maybe more.
2052 * @param widget the owner widget that holds this item, must be an elm_widget!
2053 * @param alloc_size any number greater than sizeof(Elm_Widget_Item) that will
2054 * be used to allocate memory.
2056 * @return allocated memory that is already zeroed out, or NULL on errors.
2058 * @see elm_widget_item_new() convenience macro.
2059 * @see elm_widget_item_del() to release memory.
2062 EAPI Elm_Widget_Item *
2063 _elm_widget_item_new(Evas_Object *widget, size_t alloc_size)
2065 if (!_elm_widget_is(widget))
2068 Elm_Widget_Item *item;
2070 EINA_SAFETY_ON_TRUE_RETURN_VAL(alloc_size < sizeof(Elm_Widget_Item), NULL);
2071 EINA_SAFETY_ON_TRUE_RETURN_VAL(!_elm_widget_is(widget), NULL);
2073 item = calloc(1, alloc_size);
2074 EINA_SAFETY_ON_NULL_RETURN_VAL(item, NULL);
2076 EINA_MAGIC_SET(item, ELM_WIDGET_ITEM_MAGIC);
2077 item->widget = widget;
2084 * Releases widget item memory, calling back del_cb() if it exists.
2086 * If there is a Elm_Widget_Item::del_cb, then it will be called prior
2087 * to memory release. Note that elm_widget_item_pre_notify_del() calls
2088 * this function and then unset it, thus being useful for 2 step
2089 * cleanup whenever the del_cb may use any of the data that must be
2090 * deleted from item.
2092 * The Elm_Widget_Item::view will be deleted (evas_object_del()) if it
2095 * @param item a valid #Elm_Widget_Item to be deleted.
2096 * @see elm_widget_item_del() convenience macro.
2100 _elm_widget_item_del(Elm_Widget_Item *item)
2102 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2105 item->del_cb((void *)item->data, item->widget, item);
2108 evas_object_del(item->view);
2110 EINA_MAGIC_SET(item, EINA_MAGIC_NONE);
2117 * Notify object will be deleted without actually deleting it.
2119 * This function will callback Elm_Widget_Item::del_cb if it is set
2120 * and then unset it so it is not called twice (ie: from
2121 * elm_widget_item_del()).
2123 * @param item a valid #Elm_Widget_Item to be notified
2124 * @see elm_widget_item_pre_notify_del() convenience macro.
2128 _elm_widget_item_pre_notify_del(Elm_Widget_Item *item)
2130 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2131 if (!item->del_cb) return;
2132 item->del_cb((void *)item->data, item->widget, item);
2133 item->del_cb = NULL;
2139 * Set the function to notify when item is being deleted.
2141 * This function will complain if there was a callback set already,
2142 * however it will set the new one.
2144 * The callback will be called from elm_widget_item_pre_notify_del()
2145 * or elm_widget_item_del() will be called with:
2146 * - data: the Elm_Widget_Item::data value.
2147 * - obj: the Elm_Widget_Item::widget evas object.
2148 * - event_info: the item being deleted.
2150 * @param item a valid #Elm_Widget_Item to be notified
2151 * @see elm_widget_item_del_cb_set() convenience macro.
2155 _elm_widget_item_del_cb_set(Elm_Widget_Item *item, Evas_Smart_Cb del_cb)
2157 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2159 if ((item->del_cb) && (item->del_cb != del_cb))
2160 WRN("You're replacing a previously set del_cb %p of item %p with %p",
2161 item->del_cb, item, del_cb);
2163 item->del_cb = del_cb;
2169 * Set user-data in this item.
2171 * User data may be used to identify this item or just store any
2172 * application data. It is automatically given as the first parameter
2173 * of the deletion notify callback.
2175 * @param item a valid #Elm_Widget_Item to store data in.
2176 * @param data user data to store.
2177 * @see elm_widget_item_del_cb_set() convenience macro.
2181 _elm_widget_item_data_set(Elm_Widget_Item *item, const void *data)
2183 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2184 if ((item->data) && (item->data != data))
2185 DBG("Replacing item %p data %p with %p", item, item->data, data);
2192 * Retrieves user-data of this item.
2194 * @param item a valid #Elm_Widget_Item to get data from.
2195 * @see elm_widget_item_data_set()
2199 _elm_widget_item_data_get(const Elm_Widget_Item *item)
2201 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2202 return (void *)item->data;
2205 typedef struct _Elm_Widget_Item_Tooltip Elm_Widget_Item_Tooltip;
2207 struct _Elm_Widget_Item_Tooltip
2209 Elm_Widget_Item *item;
2210 Elm_Tooltip_Item_Content_Cb func;
2211 Evas_Smart_Cb del_cb;
2215 static Evas_Object *
2216 _elm_widget_item_tooltip_label_create(void *data, Evas_Object *obj, void *item __UNUSED__)
2218 Evas_Object *label = elm_label_add(obj);
2221 elm_object_style_set(label, "tooltip");
2222 elm_label_label_set(label, data);
2227 _elm_widget_item_tooltip_label_del_cb(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
2229 eina_stringshare_del(data);
2235 * Set the text to be shown in the widget item.
2237 * @param item Target item
2238 * @param text The text to set in the content
2240 * Setup the text as tooltip to object. The item can have only one tooltip,
2241 * so any previous tooltip data is removed.
2246 _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item, const char *text)
2248 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2249 EINA_SAFETY_ON_NULL_RETURN(text);
2251 text = eina_stringshare_add(text);
2252 _elm_widget_item_tooltip_content_cb_set
2253 (item, _elm_widget_item_tooltip_label_create, text,
2254 _elm_widget_item_tooltip_label_del_cb);
2257 static Evas_Object *
2258 _elm_widget_item_tooltip_create(void *data, Evas_Object *obj)
2260 Elm_Widget_Item_Tooltip *wit = data;
2261 return wit->func((void *)wit->data, obj, wit->item);
2265 _elm_widget_item_tooltip_del_cb(void *data, Evas_Object *obj, void *event_info __UNUSED__)
2267 Elm_Widget_Item_Tooltip *wit = data;
2268 if (wit->del_cb) wit->del_cb((void *)wit->data, obj, wit->item);
2275 * Set the content to be shown in the tooltip item
2277 * Setup the tooltip to item. The item can have only one tooltip,
2278 * so any previous tooltip data is removed. @p func(with @p data) will
2279 * be called every time that need show the tooltip and it should
2280 * return a valid Evas_Object. This object is then managed fully by
2281 * tooltip system and is deleted when the tooltip is gone.
2283 * @param item the widget item being attached a tooltip.
2284 * @param func the function used to create the tooltip contents.
2285 * @param data what to provide to @a func as callback data/context.
2286 * @param del_cb called when data is not needed anymore, either when
2287 * another callback replaces @func, the tooltip is unset with
2288 * elm_widget_item_tooltip_unset() or the owner @a item
2289 * dies. This callback receives as the first parameter the
2290 * given @a data, and @c event_info is the item.
2295 _elm_widget_item_tooltip_content_cb_set(Elm_Widget_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb)
2297 Elm_Widget_Item_Tooltip *wit;
2299 ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, error_noitem);
2303 _elm_widget_item_tooltip_unset(item);
2307 wit = ELM_NEW(Elm_Widget_Item_Tooltip);
2308 if (!wit) goto error;
2312 wit->del_cb = del_cb;
2314 elm_object_sub_tooltip_content_cb_set
2315 (item->view, item->widget, _elm_widget_item_tooltip_create, wit,
2316 _elm_widget_item_tooltip_del_cb);
2321 if (del_cb) del_cb((void *)data, NULL, item);
2324 if (del_cb) del_cb((void *)data, item->widget, item);
2330 * Unset tooltip from item
2332 * @param item widget item to remove previously set tooltip.
2334 * Remove tooltip from item. The callback provided as del_cb to
2335 * elm_widget_item_tooltip_content_cb_set() will be called to notify
2336 * it is not used anymore.
2338 * @see elm_widget_item_tooltip_content_cb_set()
2343 _elm_widget_item_tooltip_unset(Elm_Widget_Item *item)
2345 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2346 elm_object_tooltip_unset(item->view);
2352 * Sets a different style for this item tooltip.
2354 * @note before you set a style you should define a tooltip with
2355 * elm_widget_item_tooltip_content_cb_set() or
2356 * elm_widget_item_tooltip_text_set()
2358 * @param item widget item with tooltip already set.
2359 * @param style the theme style to use (default, transparent, ...)
2364 _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item, const char *style)
2366 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2367 elm_object_tooltip_style_set(item->view, style);
2373 * Get the style for this item tooltip.
2375 * @param item widget item with tooltip already set.
2376 * @return style the theme style in use, defaults to "default". If the
2377 * object does not have a tooltip set, then NULL is returned.
2382 _elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item)
2384 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2385 return elm_object_tooltip_style_get(item->view);
2389 _elm_widget_item_cursor_set(Elm_Widget_Item *item, const char *cursor)
2391 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2392 elm_object_sub_cursor_set(item->view, item->widget, cursor);
2396 _elm_widget_item_cursor_get(const Elm_Widget_Item *item)
2398 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2399 return elm_object_cursor_get(item->view);
2403 _elm_widget_item_cursor_unset(Elm_Widget_Item *item)
2405 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2406 elm_object_cursor_unset(item->view);
2412 * Sets a different style for this item cursor.
2414 * @note before you set a style you should define a cursor with
2415 * elm_widget_item_cursor_set()
2417 * @param item widget item with cursor already set.
2418 * @param style the theme style to use (default, transparent, ...)
2423 _elm_widget_item_cursor_style_set(Elm_Widget_Item *item, const char *style)
2425 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2426 elm_object_cursor_style_set(item->view, style);
2432 * Get the style for this item cursor.
2434 * @param item widget item with cursor already set.
2435 * @return style the theme style in use, defaults to "default". If the
2436 * object does not have a cursor set, then NULL is returned.
2441 _elm_widget_item_cursor_style_get(const Elm_Widget_Item *item)
2443 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, NULL);
2444 return elm_object_cursor_style_get(item->view);
2450 * Set if the cursor set should be searched on the theme or should use
2451 * the provided by the engine, only.
2453 * @note before you set if should look on theme you should define a cursor
2454 * with elm_object_cursor_set(). By default it will only look for cursors
2455 * provided by the engine.
2457 * @param item widget item with cursor already set.
2458 * @param engine_only boolean to define it cursors should be looked only
2459 * between the provided by the engine or searched on widget's theme as well.
2464 _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item, Eina_Bool engine_only)
2466 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item);
2467 elm_object_cursor_engine_only_set(item->view, engine_only);
2473 * Get the cursor engine only usage for this item cursor.
2475 * @param item widget item with cursor already set.
2476 * @return engine_only boolean to define it cursors should be looked only
2477 * between the provided by the engine or searched on widget's theme as well. If
2478 * the object does not have a cursor set, then EINA_FALSE is returned.
2483 _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item)
2485 ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, EINA_FALSE);
2486 return elm_object_cursor_engine_only_get(item->view);
2489 // smart object funcs
2491 _smart_reconfigure(Smart_Data *sd)
2495 evas_object_move(sd->resize_obj, sd->x, sd->y);
2496 evas_object_resize(sd->resize_obj, sd->w, sd->h);
2500 evas_object_move(sd->hover_obj, sd->x, sd->y);
2501 evas_object_resize(sd->hover_obj, sd->w, sd->h);
2506 _smart_add(Evas_Object *obj)
2510 sd = calloc(1, sizeof(Smart_Data));
2513 sd->x = sd->y = sd->w = sd->h = 0;
2515 sd->mirrored_auto_mode = EINA_TRUE; /* will follow system locale settings */
2516 evas_object_smart_data_set(obj, sd);
2519 static Evas_Object *
2520 _newest_focus_order_get(Evas_Object *obj, unsigned int *newest_focus_order, Eina_Bool can_focus_only)
2523 Evas_Object *child, *ret, *best;
2525 API_ENTRY return NULL;
2526 if (!evas_object_visible_get(obj)) return NULL;
2528 if (*newest_focus_order < sd->focus_order)
2530 *newest_focus_order = sd->focus_order;
2533 EINA_LIST_FOREACH(sd->subobjs, l, child)
2535 ret = _newest_focus_order_get(child, newest_focus_order, can_focus_only);
2539 if ((can_focus_only) && (!elm_widget_can_focus_get(best))) return NULL;
2544 _if_focused_revert(Evas_Object *obj, Eina_Bool can_focus_only)
2547 Evas_Object *newest = NULL;
2548 unsigned int newest_focus_order = 0;
2552 if (!sd->focused) return;
2553 if (!sd->parent_obj) return;
2555 top = elm_widget_top_get(sd->parent_obj);
2558 newest = _newest_focus_order_get(top, &newest_focus_order, can_focus_only);
2561 elm_object_unfocus(newest);
2562 elm_object_focus(newest);
2568 _smart_del(Evas_Object *obj)
2571 Edje_Signal_Data *esd;
2575 if (sd->del_pre_func) sd->del_pre_func(obj);
2578 sobj = sd->resize_obj;
2579 sd->resize_obj = NULL;
2580 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2581 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2582 evas_object_del(sobj);
2586 sobj = sd->hover_obj;
2587 sd->hover_obj = NULL;
2588 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2589 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2590 evas_object_del(sobj);
2592 EINA_LIST_FREE(sd->subobjs, sobj)
2594 evas_object_event_callback_del_full(sobj, EVAS_CALLBACK_DEL, _sub_obj_del, sd);
2595 evas_object_smart_callback_call(sd->obj, "sub-object-del", sobj);
2596 evas_object_del(sobj);
2598 eina_list_free(sd->tooltips); /* should be empty anyway */
2599 eina_list_free(sd->cursors); /* should be empty anyway */
2600 EINA_LIST_FREE(sd->edje_signals, esd)
2602 eina_stringshare_del(esd->emission);
2603 eina_stringshare_del(esd->source);
2606 eina_list_free(sd->event_cb); /* should be empty anyway */
2607 if (sd->del_func) sd->del_func(obj);
2608 if (sd->style) eina_stringshare_del(sd->style);
2609 if (sd->type) eina_stringshare_del(sd->type);
2610 if (sd->theme) elm_theme_free(sd->theme);
2611 _if_focused_revert(obj, EINA_TRUE);
2616 _smart_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
2621 _smart_reconfigure(sd);
2625 _smart_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
2630 _smart_reconfigure(sd);
2634 _smart_show(Evas_Object *obj)
2639 if ((list = evas_object_smart_members_get(obj)))
2641 EINA_LIST_FREE(list, o)
2643 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2644 evas_object_show(o);
2650 _smart_hide(Evas_Object *obj)
2655 list = evas_object_smart_members_get(obj);
2656 EINA_LIST_FREE(list, o)
2658 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2659 evas_object_hide(o);
2661 _if_focused_revert(obj, EINA_TRUE);
2665 _smart_color_set(Evas_Object *obj, int r, int g, int b, int a)
2670 if ((list = evas_object_smart_members_get(obj)))
2672 EINA_LIST_FREE(list, o)
2674 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2675 evas_object_color_set(o, r, g, b, a);
2681 _smart_clip_set(Evas_Object *obj, Evas_Object *clip)
2686 if ((list = evas_object_smart_members_get(obj)))
2688 EINA_LIST_FREE(list, o)
2690 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2691 evas_object_clip_set(o, clip);
2697 _smart_clip_unset(Evas_Object *obj)
2702 if ((list = evas_object_smart_members_get(obj)))
2704 EINA_LIST_FREE(list, o)
2706 if (evas_object_data_get(o, "_elm_leaveme")) continue;
2707 evas_object_clip_unset(o);
2713 _smart_calculate(Evas_Object *obj)
2716 if (sd->changed_func) sd->changed_func(obj);
2719 /* never need to touch this */
2723 if (_e_smart) return;
2725 static const Evas_Smart_Class sc =
2728 EVAS_SMART_CLASS_VERSION,
2746 _e_smart = evas_smart_class_new(&sc);
2750 /* happy debug functions */
2753 _sub_obj_tree_dump(const Evas_Object *o, int lvl)
2757 for (i = 0; i < lvl*3; i++)
2760 if (_elm_widget_is(o))
2763 Smart_Data *sd = evas_object_smart_data_get(o);
2764 printf("+ %s(%p)\n", sd->type, o);
2766 _sub_obj_tree_dump(sd->resize_obj, lvl + 1);
2767 EINA_LIST_FOREACH(sd->subobjs, l, o)
2769 if (o != sd->resize_obj)
2770 _sub_obj_tree_dump(o, lvl + 1);
2774 printf("+ %s(%p)\n", evas_object_type_get(o), o);
2778 _sub_obj_tree_dot_dump(const Evas_Object *obj, FILE *output)
2780 if (!_elm_widget_is(obj))
2783 Smart_Data *sd = evas_object_smart_data_get(obj);
2785 Eina_Bool visible = evas_object_visible_get(obj);
2786 Eina_Bool disabled = elm_widget_disabled_get(obj);
2787 Eina_Bool focused = elm_widget_focus_get(obj);
2788 Eina_Bool can_focus = elm_widget_can_focus_get(obj);
2792 fprintf(output, "\"%p\" -- \"%p\" [ color=black", sd->parent_obj, obj);
2795 fprintf(output, ", style=bold");
2798 fprintf(output, ", color=gray28");
2800 fprintf(output, " ];\n");
2803 fprintf(output, "\"%p\" [ label = \"{%p|%s|%s|visible: %d|"
2804 "disabled: %d|focused: %d/%d|focus order:%d}\"", obj, obj, sd->type,
2805 evas_object_name_get(obj), visible, disabled, focused, can_focus,
2809 fprintf(output, ", style=bold");
2812 fprintf(output, ", fontcolor=gray28");
2814 if ((disabled) || (!visible))
2815 fprintf(output, ", color=gray");
2818 fprintf(output, " ];\n");
2822 EINA_LIST_FOREACH(sd->subobjs, l, o)
2823 _sub_obj_tree_dot_dump(o, output);
2828 elm_widget_tree_dump(const Evas_Object *top)
2831 _sub_obj_tree_dump(top, 0);
2839 elm_widget_tree_dot_dump(const Evas_Object *top, FILE *output)
2842 if (!_elm_widget_is(top))
2844 fprintf(output, "graph "" { node [shape=record];\n");
2845 _sub_obj_tree_dot_dump(top, output);
2846 fprintf(output, "}\n");