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")) && (strcmp(ev->keyname, "space")))
62 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
63 edje_object_signal_emit(wd->btn, "elm,anim,activate", "elm");
68 _del_hook(Evas_Object *obj)
70 Widget_Data *wd = elm_widget_data_get(obj);
72 if (wd->label) eina_stringshare_del(wd->label);
77 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
79 Widget_Data *wd = elm_widget_data_get(obj);
81 if (elm_widget_focus_get(obj))
83 edje_object_signal_emit(wd->btn, "elm,action,focus", "elm");
84 evas_object_focus_set(wd->btn, EINA_TRUE);
88 edje_object_signal_emit(wd->btn, "elm,action,unfocus", "elm");
89 evas_object_focus_set(wd->btn, EINA_FALSE);
94 _theme_hook(Evas_Object *obj)
96 Widget_Data *wd = elm_widget_data_get(obj);
99 _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
101 edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
103 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
105 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
107 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
109 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
110 edje_object_part_text_set(wd->btn, "elm.text", wd->label);
111 if (elm_object_disabled_get(obj))
112 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
113 edje_object_message_signal_process(wd->btn);
114 edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
115 str = edje_object_data_get(wd->btn, "focus_highlight");
116 if ((str) && (!strcmp(str, "on")))
117 elm_widget_highlight_in_theme_set(obj, EINA_TRUE);
119 elm_widget_highlight_in_theme_set(obj, EINA_FALSE);
124 _disable_hook(Evas_Object *obj)
126 Widget_Data *wd = elm_widget_data_get(obj);
128 if (elm_widget_disabled_get(obj))
129 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
131 edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
135 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
137 Widget_Data *wd = elm_widget_data_get(obj);
139 edje_object_signal_emit(wd->btn, emission, source);
143 _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)
145 Widget_Data *wd = elm_widget_data_get(obj);
147 edje_object_signal_callback_add(wd->btn, emission, source, func_cb, data);
151 _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)
153 Widget_Data *wd = elm_widget_data_get(obj);
154 edje_object_signal_callback_del_full(wd->btn, emission, source, func_cb,
159 _sizing_eval(Evas_Object *obj)
161 Widget_Data *wd = elm_widget_data_get(obj);
162 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
165 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
166 edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
167 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
168 evas_object_size_hint_min_set(obj, minw, minh);
169 evas_object_size_hint_max_set(obj, maxw, maxh);
173 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
175 Widget_Data *wd = elm_widget_data_get(data);
177 if (obj != wd->icon) return;
182 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
184 Widget_Data *wd = elm_widget_data_get(obj);
185 Evas_Object *sub = event_info;
189 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
190 evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
191 _changed_size_hints, obj);
193 edje_object_message_signal_process(wd->btn);
199 _activate(Evas_Object *obj)
201 Widget_Data *wd = elm_widget_data_get(obj);
205 ecore_timer_del(wd->timer);
208 wd->repeating = EINA_FALSE;
209 evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
210 _signal_unpressed(obj, wd->btn, NULL, NULL); /* safe guard when the theme does not emit the 'unpress' signal */
214 _activate_hook(Evas_Object *obj)
220 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
226 _autorepeat_send(void *data)
228 Widget_Data *wd = elm_widget_data_get(data);
229 if (!wd) return ECORE_CALLBACK_CANCEL;
231 evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
235 return ECORE_CALLBACK_CANCEL;
238 return ECORE_CALLBACK_RENEW;
242 _autorepeat_initial_send(void *data)
244 Widget_Data *wd = elm_widget_data_get(data);
245 if (!wd) return ECORE_CALLBACK_CANCEL;
247 if (wd->timer) ecore_timer_del(wd->timer);
248 wd->repeating = EINA_TRUE;
249 _autorepeat_send(data);
250 wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
252 return ECORE_CALLBACK_CANCEL;
256 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
258 Widget_Data *wd = elm_widget_data_get(data);
261 if ((wd->autorepeat) && (!wd->repeating))
263 if (wd->ar_threshold <= 0.0)
264 _autorepeat_initial_send(data); /* call immediately */
266 wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
271 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
273 Widget_Data *wd = elm_widget_data_get(data);
278 ecore_timer_del(wd->timer);
281 wd->repeating = EINA_FALSE;
282 evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
286 * Add a new button to the parent
287 * @param parent The parent object
288 * @return The new object or NULL if it cannot be created
293 elm_button_add(Evas_Object *parent)
299 wd = ELM_NEW(Widget_Data);
300 e = evas_object_evas_get(parent);
301 obj = elm_widget_add(e);
302 ELM_SET_WIDTYPE(widtype, "button");
303 elm_widget_type_set(obj, "button");
304 elm_widget_sub_object_add(parent, obj);
305 elm_widget_on_focus_hook_set( obj, _on_focus_hook, NULL );
306 elm_widget_data_set(obj, wd);
307 elm_widget_del_hook_set(obj, _del_hook);
308 elm_widget_theme_hook_set(obj, _theme_hook);
309 elm_widget_disable_hook_set(obj, _disable_hook);
310 elm_widget_can_focus_set(obj, EINA_TRUE);
311 elm_widget_activate_hook_set(obj, _activate_hook);
312 elm_widget_event_hook_set(obj, _event_hook);
313 elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
314 elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
315 elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
317 wd->btn = edje_object_add(e);
318 _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
319 edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
320 _signal_clicked, obj);
321 edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
322 _signal_pressed, obj);
323 edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
324 _signal_unpressed, obj);
325 elm_widget_resize_object_set(obj, wd->btn);
327 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
331 // TODO: convert Elementary to subclassing of Evas_Smart_Class
332 // TODO: and save some bytes, making descriptions per-class and not instance!
333 evas_object_smart_callbacks_descriptions_set(obj, _signals);
338 * Set the label used in the button
340 * @param obj The button object
341 * @param label The text will be written on the button
346 elm_button_label_set(Evas_Object *obj, const char *label)
348 ELM_CHECK_WIDTYPE(obj, widtype);
349 Widget_Data *wd = elm_widget_data_get(obj);
351 eina_stringshare_replace(&wd->label, label);
353 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
355 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
356 edje_object_message_signal_process(wd->btn);
357 edje_object_part_text_set(wd->btn, "elm.text", label);
362 elm_button_label_get(const Evas_Object *obj)
364 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
365 Widget_Data *wd = elm_widget_data_get(obj);
366 if (!wd) return NULL;
371 * Set the icon used for the button
373 * Once the icon object is set, a previously set one will be deleted
374 * If you want to keep that old content object, use the
375 * elm_button_icon_unset() function.
377 * @param obj The button object
378 * @param icon The icon object for the button
383 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
385 ELM_CHECK_WIDTYPE(obj, widtype);
386 Widget_Data *wd = elm_widget_data_get(obj);
388 if (wd->icon == icon) return;
389 if (wd->icon) evas_object_del(wd->icon);
393 elm_widget_sub_object_add(obj, icon);
394 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
395 _changed_size_hints, obj);
396 edje_object_part_swallow(wd->btn, "elm.swallow.content", icon);
397 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
398 edje_object_message_signal_process(wd->btn);
404 * Get the icon used for the button
406 * Return the icon object which is set for this widget.
408 * @param obj The button object
409 * @return The icon object that is being used
414 elm_button_icon_get(const Evas_Object *obj)
416 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
417 Widget_Data *wd = elm_widget_data_get(obj);
418 if (!wd) return NULL;
423 * Unset the icon used for the button
425 * Unparent and return the icon object which was set for this widget.
427 * @param obj The button object
428 * @return The icon object that was being used
433 elm_button_icon_unset(Evas_Object *obj)
435 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
436 Widget_Data *wd = elm_widget_data_get(obj);
437 if (!wd) return NULL;
438 if (!wd->icon) return NULL;
439 Evas_Object *icon = wd->icon;
440 elm_widget_sub_object_del(obj, wd->icon);
441 edje_object_part_unswallow(wd->btn, wd->icon);
447 * Turn on/off the autorepeat event generated when the user keeps pressing on the button
449 * @param obj The button object
450 * @param on A bool to turn on/off the event
455 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
457 ELM_CHECK_WIDTYPE(obj, widtype);
458 Widget_Data *wd = elm_widget_data_get(obj);
462 ecore_timer_del(wd->timer);
466 wd->repeating = EINA_FALSE;
470 * Get if autorepeat event is on
472 * @param obj The button object
473 * @return If autorepeat is on
478 elm_button_autorepeat_get(const Evas_Object *obj)
480 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
481 Widget_Data *wd = elm_widget_data_get(obj);
482 if (!wd) return EINA_FALSE;
483 return wd->autorepeat;
487 * Set the initial timeout before the autorepeat event is generated
489 * @param obj The button object
495 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
497 ELM_CHECK_WIDTYPE(obj, widtype);
498 Widget_Data *wd = elm_widget_data_get(obj);
500 if (wd->ar_threshold == t) return;
503 ecore_timer_del(wd->timer);
506 wd->ar_threshold = t;
510 * Get the initial timeout before the autorepeat event is generated
512 * @param obj The button object
518 elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj)
520 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
521 Widget_Data *wd = elm_widget_data_get(obj);
523 return wd->ar_threshold;
527 * Set the interval between each generated autorepeat event
529 * @param obj The button object
535 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
537 ELM_CHECK_WIDTYPE(obj, widtype);
538 Widget_Data *wd = elm_widget_data_get(obj);
540 if (wd->ar_interval == t) return;
543 if ((wd->repeating) && (wd->timer)) ecore_timer_interval_set(wd->timer, t);
547 * Get the interval between each generated autorepeat event
549 * @param obj The button object
555 elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj)
557 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
558 Widget_Data *wd = elm_widget_data_get(obj);
560 return wd->ar_interval;