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);
98 _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
100 edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
102 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
104 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
106 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
108 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
109 edje_object_part_text_set(wd->btn, "elm.text", wd->label);
110 edje_object_message_signal_process(wd->btn);
111 edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
112 if (elm_object_disabled_get(obj))
113 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
118 _disable_hook(Evas_Object *obj)
120 Widget_Data *wd = elm_widget_data_get(obj);
122 if (elm_widget_disabled_get(obj))
123 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
125 edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
129 _sizing_eval(Evas_Object *obj)
131 Widget_Data *wd = elm_widget_data_get(obj);
132 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
135 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
136 edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
137 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
138 evas_object_size_hint_min_set(obj, minw, minh);
139 evas_object_size_hint_max_set(obj, maxw, maxh);
143 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
145 Widget_Data *wd = elm_widget_data_get(data);
147 if (obj != wd->icon) return;
152 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
154 Widget_Data *wd = elm_widget_data_get(obj);
155 Evas_Object *sub = event_info;
159 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
160 evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
161 _changed_size_hints, obj);
163 edje_object_message_signal_process(wd->btn);
169 _activate(Evas_Object *obj)
171 Widget_Data *wd = elm_widget_data_get(obj);
175 ecore_timer_del(wd->timer);
178 wd->repeating = EINA_FALSE;
179 evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
180 _signal_unpressed(obj, wd->btn, NULL, NULL); /* safe guard when the theme does not emit the 'unpress' signal */
184 _activate_hook(Evas_Object *obj)
190 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
196 _autorepeat_send(void *data)
198 Widget_Data *wd = elm_widget_data_get(data);
199 if (!wd) return ECORE_CALLBACK_CANCEL;
201 evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
205 return ECORE_CALLBACK_CANCEL;
208 return ECORE_CALLBACK_RENEW;
212 _autorepeat_initial_send(void *data)
214 Widget_Data *wd = elm_widget_data_get(data);
215 if (!wd) return ECORE_CALLBACK_CANCEL;
217 if (wd->timer) ecore_timer_del(wd->timer);
218 wd->repeating = EINA_TRUE;
219 _autorepeat_send(data);
220 wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
222 return ECORE_CALLBACK_CANCEL;
226 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
228 Widget_Data *wd = elm_widget_data_get(data);
231 if (wd->autorepeat && !wd->repeating)
233 if (wd->ar_threshold <= 0.0)
234 _autorepeat_initial_send(data); /* call immediately */
236 wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
241 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
243 Widget_Data *wd = elm_widget_data_get(data);
248 ecore_timer_del(wd->timer);
251 wd->repeating = EINA_FALSE;
252 evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
256 * Add a new button to the parent
257 * @param parent The parent object
258 * @return The new object or NULL if it cannot be created
263 elm_button_add(Evas_Object *parent)
269 wd = ELM_NEW(Widget_Data);
270 e = evas_object_evas_get(parent);
271 obj = elm_widget_add(e);
272 ELM_SET_WIDTYPE(widtype, "button");
273 elm_widget_type_set(obj, "button");
274 elm_widget_sub_object_add(parent, obj);
275 elm_widget_on_focus_hook_set( obj, _on_focus_hook, NULL );
276 elm_widget_data_set(obj, wd);
277 elm_widget_del_hook_set(obj, _del_hook);
278 elm_widget_theme_hook_set(obj, _theme_hook);
279 elm_widget_disable_hook_set(obj, _disable_hook);
280 elm_widget_can_focus_set(obj, 1);
281 elm_widget_activate_hook_set(obj, _activate_hook);
282 elm_widget_event_hook_set(obj, _event_hook);
284 wd->btn = edje_object_add(e);
285 _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
286 edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
287 _signal_clicked, obj);
288 edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
289 _signal_pressed, obj);
290 edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
291 _signal_unpressed, obj);
292 elm_widget_resize_object_set(obj, wd->btn);
294 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
298 // TODO: convert Elementary to subclassing of Evas_Smart_Class
299 // TODO: and save some bytes, making descriptions per-class and not instance!
300 evas_object_smart_callbacks_descriptions_set(obj, _signals);
305 * Set the label used in the button
307 * @param obj The button object
308 * @param label The text will be written on the button
313 elm_button_label_set(Evas_Object *obj, const char *label)
315 ELM_CHECK_WIDTYPE(obj, widtype);
316 Widget_Data *wd = elm_widget_data_get(obj);
318 eina_stringshare_replace(&wd->label, label);
320 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
322 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
323 edje_object_message_signal_process(wd->btn);
324 edje_object_part_text_set(wd->btn, "elm.text", label);
329 elm_button_label_get(const Evas_Object *obj)
331 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
332 Widget_Data *wd = elm_widget_data_get(obj);
333 if (!wd) return NULL;
338 * Set the icon used for the button
340 * Once the icon object is set, a previously set one will be deleted
342 * @param obj The button object
343 * @param icon The image for the button
348 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
350 ELM_CHECK_WIDTYPE(obj, widtype);
351 Widget_Data *wd = elm_widget_data_get(obj);
353 if (wd->icon == icon) return;
354 if (wd->icon) evas_object_del(wd->icon);
358 elm_widget_sub_object_add(obj, icon);
359 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
360 _changed_size_hints, obj);
361 edje_object_part_swallow(wd->btn, "elm.swallow.content", icon);
362 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
363 edje_object_message_signal_process(wd->btn);
369 * Get the icon used for the button
371 * @param obj The button object
372 * @return The image for the button
377 elm_button_icon_get(const Evas_Object *obj)
379 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
380 Widget_Data *wd = elm_widget_data_get(obj);
381 if (!wd) return NULL;
386 * Turn on/off the autorepeat event generated when the user keeps pressing on the button
388 * @param obj The button object
389 * @param on A bool to turn on/off the event
394 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
396 ELM_CHECK_WIDTYPE(obj, widtype);
397 Widget_Data *wd = elm_widget_data_get(obj);
401 ecore_timer_del(wd->timer);
405 wd->repeating = EINA_FALSE;
409 * Set the initial timeout before the autorepeat event is generated
411 * @param obj The button object
417 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
419 ELM_CHECK_WIDTYPE(obj, widtype);
420 Widget_Data *wd = elm_widget_data_get(obj);
422 if (wd->ar_threshold == t) return;
425 ecore_timer_del(wd->timer);
428 wd->ar_threshold = t;
432 * Set the interval between each generated autorepeat event
434 * @param obj The button object
440 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
442 ELM_CHECK_WIDTYPE(obj, widtype);
443 Widget_Data *wd = elm_widget_data_get(obj);
445 if (wd->ar_interval == t) return;
448 if (wd->repeating && wd->timer) ecore_timer_interval_set(wd->timer, t);