1 #include <Elementary.h>
5 * @defgroup Button Button
7 * This is a push-button. Press it and run some function. It can contain
8 * a simple label and icon object.
11 typedef struct _Widget_Data Widget_Data;
15 Evas_Object *btn, *icon;
24 static const char *widtype = NULL;
25 static void _del_hook(Evas_Object *obj);
26 static void _theme_hook(Evas_Object *obj);
27 static void _disable_hook(Evas_Object *obj);
28 static void _sizing_eval(Evas_Object *obj);
29 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
30 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
31 static void _signal_clicked(void *data, Evas_Object *obj, const char *emission, const char *source);
32 static void _signal_pressed(void *data, Evas_Object *obj, const char *emission, const char *source);
33 static void _signal_unpressed(void *data, Evas_Object *obj, const char *emission, const char *source);
34 static void _on_focus_hook(void *data, Evas_Object *obj);
35 static void _activate(Evas_Object *obj);
36 static void _activate_hook(Evas_Object *obj);
37 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
38 Evas_Callback_Type type, void *event_info);
40 static const char SIG_CLICKED[] = "clicked";
41 static const char SIG_REPEATED[] = "repeated";
42 static const char SIG_UNPRESSED[] = "unpressed";
43 static const Evas_Smart_Cb_Description _signals[] = {
51 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
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")))
64 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
65 edje_object_signal_emit(wd->btn, "elm,anim,activate", "elm");
70 _del_hook(Evas_Object *obj)
72 Widget_Data *wd = elm_widget_data_get(obj);
74 if (wd->label) eina_stringshare_del(wd->label);
79 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
81 Widget_Data *wd = elm_widget_data_get(obj);
83 if (elm_widget_focus_get(obj))
85 edje_object_signal_emit(wd->btn, "elm,action,focus", "elm");
86 evas_object_focus_set(wd->btn, EINA_TRUE);
90 edje_object_signal_emit(wd->btn, "elm,action,unfocus", "elm");
91 evas_object_focus_set(wd->btn, EINA_FALSE);
96 _theme_hook(Evas_Object *obj)
98 Widget_Data *wd = elm_widget_data_get(obj);
101 _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
103 edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
105 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
107 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
109 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
111 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
112 edje_object_part_text_set(wd->btn, "elm.text", wd->label);
113 if (elm_object_disabled_get(obj))
114 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
115 edje_object_message_signal_process(wd->btn);
116 edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
117 str = edje_object_data_get(wd->btn, "focus_highlight");
118 if ((str) && (!strcmp(str, "on")))
119 elm_widget_highlight_in_theme_set(obj, EINA_TRUE);
121 elm_widget_highlight_in_theme_set(obj, EINA_FALSE);
126 _disable_hook(Evas_Object *obj)
128 Widget_Data *wd = elm_widget_data_get(obj);
130 if (elm_widget_disabled_get(obj))
131 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
133 edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
137 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
139 Widget_Data *wd = elm_widget_data_get(obj);
141 edje_object_signal_emit(wd->btn, emission, source);
145 _signal_callback_add_hook(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)
147 Widget_Data *wd = elm_widget_data_get(obj);
149 edje_object_signal_callback_add(wd->btn, emission, source, func_cb, data);
153 _signal_callback_del_hook(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)
155 Widget_Data *wd = elm_widget_data_get(obj);
156 edje_object_signal_callback_del_full(wd->btn, emission, source, func_cb,
161 _sizing_eval(Evas_Object *obj)
163 Widget_Data *wd = elm_widget_data_get(obj);
164 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
167 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
168 edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
169 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
170 evas_object_size_hint_min_set(obj, minw, minh);
171 evas_object_size_hint_max_set(obj, maxw, maxh);
175 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
177 Widget_Data *wd = elm_widget_data_get(data);
179 if (obj != wd->icon) return;
184 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
186 Widget_Data *wd = elm_widget_data_get(obj);
187 Evas_Object *sub = event_info;
191 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
192 evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
193 _changed_size_hints, obj);
195 edje_object_message_signal_process(wd->btn);
201 _activate(Evas_Object *obj)
203 Widget_Data *wd = elm_widget_data_get(obj);
207 ecore_timer_del(wd->timer);
210 wd->repeating = EINA_FALSE;
211 evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
212 _signal_unpressed(obj, wd->btn, NULL, NULL); /* safe guard when the theme does not emit the 'unpress' signal */
216 _activate_hook(Evas_Object *obj)
222 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
228 _autorepeat_send(void *data)
230 Widget_Data *wd = elm_widget_data_get(data);
231 if (!wd) return ECORE_CALLBACK_CANCEL;
233 evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
237 return ECORE_CALLBACK_CANCEL;
240 return ECORE_CALLBACK_RENEW;
244 _autorepeat_initial_send(void *data)
246 Widget_Data *wd = elm_widget_data_get(data);
247 if (!wd) return ECORE_CALLBACK_CANCEL;
249 if (wd->timer) ecore_timer_del(wd->timer);
250 wd->repeating = EINA_TRUE;
251 _autorepeat_send(data);
252 wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
254 return ECORE_CALLBACK_CANCEL;
258 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
260 Widget_Data *wd = elm_widget_data_get(data);
263 if ((wd->autorepeat) && (!wd->repeating))
265 if (wd->ar_threshold <= 0.0)
266 _autorepeat_initial_send(data); /* call immediately */
268 wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
273 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
275 Widget_Data *wd = elm_widget_data_get(data);
280 ecore_timer_del(wd->timer);
283 wd->repeating = EINA_FALSE;
284 evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
288 * Add a new button to the parent
289 * @param parent The parent object
290 * @return The new object or NULL if it cannot be created
295 elm_button_add(Evas_Object *parent)
301 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
303 wd = ELM_NEW(Widget_Data);
304 e = evas_object_evas_get(parent);
305 obj = elm_widget_add(e);
306 ELM_SET_WIDTYPE(widtype, "button");
307 elm_widget_type_set(obj, "button");
308 elm_widget_sub_object_add(parent, obj);
309 elm_widget_on_focus_hook_set( obj, _on_focus_hook, NULL );
310 elm_widget_data_set(obj, wd);
311 elm_widget_del_hook_set(obj, _del_hook);
312 elm_widget_theme_hook_set(obj, _theme_hook);
313 elm_widget_disable_hook_set(obj, _disable_hook);
314 elm_widget_can_focus_set(obj, EINA_TRUE);
315 elm_widget_activate_hook_set(obj, _activate_hook);
316 elm_widget_event_hook_set(obj, _event_hook);
317 elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
318 elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
319 elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
321 wd->btn = edje_object_add(e);
322 _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
323 edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
324 _signal_clicked, obj);
325 edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
326 _signal_pressed, obj);
327 edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
328 _signal_unpressed, obj);
329 elm_widget_resize_object_set(obj, wd->btn);
331 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
335 // TODO: convert Elementary to subclassing of Evas_Smart_Class
336 // TODO: and save some bytes, making descriptions per-class and not instance!
337 evas_object_smart_callbacks_descriptions_set(obj, _signals);
342 * Set the label used in the button
344 * @param obj The button object
345 * @param label The text will be written on the button
350 elm_button_label_set(Evas_Object *obj, const char *label)
352 ELM_CHECK_WIDTYPE(obj, widtype);
353 Widget_Data *wd = elm_widget_data_get(obj);
355 eina_stringshare_replace(&wd->label, label);
357 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
359 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
360 edje_object_message_signal_process(wd->btn);
361 edje_object_part_text_set(wd->btn, "elm.text", label);
366 elm_button_label_get(const Evas_Object *obj)
368 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
369 Widget_Data *wd = elm_widget_data_get(obj);
370 if (!wd) return NULL;
375 * Set the icon used for the button
377 * Once the icon object is set, a previously set one will be deleted
378 * If you want to keep that old content object, use the
379 * elm_button_icon_unset() function.
381 * @param obj The button object
382 * @param icon The icon object for the button
387 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
389 ELM_CHECK_WIDTYPE(obj, widtype);
390 Widget_Data *wd = elm_widget_data_get(obj);
392 if (wd->icon == icon) return;
393 if (wd->icon) evas_object_del(wd->icon);
397 elm_widget_sub_object_add(obj, icon);
398 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
399 _changed_size_hints, obj);
400 edje_object_part_swallow(wd->btn, "elm.swallow.content", icon);
401 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
402 edje_object_message_signal_process(wd->btn);
408 * Get the icon used for the button
410 * Return the icon object which is set for this widget.
412 * @param obj The button object
413 * @return The icon object that is being used
418 elm_button_icon_get(const Evas_Object *obj)
420 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
421 Widget_Data *wd = elm_widget_data_get(obj);
422 if (!wd) return NULL;
427 * Unset the icon used for the button
429 * Unparent and return the icon object which was set for this widget.
431 * @param obj The button object
432 * @return The icon object that was being used
437 elm_button_icon_unset(Evas_Object *obj)
439 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
440 Widget_Data *wd = elm_widget_data_get(obj);
441 if (!wd) return NULL;
442 if (!wd->icon) return NULL;
443 Evas_Object *icon = wd->icon;
444 elm_widget_sub_object_del(obj, wd->icon);
445 edje_object_part_unswallow(wd->btn, wd->icon);
451 * Turn on/off the autorepeat event generated when the user keeps pressing on the button
453 * @param obj The button object
454 * @param on A bool to turn on/off the event
459 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
461 ELM_CHECK_WIDTYPE(obj, widtype);
462 Widget_Data *wd = elm_widget_data_get(obj);
466 ecore_timer_del(wd->timer);
470 wd->repeating = EINA_FALSE;
474 * Get if autorepeat event is on
476 * @param obj The button object
477 * @return If autorepeat is on
482 elm_button_autorepeat_get(const Evas_Object *obj)
484 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
485 Widget_Data *wd = elm_widget_data_get(obj);
486 if (!wd) return EINA_FALSE;
487 return wd->autorepeat;
491 * Set the initial timeout before the autorepeat event is generated
493 * @param obj The button object
499 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
501 ELM_CHECK_WIDTYPE(obj, widtype);
502 Widget_Data *wd = elm_widget_data_get(obj);
504 if (wd->ar_threshold == t) return;
507 ecore_timer_del(wd->timer);
510 wd->ar_threshold = t;
514 * Get the initial timeout before the autorepeat event is generated
516 * @param obj The button object
522 elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj)
524 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
525 Widget_Data *wd = elm_widget_data_get(obj);
527 return wd->ar_threshold;
531 * Set the interval between each generated autorepeat event
533 * @param obj The button object
539 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
541 ELM_CHECK_WIDTYPE(obj, widtype);
542 Widget_Data *wd = elm_widget_data_get(obj);
544 if (wd->ar_interval == t) return;
547 if ((wd->repeating) && (wd->timer)) ecore_timer_interval_set(wd->timer, t);
551 * Get the interval between each generated autorepeat event
553 * @param obj The button object
559 elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj)
561 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
562 Widget_Data *wd = elm_widget_data_get(obj);
564 return wd->ar_interval;