1 #include <Elementary.h>
5 * @defgroup Check Check
8 * The check widget allows for toggling a value between true or false (1 or 0).
10 * Check objects are a lot like radio objects in layout and functionality
11 * except they do not work as a group, but independently and only toggle the
12 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
13 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
14 * returns the current state. For convenience, like the radio objects, you
15 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18 * Signals that you can add callbacks for are:
20 * "changed" - This is called whenever the user changes the state of one of the
23 typedef struct _Widget_Data Widget_Data;
27 Evas_Object *chk, *icon;
33 static const char *widtype = NULL;
34 static void _del_hook(Evas_Object *obj);
35 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
36 static void _theme_hook(Evas_Object *obj);
37 static void _disable_hook(Evas_Object *obj);
38 static void _sizing_eval(Evas_Object *obj);
39 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
40 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
41 static void _signal_check_off(void *data, Evas_Object *obj, const char *emission, const char *source);
42 static void _signal_check_on(void *data, Evas_Object *obj, const char *emission, const char *source);
43 static void _signal_check_toggle(void *data, Evas_Object *obj, const char *emission, const char *source);
44 static void _on_focus_hook(void *data, Evas_Object *obj);
45 static void _activate_hook(Evas_Object *obj);
46 static void _activate(Evas_Object *obj);
47 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
48 Evas_Callback_Type type, void *event_info);
50 static const char SIG_CHANGED[] = "changed";
51 static const Evas_Smart_Cb_Description _signals[] = {
57 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
59 if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
60 Evas_Event_Key_Down *ev = event_info;
61 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
62 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
63 if ((strcmp(ev->keyname, "Return")) &&
64 (strcmp(ev->keyname, "KP_Enter")) &&
65 (strcmp(ev->keyname, "space")))
68 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
74 _del_hook(Evas_Object *obj)
76 Widget_Data *wd = elm_widget_data_get(obj);
78 if (wd->label) eina_stringshare_del(wd->label);
83 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
85 Widget_Data *wd = elm_widget_data_get(obj);
87 if (elm_widget_focus_get(obj))
89 edje_object_signal_emit(wd->chk, "elm,action,focus", "elm");
90 evas_object_focus_set(wd->chk, EINA_TRUE);
94 edje_object_signal_emit(wd->chk, "elm,action,unfocus", "elm");
95 evas_object_focus_set(wd->chk, EINA_FALSE);
100 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
102 Widget_Data *wd = elm_widget_data_get(obj);
104 edje_object_mirrored_set(wd->chk, rtl);
108 _theme_hook(Evas_Object *obj)
110 unsigned int counter = 0;
112 unsigned int length = 0;
115 char buffer[PATH_MAX]={'\0',};
116 char s1[PATH_MAX] = {'\0',};
117 Widget_Data *wd = elm_widget_data_get(obj);
120 _elm_widget_mirrored_reload(obj);
121 _mirrored_set(obj, elm_widget_mirrored_get(obj));
122 _elm_theme_object_set(obj, wd->chk, "check", "base", elm_widget_style_get(obj));
124 edje_object_signal_emit(wd->chk, "elm,state,icon,visible", "elm");
126 edje_object_signal_emit(wd->chk, "elm,state,icon,hidden", "elm");
128 edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
130 edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
132 edje_object_signal_emit(wd->chk, "elm,state,text,visible", "elm");
134 edje_object_signal_emit(wd->chk, "elm,state,text,hidden", "elm");
135 edje_object_part_text_set(wd->chk, "elm.text", wd->label);
136 if (elm_widget_disabled_get(obj))
137 edje_object_signal_emit(wd->chk, "elm,state,disabled", "elm");
138 edje_object_message_signal_process(wd->chk);
139 edje_object_scale_set(wd->chk, elm_widget_scale_get(obj) * _elm_config->scale);
141 //introduced internationalization of additional text parts used in style
144 // s1 is used to store part name while buffer is used to store the part's value string
145 snprintf(labels,sizeof(labels),"label_%d",i++);
146 str = edje_object_data_get(wd->chk,labels);
148 length = strlen(str);
149 while ((str[counter]!= ' ') && (counter < length))
151 if (counter == length)
153 strncpy(s1, str, counter);
155 strncpy(buffer, str + counter, sizeof(buffer));
156 edje_object_part_text_set(wd->chk, s1, E_(buffer));
162 _disable_hook(Evas_Object *obj)
164 Widget_Data *wd = elm_widget_data_get(obj);
166 if (elm_widget_disabled_get(obj))
167 edje_object_signal_emit(wd->chk, "elm,state,disabled", "elm");
169 edje_object_signal_emit(wd->chk, "elm,state,enabled", "elm");
173 _sizing_eval(Evas_Object *obj)
175 Widget_Data *wd = elm_widget_data_get(obj);
176 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
178 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
179 edje_object_size_min_restricted_calc(wd->chk, &minw, &minh, minw, minh);
180 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
181 evas_object_size_hint_min_set(obj, minw, minh);
182 evas_object_size_hint_max_set(obj, maxw, maxh);
186 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
188 Widget_Data *wd = elm_widget_data_get(data);
190 if (obj != wd->icon) return;
192 evas_object_size_hint_min_get(obj, &mw, &mh);
197 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
199 Widget_Data *wd = elm_widget_data_get(obj);
200 Evas_Object *sub = event_info;
204 edje_object_signal_emit(wd->chk, "elm,state,icon,hidden", "elm");
205 evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
206 _changed_size_hints, obj);
209 edje_object_message_signal_process(wd->chk);
214 _signal_check_off(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
216 Widget_Data *wd = elm_widget_data_get(data);
218 wd->state = EINA_FALSE;
219 if (wd->statep) *wd->statep = wd->state;
220 edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
221 evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
225 _signal_check_on(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
227 Widget_Data *wd = elm_widget_data_get(data);
229 wd->state = EINA_TRUE;
230 if (wd->statep) *wd->statep = wd->state;
231 edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
232 evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
236 _signal_check_toggle(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
242 _activate_hook(Evas_Object *obj)
248 _activate(Evas_Object *obj)
250 Widget_Data *wd = elm_widget_data_get(obj);
252 wd->state = !wd->state;
253 if (wd->statep) *wd->statep = wd->state;
255 edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
257 edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
258 evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
262 _elm_check_label_set(Evas_Object *obj, const char *item, const char *label)
264 ELM_CHECK_WIDTYPE(obj, widtype);
265 Widget_Data *wd = elm_widget_data_get(obj);
268 eina_stringshare_replace(&wd->label, label);
270 edje_object_signal_emit(wd->chk, "elm,state,text,visible", "elm");
272 edje_object_signal_emit(wd->chk, "elm,state,text,hidden", "elm");
273 edje_object_message_signal_process(wd->chk);
274 edje_object_part_text_set(wd->chk, "elm.text", label);
279 _elm_check_label_get(const Evas_Object *obj, const char *item)
281 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
282 Widget_Data *wd = elm_widget_data_get(obj);
283 if (item) return NULL;
284 if (!wd) return NULL;
289 * Add a new Check object
291 * @param parent The parent object
292 * @return The new object or NULL if it cannot be created
297 elm_check_add(Evas_Object *parent)
303 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
305 ELM_SET_WIDTYPE(widtype, "check");
306 elm_widget_type_set(obj, "check");
307 elm_widget_sub_object_add(parent, obj);
308 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
309 elm_widget_data_set(obj, wd);
310 elm_widget_del_hook_set(obj, _del_hook);
311 elm_widget_theme_hook_set(obj, _theme_hook);
312 elm_widget_disable_hook_set(obj, _disable_hook);
313 elm_widget_can_focus_set(obj, EINA_TRUE);
314 elm_widget_activate_hook_set(obj, _activate_hook);
315 elm_widget_event_hook_set(obj, _event_hook);
316 elm_widget_text_set_hook_set(obj, _elm_check_label_set);
317 elm_widget_text_get_hook_set(obj, _elm_check_label_get);
319 wd->chk = edje_object_add(e);
320 _elm_theme_object_set(obj, wd->chk, "check", "base", "default");
321 edje_object_signal_callback_add(wd->chk, "elm,action,check,on", "",
322 _signal_check_on, obj);
323 edje_object_signal_callback_add(wd->chk, "elm,action,check,off", "",
324 _signal_check_off, obj);
325 edje_object_signal_callback_add(wd->chk, "elm,action,check,toggle", "",
326 _signal_check_toggle, obj);
327 elm_widget_resize_object_set(obj, wd->chk);
329 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
331 _mirrored_set(obj, elm_widget_mirrored_get(obj));
334 // TODO: convert Elementary to subclassing of Evas_Smart_Class
335 // TODO: and save some bytes, making descriptions per-class and not instance!
336 evas_object_smart_callbacks_descriptions_set(obj, _signals);
341 * Set the text label of the check object
343 * @param obj The check object
344 * @param label The text label string in UTF-8
349 elm_check_label_set(Evas_Object *obj, const char *label)
351 _elm_check_label_set(obj, NULL, label);
355 * Get the text label of the check object
357 * @param obj The check object
358 * @return The text label string in UTF-8
363 elm_check_label_get(const Evas_Object *obj)
365 return _elm_check_label_get(obj, NULL);
369 * Set the icon object of the check object
371 * Once the icon object is set, a previously set one will be deleted.
372 * If you want to keep that old content object, use the
373 * elm_check_icon_unset() function.
375 * @param obj The check object
376 * @param icon The icon object
381 elm_check_icon_set(Evas_Object *obj, Evas_Object *icon)
383 ELM_CHECK_WIDTYPE(obj, widtype);
384 Widget_Data *wd = elm_widget_data_get(obj);
386 if (wd->icon == icon) return;
387 if (wd->icon) evas_object_del(wd->icon);
391 elm_widget_sub_object_add(obj, icon);
392 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
393 _changed_size_hints, obj);
394 edje_object_part_swallow(wd->chk, "elm.swallow.content", icon);
395 edje_object_signal_emit(wd->chk, "elm,state,icon,visible", "elm");
396 edje_object_message_signal_process(wd->chk);
402 * Get the icon object of the check object
404 * @param obj The check object
405 * @return The icon object
410 elm_check_icon_get(const Evas_Object *obj)
412 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
413 Widget_Data *wd = elm_widget_data_get(obj);
414 if (!wd) return NULL;
419 * Unset the icon used for the check object
421 * Unparent and return the icon object which was set for this widget.
423 * @param obj The check object
424 * @return The icon object that was being used
429 elm_check_icon_unset(Evas_Object *obj)
431 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
432 Widget_Data *wd = elm_widget_data_get(obj);
433 if (!wd) return NULL;
434 if (!wd->icon) return NULL;
435 Evas_Object *icon = wd->icon;
436 elm_widget_sub_object_del(obj, wd->icon);
437 edje_object_part_unswallow(wd->chk, wd->icon);
443 * Set the on/off state of the check object
445 * This sets the state of the check and will also set the value if pointed to
446 * to the state supplied, but will not call any callbacks.
448 * @param obj The check object
449 * @param state The state to use (1 == on, 0 == off)
454 elm_check_state_set(Evas_Object *obj, Eina_Bool state)
456 ELM_CHECK_WIDTYPE(obj, widtype);
457 Widget_Data *wd = elm_widget_data_get(obj);
459 if (state != wd->state)
462 if (wd->statep) *wd->statep = wd->state;
464 edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
466 edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
471 * Get the state of the check object
473 * @param obj The check object
474 * @return The boolean state
479 elm_check_state_get(const Evas_Object *obj)
481 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
482 Widget_Data *wd = elm_widget_data_get(obj);
483 if (!wd) return EINA_FALSE;
488 * Set a convenience pointer to a boolean to change
490 * This sets a pointer to a boolean, that, in addition to the check objects
491 * state will also be modified directly. To stop setting the object pointed
492 * to simply use NULL as the statep parameter. If statep is not NULL, then
493 * when this is called, the check objects state will also be modified to
494 * reflect the value of the boolean statep points to, just like calling
495 * elm_check_state_set().
497 * @param obj The check object
498 * @param statep Pointer to the boolean to modify
503 elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep)
505 ELM_CHECK_WIDTYPE(obj, widtype);
506 Widget_Data *wd = elm_widget_data_get(obj);
511 if (*wd->statep != wd->state)
513 wd->state = *wd->statep;
515 edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
517 edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");