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 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
56 if (strcmp(ev->keyname, "Return") && strcmp(ev->keyname, "space"))
59 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
64 _del_hook(Evas_Object *obj)
66 Widget_Data *wd = elm_widget_data_get(obj);
68 if (wd->label) eina_stringshare_del(wd->label);
73 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
75 Widget_Data *wd = elm_widget_data_get(obj);
77 if (elm_widget_focus_get(obj))
79 edje_object_signal_emit(wd->btn, "elm,action,focus", "elm");
80 evas_object_focus_set(wd->btn, EINA_TRUE);
84 edje_object_signal_emit(wd->btn, "elm,action,unfocus", "elm");
85 evas_object_focus_set(wd->btn, EINA_FALSE);
90 _theme_hook(Evas_Object *obj)
92 Widget_Data *wd = elm_widget_data_get(obj);
94 _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
96 edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
98 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
100 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
102 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
104 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
105 edje_object_part_text_set(wd->btn, "elm.text", wd->label);
106 edje_object_message_signal_process(wd->btn);
107 edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
112 _disable_hook(Evas_Object *obj)
114 Widget_Data *wd = elm_widget_data_get(obj);
116 if (elm_widget_disabled_get(obj))
117 edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
119 edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
123 _sizing_eval(Evas_Object *obj)
125 Widget_Data *wd = elm_widget_data_get(obj);
126 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
129 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
130 edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
131 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
132 evas_object_size_hint_min_set(obj, minw, minh);
133 evas_object_size_hint_max_set(obj, maxw, maxh);
137 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
139 Widget_Data *wd = elm_widget_data_get(data);
141 if (obj != wd->icon) return;
146 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
148 Widget_Data *wd = elm_widget_data_get(obj);
149 Evas_Object *sub = event_info;
153 edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
154 evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
155 _changed_size_hints, obj);
157 edje_object_message_signal_process(wd->btn);
163 _activate(Evas_Object *obj)
165 Widget_Data *wd = elm_widget_data_get(obj);
169 ecore_timer_del(wd->timer);
172 wd->repeating = EINA_FALSE;
173 evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
174 _signal_unpressed(obj, wd->btn, NULL, NULL); /* safe guard when the theme does not emit the 'unpress' signal */
178 _activate_hook(Evas_Object *obj)
184 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
190 _autorepeat_send(void *data)
192 Widget_Data *wd = elm_widget_data_get(data);
193 if (!wd) return ECORE_CALLBACK_CANCEL;
195 evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
199 return ECORE_CALLBACK_CANCEL;
202 return ECORE_CALLBACK_RENEW;
206 _autorepeat_initial_send(void *data)
208 Widget_Data *wd = elm_widget_data_get(data);
209 if (!wd) return ECORE_CALLBACK_CANCEL;
211 if (wd->timer) ecore_timer_del(wd->timer);
212 wd->repeating = EINA_TRUE;
213 _autorepeat_send(data);
214 wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
216 return ECORE_CALLBACK_CANCEL;
220 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
222 Widget_Data *wd = elm_widget_data_get(data);
225 if (wd->autorepeat && !wd->repeating)
227 if (wd->ar_threshold <= 0.0)
228 _autorepeat_initial_send(data); /* call immediately */
230 wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
235 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
237 Widget_Data *wd = elm_widget_data_get(data);
242 ecore_timer_del(wd->timer);
245 wd->repeating = EINA_FALSE;
246 evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
250 * Add a new button to the parent
251 * @param parent The parent object
252 * @return The new object or NULL if it cannot be created
257 elm_button_add(Evas_Object *parent)
263 wd = ELM_NEW(Widget_Data);
264 e = evas_object_evas_get(parent);
265 obj = elm_widget_add(e);
266 ELM_SET_WIDTYPE(widtype, "button");
267 elm_widget_type_set(obj, "button");
268 elm_widget_sub_object_add(parent, obj);
269 elm_widget_on_focus_hook_set( obj, _on_focus_hook, NULL );
270 elm_widget_data_set(obj, wd);
271 elm_widget_del_hook_set(obj, _del_hook);
272 elm_widget_theme_hook_set(obj, _theme_hook);
273 elm_widget_disable_hook_set(obj, _disable_hook);
274 elm_widget_can_focus_set(obj, 1);
275 elm_widget_activate_hook_set(obj, _activate_hook);
276 elm_widget_event_hook_set(obj, _event_hook);
278 wd->btn = edje_object_add(e);
279 _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
280 edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
281 _signal_clicked, obj);
282 edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
283 _signal_pressed, obj);
284 edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
285 _signal_unpressed, obj);
286 elm_widget_resize_object_set(obj, wd->btn);
288 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
292 // TODO: convert Elementary to subclassing of Evas_Smart_Class
293 // TODO: and save some bytes, making descriptions per-class and not instance!
294 evas_object_smart_callbacks_descriptions_set(obj, _signals);
299 * Set the label used in the button
301 * @param obj The button object
302 * @param label The text will be written on the button
307 elm_button_label_set(Evas_Object *obj, const char *label)
309 ELM_CHECK_WIDTYPE(obj, widtype);
310 Widget_Data *wd = elm_widget_data_get(obj);
312 eina_stringshare_replace(&wd->label, label);
314 edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
316 edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
317 edje_object_message_signal_process(wd->btn);
318 edje_object_part_text_set(wd->btn, "elm.text", label);
323 elm_button_label_get(const Evas_Object *obj)
325 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
326 Widget_Data *wd = elm_widget_data_get(obj);
327 if (!wd) return NULL;
332 * Set the icon used for the button
334 * Once the icon object is set, a previously set one will be deleted
336 * @param obj The button object
337 * @param icon The image for the button
342 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
344 ELM_CHECK_WIDTYPE(obj, widtype);
345 Widget_Data *wd = elm_widget_data_get(obj);
347 if (wd->icon == icon) return;
348 if (wd->icon) evas_object_del(wd->icon);
352 elm_widget_sub_object_add(obj, icon);
353 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
354 _changed_size_hints, obj);
355 edje_object_part_swallow(wd->btn, "elm.swallow.content", icon);
356 edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
357 edje_object_message_signal_process(wd->btn);
363 * Get the icon used for the button
365 * @param obj The button object
366 * @return The image for the button
371 elm_button_icon_get(const Evas_Object *obj)
373 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
374 Widget_Data *wd = elm_widget_data_get(obj);
375 if (!wd) return NULL;
380 * Turn on/off the autorepeat event generated when the user keeps pressing on the button
382 * @param obj The button object
383 * @param on A bool to turn on/off the event
388 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
390 ELM_CHECK_WIDTYPE(obj, widtype);
391 Widget_Data *wd = elm_widget_data_get(obj);
395 ecore_timer_del(wd->timer);
399 wd->repeating = EINA_FALSE;
403 * Set the initial timeout before the autorepeat event is generated
405 * @param obj The button object
411 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
413 ELM_CHECK_WIDTYPE(obj, widtype);
414 Widget_Data *wd = elm_widget_data_get(obj);
416 if (wd->ar_threshold == t) return;
419 ecore_timer_del(wd->timer);
422 wd->ar_threshold = t;
426 * Set the interval between each generated autorepeat event
428 * @param obj The button object
434 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
436 ELM_CHECK_WIDTYPE(obj, widtype);
437 Widget_Data *wd = elm_widget_data_get(obj);
439 if (wd->ar_interval == t) return;
442 if (wd->repeating && wd->timer) ecore_timer_interval_set(wd->timer, t);