451b6dd0b6350cca40eb45fee2bfd9f9e4a0aa3d
[framework/uifw/elementary.git] / src / lib / elm_button.c
1 #include <Elementary.h>
2 #include "elm_priv.h"
3
4 typedef struct _Widget_Data Widget_Data;
5
6 struct _Widget_Data
7 {
8    Evas_Object *btn, *icon;
9    const char *label;
10    double ar_threshold;
11    double ar_interval;
12    Ecore_Timer *timer;
13    Eina_Bool autorepeat : 1;
14    Eina_Bool repeating : 1;
15    Eina_Bool delete_me : 1;
16 };
17
18 static const char *widtype = NULL;
19 static void _del_hook(Evas_Object *obj);
20 static void _del_pre_hook(Evas_Object *obj);
21 static void _theme_hook(Evas_Object *obj);
22 static void _disable_hook(Evas_Object *obj);
23 static void _content_set_hook(Evas_Object *obj, const char *part, Evas_Object *content);
24 static Evas_Object *_content_get_hook(const Evas_Object *obj, const char *part);
25 static Evas_Object *_content_unset_hook(Evas_Object *obj, const char *part);
26 static void _sizing_eval(Evas_Object *obj);
27 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
28 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
29 static void _signal_clicked(void *data, Evas_Object *obj, const char *emission, const char *source);
30 static void _signal_pressed(void *data, Evas_Object *obj, const char *emission, const char *source);
31 static void _signal_unpressed(void *data, Evas_Object *obj, const char *emission, const char *source);
32 static void _on_focus_hook(void *data, Evas_Object *obj);
33 static void _activate(Evas_Object *obj);
34 static void _activate_hook(Evas_Object *obj);
35 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
36                              Evas_Callback_Type type, void *event_info);
37
38 static const char SIG_CLICKED[] = "clicked";
39 static const char SIG_REPEATED[] = "repeated";
40 static const char SIG_PRESSED[] = "pressed";
41 static const char SIG_UNPRESSED[] = "unpressed";
42 static const Evas_Smart_Cb_Description _signals[] = {
43        {SIG_CLICKED, ""},
44        {SIG_REPEATED, ""},
45        {SIG_PRESSED, ""},
46        {SIG_UNPRESSED, ""},
47        {NULL, NULL}
48 };
49
50 static Eina_Bool
51 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
52 {
53    if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
54    Evas_Event_Key_Down *ev = event_info;
55    Widget_Data *wd = elm_widget_data_get(obj);
56    if (!wd) return EINA_FALSE;
57    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
58    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
59    if ((strcmp(ev->keyname, "Return")) &&
60        (strcmp(ev->keyname, "KP_Enter")) &&
61        (strcmp(ev->keyname, "space")))
62      return EINA_FALSE;
63    _activate(obj);
64    ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
65    edje_object_signal_emit(wd->btn, "elm,anim,activate", "elm");
66    return EINA_TRUE;
67 }
68
69 static void
70 _del_pre_hook(Evas_Object *obj)
71 {
72    Widget_Data *wd = elm_widget_data_get(obj);
73    if (!wd) return;
74    wd->delete_me = EINA_TRUE;
75 }
76
77 static void
78 _del_hook(Evas_Object *obj)
79 {
80    Widget_Data *wd = elm_widget_data_get(obj);
81    if (!wd) return;
82    if (wd->label) eina_stringshare_del(wd->label);
83    free(wd);
84 }
85
86 static void
87 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
88 {
89    Widget_Data *wd = elm_widget_data_get(obj);
90    if (!wd) return;
91    if (elm_widget_focus_get(obj))
92      {
93         edje_object_signal_emit(wd->btn, "elm,action,focus", "elm");
94         evas_object_focus_set(wd->btn, EINA_TRUE);
95      }
96    else
97      {
98         edje_object_signal_emit(wd->btn, "elm,action,unfocus", "elm");
99         evas_object_focus_set(wd->btn, EINA_FALSE);
100      }
101 }
102
103 static void
104 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
105 {
106    Widget_Data *wd = elm_widget_data_get(obj);
107    if (!wd) return;
108    edje_object_mirrored_set(wd->btn, rtl);
109 }
110
111 static void
112 _theme_hook(Evas_Object *obj)
113 {
114    Widget_Data *wd = elm_widget_data_get(obj);
115    const char *str;
116    if (!wd) return;
117    _elm_widget_mirrored_reload(obj);
118    _mirrored_set(obj, elm_widget_mirrored_get(obj));
119    _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
120    if (wd->icon)
121      edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
122    if (wd->label)
123      edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
124    else
125      edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
126    if (wd->icon)
127      edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
128    else
129      edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
130    edje_object_part_text_set(wd->btn, "elm.text", wd->label);
131    if (elm_object_disabled_get(obj))
132      edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
133    edje_object_message_signal_process(wd->btn);
134    edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
135    str = edje_object_data_get(wd->btn, "focus_highlight");
136    if ((str) && (!strcmp(str, "on")))
137      elm_widget_highlight_in_theme_set(obj, EINA_TRUE);
138    else
139      elm_widget_highlight_in_theme_set(obj, EINA_FALSE);
140    _sizing_eval(obj);
141 }
142
143 static void
144 _disable_hook(Evas_Object *obj)
145 {
146    Widget_Data *wd = elm_widget_data_get(obj);
147    if (!wd) return;
148    if (elm_widget_disabled_get(obj))
149      edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
150    else
151      edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
152 }
153
154 static void
155 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
156 {
157    Widget_Data *wd = elm_widget_data_get(obj);
158    if (!wd) return;
159    edje_object_signal_emit(wd->btn, emission, source);
160 }
161
162 static void
163 _signal_callback_add_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
164 {
165    Widget_Data *wd = elm_widget_data_get(obj);
166    if (!wd) return;
167    edje_object_signal_callback_add(wd->btn, emission, source, func_cb, data);
168 }
169
170 static void
171 _signal_callback_del_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
172 {
173    Widget_Data *wd = elm_widget_data_get(obj);
174    edje_object_signal_callback_del_full(wd->btn, emission, source, func_cb,
175                                         data);
176 }
177
178 static void
179 _content_set_hook(Evas_Object *obj, const char *part, Evas_Object *content)
180 {
181    ELM_CHECK_WIDTYPE(obj, widtype);
182    Widget_Data *wd = elm_widget_data_get(obj);
183    if (!wd) return;
184    if (part && strcmp(part, "icon")) return;
185    if (wd->icon == content) return;
186    if (wd->icon) evas_object_del(wd->icon);
187    wd->icon = content;
188    if (content)
189      {
190         elm_widget_sub_object_add(obj, content);
191         evas_object_event_callback_add(content,
192                                        EVAS_CALLBACK_CHANGED_SIZE_HINTS,
193                                        _changed_size_hints, obj);
194         edje_object_part_swallow(wd->btn, "elm.swallow.content", content);
195         edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
196         edje_object_message_signal_process(wd->btn);
197      }
198    _sizing_eval(obj);
199 }
200
201 static Evas_Object *
202 _content_get_hook(const Evas_Object *obj, const char *part)
203 {
204    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
205    Widget_Data *wd;
206
207    if (part && strcmp(part, "icon")) return NULL;
208    wd = elm_widget_data_get(obj);
209    if (!wd) return NULL;
210    return wd->icon;
211 }
212
213 static Evas_Object *
214 _content_unset_hook(Evas_Object *obj, const char *part)
215 {
216    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
217    Widget_Data *wd;
218
219    if (part && strcmp(part, "icon")) return NULL;
220    wd = elm_widget_data_get(obj);
221    if (!wd) return NULL;
222    if (!wd->icon) return NULL;
223    Evas_Object *icon = wd->icon;
224    elm_widget_sub_object_del(obj, wd->icon);
225    evas_object_event_callback_del_full(wd->icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
226                                        _changed_size_hints, obj);
227    edje_object_part_unswallow(wd->btn, wd->icon);
228    wd->icon = NULL;
229    return icon;
230 }
231
232 static void
233 _sizing_eval(Evas_Object *obj)
234 {
235    Widget_Data *wd = elm_widget_data_get(obj);
236    Evas_Coord minw = -1, minh = -1;
237
238    if (!wd) return;
239    if (wd->delete_me) return;
240    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
241    edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
242    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
243    evas_object_size_hint_min_set(obj, minw, minh);
244 }
245
246 static void
247 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
248 {
249    Widget_Data *wd = elm_widget_data_get(data);
250    if (!wd) return;
251    if (obj != wd->icon) return;
252    _sizing_eval(data);
253 }
254
255 static void
256 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
257 {
258    Widget_Data *wd = elm_widget_data_get(obj);
259    Evas_Object *sub = event_info;
260    if (!wd) return;
261    if (sub == wd->icon)
262      {
263         edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
264         evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
265                                             _changed_size_hints, obj);
266         wd->icon = NULL;
267         edje_object_message_signal_process(wd->btn);
268         _sizing_eval(obj);
269      }
270 }
271
272 static void
273 _activate(Evas_Object *obj)
274 {
275    Widget_Data *wd = elm_widget_data_get(obj);
276    if (!wd) return;
277    if (wd->timer)
278      {
279         ecore_timer_del(wd->timer);
280         wd->timer = NULL;
281      }
282    wd->repeating = EINA_FALSE;
283    if ((_elm_config->access_mode == ELM_ACCESS_MODE_OFF) ||
284        (_elm_access_2nd_click_timeout(obj)))
285      {
286         if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
287            _elm_access_say(E_("Clicked"));
288         if (!elm_widget_disabled_get(obj) &&
289             !evas_object_freeze_events_get(obj))
290           evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
291      }
292 }
293
294 static void
295 _activate_hook(Evas_Object *obj)
296 {
297    _activate(obj);
298 }
299
300 static void
301 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
302 {
303    _activate(data);
304 }
305
306 static Eina_Bool
307 _autorepeat_send(void *data)
308 {
309    Widget_Data *wd = elm_widget_data_get(data);
310    if (!wd) return ECORE_CALLBACK_CANCEL;
311
312    evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
313    if (!wd->repeating)
314      {
315         wd->timer = NULL;
316         return ECORE_CALLBACK_CANCEL;
317      }
318
319    return ECORE_CALLBACK_RENEW;
320 }
321
322 static Eina_Bool
323 _autorepeat_initial_send(void *data)
324 {
325    Widget_Data *wd = elm_widget_data_get(data);
326    if (!wd) return ECORE_CALLBACK_CANCEL;
327
328    if (wd->timer) ecore_timer_del(wd->timer);
329    wd->repeating = EINA_TRUE;
330    _autorepeat_send(data);
331    wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
332
333    return ECORE_CALLBACK_CANCEL;
334 }
335
336 static void
337 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
338 {
339    Widget_Data *wd = elm_widget_data_get(data);
340    if (!wd) return;
341
342    if ((wd->autorepeat) && (!wd->repeating))
343      {
344         if (wd->ar_threshold <= 0.0)
345           _autorepeat_initial_send(data); /* call immediately */
346         else
347           wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
348      }
349
350    evas_object_smart_callback_call(data, SIG_PRESSED, NULL);
351 }
352
353 static void
354 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
355 {
356    Widget_Data *wd = elm_widget_data_get(data);
357    if (!wd) return;
358
359    if (wd->timer)
360      {
361         ecore_timer_del(wd->timer);
362         wd->timer = NULL;
363      }
364    wd->repeating = EINA_FALSE;
365    evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
366 }
367
368 static void
369 _elm_button_label_set(Evas_Object *obj, const char *item, const char *label)
370 {
371    ELM_CHECK_WIDTYPE(obj, widtype);
372    Widget_Data *wd = elm_widget_data_get(obj);
373    if (item && strcmp(item, "default")) return;
374    if (!wd) return;
375    eina_stringshare_replace(&wd->label, label);
376    if (label)
377      edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
378    else
379      edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
380    edje_object_message_signal_process(wd->btn);
381    edje_object_part_text_set(wd->btn, "elm.text", label);
382    _sizing_eval(obj);
383 }
384
385 static const char *
386 _elm_button_label_get(const Evas_Object *obj, const char *item)
387 {
388    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
389    Widget_Data *wd = elm_widget_data_get(obj);
390    if (item && strcmp(item, "default")) return NULL;
391    if (!wd) return NULL;
392    return wd->label;
393 }
394
395 static char *
396 _access_info_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
397 {
398    const char *txt = elm_widget_access_info_get(obj);
399    if (!txt) txt = _elm_button_label_get(obj, NULL);
400    if (txt) return strdup(txt);
401    return NULL;
402 }
403
404 static char *
405 _access_state_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
406 {
407    if (elm_widget_disabled_get(obj))
408      return strdup(E_("State: Disabled"));
409    return NULL;
410 }
411
412 EAPI Evas_Object *
413 elm_button_add(Evas_Object *parent)
414 {
415    Evas_Object *obj;
416    Evas *e;
417    Widget_Data *wd;
418
419    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
420
421    ELM_SET_WIDTYPE(widtype, "button");
422    elm_widget_type_set(obj, "button");
423    elm_widget_sub_object_add(parent, obj);
424    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
425    elm_widget_data_set(obj, wd);
426    elm_widget_del_hook_set(obj, _del_hook);
427    elm_widget_del_pre_hook_set(obj, _del_pre_hook);
428    elm_widget_theme_hook_set(obj, _theme_hook);
429    elm_widget_disable_hook_set(obj, _disable_hook);
430    elm_widget_can_focus_set(obj, EINA_TRUE);
431    elm_widget_activate_hook_set(obj, _activate_hook);
432    elm_widget_event_hook_set(obj, _event_hook);
433    elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
434    elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
435    elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
436    elm_widget_text_set_hook_set(obj, _elm_button_label_set);
437    elm_widget_text_get_hook_set(obj, _elm_button_label_get);
438    elm_widget_content_set_hook_set(obj, _content_set_hook);
439    elm_widget_content_get_hook_set(obj, _content_get_hook);
440    elm_widget_content_unset_hook_set(obj, _content_unset_hook);
441
442    wd->btn = edje_object_add(e);
443    _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
444    edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
445                                    _signal_clicked, obj);
446    edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
447                                    _signal_pressed, obj);
448    edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
449                                    _signal_unpressed, obj);
450    elm_widget_resize_object_set(obj, wd->btn);
451
452    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
453
454    _theme_hook(obj);
455
456    // TODO: convert Elementary to subclassing of Evas_Smart_Class
457    // TODO: and save some bytes, making descriptions per-class and not instance!
458    evas_object_smart_callbacks_descriptions_set(obj, _signals);
459
460    _elm_access_object_register(obj, wd->btn);
461    _elm_access_text_set(_elm_access_object_get(obj),
462                         ELM_ACCESS_TYPE, E_("Button"));
463    _elm_access_callback_set(_elm_access_object_get(obj),
464                             ELM_ACCESS_INFO, _access_info_cb, obj);
465    _elm_access_callback_set(_elm_access_object_get(obj),
466                             ELM_ACCESS_STATE, _access_state_cb, obj);
467    return obj;
468 }
469
470 EAPI void
471 <<<<<<< HEAD
472 elm_button_label_set(Evas_Object *obj, const char *label)
473 {
474    _elm_button_label_set(obj, NULL, label);
475 }
476
477 EAPI const char *
478 elm_button_label_get(const Evas_Object *obj)
479 {
480    return _elm_button_label_get(obj, NULL);
481 }
482
483
484 EAPI void
485 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
486 {
487    _content_set_hook(obj, "icon", icon);
488 }
489
490 EAPI Evas_Object *
491 elm_button_icon_get(const Evas_Object *obj)
492 {
493    return _content_get_hook(obj, "icon");
494 }
495
496 EAPI Evas_Object *
497 elm_button_icon_unset(Evas_Object *obj)
498 {
499    return _content_unset_hook(obj, "icon");
500 }
501
502 EAPI void
503 =======
504 >>>>>>> remotes/origin/upstream
505 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
506 {
507    ELM_CHECK_WIDTYPE(obj, widtype);
508    Widget_Data *wd = elm_widget_data_get(obj);
509    if (!wd) return;
510    if (wd->timer)
511      {
512         ecore_timer_del(wd->timer);
513         wd->timer = NULL;
514      }
515    wd->autorepeat = on;
516    wd->repeating = EINA_FALSE;
517 }
518
519 EAPI Eina_Bool
520 elm_button_autorepeat_get(const Evas_Object *obj)
521 {
522    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
523    Widget_Data *wd = elm_widget_data_get(obj);
524    if (!wd) return EINA_FALSE;
525    return wd->autorepeat;
526 }
527
528 EAPI void
529 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
530 {
531    ELM_CHECK_WIDTYPE(obj, widtype);
532    Widget_Data *wd = elm_widget_data_get(obj);
533    if (!wd) return;
534    if (wd->ar_threshold == t) return;
535    if (wd->timer)
536      {
537         ecore_timer_del(wd->timer);
538         wd->timer = NULL;
539      }
540    wd->ar_threshold = t;
541 }
542
543 EAPI double
544 elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj)
545 {
546    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
547    Widget_Data *wd = elm_widget_data_get(obj);
548    if (!wd) return 0.0;
549    return wd->ar_threshold;
550 }
551
552 EAPI void
553 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
554 {
555    ELM_CHECK_WIDTYPE(obj, widtype);
556    Widget_Data *wd = elm_widget_data_get(obj);
557    if (!wd) return;
558    if (wd->ar_interval == t) return;
559
560    wd->ar_interval = t;
561    if ((wd->repeating) && (wd->timer)) ecore_timer_interval_set(wd->timer, t);
562 }
563
564 EAPI double
565 elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj)
566 {
567    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
568    Widget_Data *wd = elm_widget_data_get(obj);
569    if (!wd) return 0.0;
570    return wd->ar_interval;
571 }