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