src/lib/elm_check.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 /**
   5  * @defgroup Check Check
   6  *
   7  * The check widget allows for toggling a value between true or false (1 or 0).
   8  *
   9  * Check objects are a lot like radio objects in layout and functionality
  10  * except they do not work as a group, but independently and only toggle the
  11  * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
  12  * the boolean state (1 for true, 0 for false), and elm_check_state_get()
  13  * returns the current state. For convenience, like the radio objects, you
  14  * can set a pointer to a boolean directly with elm_check_state_pointer_set()
  15  * for it to modify.
  16  *
  17  * Signals that you can add callbacks for are:
  18  *
  19  * "changed" - This is called whenever the user changes the state of one of the
  20  *             check object.
  21  */
  22 typedef struct _Widget_Data Widget_Data;
  23
  24 struct _Widget_Data
  25 {
  26    Evas_Object *chk, *icon;
  27    Eina_Bool state;
  28    Eina_Bool *statep;
  29    const char *label;
  30 };
  31
  32 static const char *widtype = NULL;
  33 static void _del_hook(Evas_Object *obj);
  34 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
  35 static void _theme_hook(Evas_Object *obj);
  36 static void _disable_hook(Evas_Object *obj);
  37 static void _sizing_eval(Evas_Object *obj);
  38 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
  39 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  40 static void _signal_check_off(void *data, Evas_Object *obj, const char *emission, const char *source);
  41 static void _signal_check_on(void *data, Evas_Object *obj, const char *emission, const char *source);
  42 static void _signal_check_toggle(void *data, Evas_Object *obj, const char *emission, const char *source);
  43 static void _on_focus_hook(void *data, Evas_Object *obj);
  44 static void _activate_hook(Evas_Object *obj);
  45 static void _activate(Evas_Object *obj);
  46 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
  47                              Evas_Callback_Type type, void *event_info);
  48
  49 static const char SIG_CHANGED[] = "changed";
  50 static const Evas_Smart_Cb_Description _signals[] = {
  51        {SIG_CHANGED, ""},
  52        {NULL, NULL}
  53 };
  54
  55 static Eina_Bool
  56 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
  57 {
  58    if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
  59    Evas_Event_Key_Down *ev = event_info;
  60    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
  61    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
  62    if ((strcmp(ev->keyname, "Return")) &&
  63        (strcmp(ev->keyname, "KP_Enter")) &&
  64        (strcmp(ev->keyname, "space")))
  65      return EINA_FALSE;
  66    _activate(obj);
  67    ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
  68    return EINA_TRUE;
  69 }
  70
  71
  72 static void
  73 _del_hook(Evas_Object *obj)
  74 {
  75    Widget_Data *wd = elm_widget_data_get(obj);
  76    if (!wd) return;
  77    if (wd->label) eina_stringshare_del(wd->label);
  78    free(wd);
  79 }
  80
  81 static void
  82 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
  83 {
  84    Widget_Data *wd = elm_widget_data_get(obj);
  85    if (!wd) return;
  86    if (elm_widget_focus_get(obj))
  87      {
  88         edje_object_signal_emit(wd->chk, "elm,action,focus", "elm");
  89         evas_object_focus_set(wd->chk, EINA_TRUE);
  90      }
  91    else
  92      {
  93         edje_object_signal_emit(wd->chk, "elm,action,unfocus", "elm");
  94         evas_object_focus_set(wd->chk, EINA_FALSE);
  95      }
  96 }
  97
  98 static void
  99 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
 100 {
 101    Widget_Data *wd = elm_widget_data_get(obj);
 102    if (!wd) return;
 103    edje_object_mirrored_set(wd->chk, rtl);
 104 }
 105
 106 static void
 107 _theme_hook(Evas_Object *obj)
 108 {
 109    Widget_Data *wd = elm_widget_data_get(obj);
 110    if (!wd) return;
 111    _elm_widget_mirrored_reload(obj);
 112    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 113    _elm_theme_object_set(obj, wd->chk, "check", "base", elm_widget_style_get(obj));
 114    if (wd->icon)
 115      edje_object_signal_emit(wd->chk, "elm,state,icon,visible", "elm");
 116    else
 117      edje_object_signal_emit(wd->chk, "elm,state,icon,hidden", "elm");
 118    if (wd->state)
 119      edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 120    else
 121      edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 122    if (wd->label)
 123      edje_object_signal_emit(wd->chk, "elm,state,text,visible", "elm");
 124    else
 125      edje_object_signal_emit(wd->chk, "elm,state,text,hidden", "elm");
 126    edje_object_part_text_set(wd->chk, "elm.text", wd->label);
 127    if (elm_widget_disabled_get(obj))
 128      edje_object_signal_emit(wd->chk, "elm,state,disabled", "elm");
 129    edje_object_message_signal_process(wd->chk);
 130    edje_object_scale_set(wd->chk, elm_widget_scale_get(obj) * _elm_config->scale);
 131    _sizing_eval(obj);
 132 }
 133
 134 static void
 135 _disable_hook(Evas_Object *obj)
 136 {
 137    Widget_Data *wd = elm_widget_data_get(obj);
 138    if (!wd) return;
 139    if (elm_widget_disabled_get(obj))
 140      edje_object_signal_emit(wd->chk, "elm,state,disabled", "elm");
 141    else
 142      edje_object_signal_emit(wd->chk, "elm,state,enabled", "elm");
 143 }
 144
 145 static void
 146 _sizing_eval(Evas_Object *obj)
 147 {
 148    Widget_Data *wd = elm_widget_data_get(obj);
 149    Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
 150    if (!wd) return;
 151    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 152    edje_object_size_min_restricted_calc(wd->chk, &minw, &minh, minw, minh);
 153    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 154    evas_object_size_hint_min_set(obj, minw, minh);
 155    evas_object_size_hint_max_set(obj, maxw, maxh);
 156 }
 157
 158 static void
 159 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 160 {
 161    Widget_Data *wd = elm_widget_data_get(data);
 162    if (!wd) return;
 163    if (obj != wd->icon) return;
 164    Evas_Coord mw, mh;
 165    evas_object_size_hint_min_get(obj, &mw, &mh);
 166    _sizing_eval(data);
 167 }
 168
 169 static void
 170 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 171 {
 172    Widget_Data *wd = elm_widget_data_get(obj);
 173    Evas_Object *sub = event_info;
 174    if (!wd) return;
 175    if (sub == wd->icon)
 176      {
 177         edje_object_signal_emit(wd->chk, "elm,state,icon,hidden", "elm");
 178         evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 179                                             _changed_size_hints, obj);
 180         wd->icon = NULL;
 181         _sizing_eval(obj);
 182         edje_object_message_signal_process(wd->chk);
 183      }
 184 }
 185
 186 static void
 187 _signal_check_off(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 188 {
 189    Widget_Data *wd = elm_widget_data_get(data);
 190    if (!wd) return;
 191    wd->state = EINA_FALSE;
 192    if (wd->statep) *wd->statep = wd->state;
 193    edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 194    evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
 195 }
 196
 197 static void
 198 _signal_check_on(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 199 {
 200    Widget_Data *wd = elm_widget_data_get(data);
 201    if (!wd) return;
 202    wd->state = EINA_TRUE;
 203    if (wd->statep) *wd->statep = wd->state;
 204    edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 205    evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
 206 }
 207
 208 static void
 209 _signal_check_toggle(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 210 {
 211    _activate(data);
 212 }
 213
 214 static void
 215 _activate_hook(Evas_Object *obj)
 216 {
 217    _activate(obj);
 218 }
 219
 220 static void
 221 _activate(Evas_Object *obj)
 222 {
 223    Widget_Data *wd = elm_widget_data_get(obj);
 224    if (!wd) return;
 225    wd->state = !wd->state;
 226    if (wd->statep) *wd->statep = wd->state;
 227    if (wd->state)
 228      edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 229    else
 230      edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 231    evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
 232 }
 233
 234 /**
 235  * Add a new Check object
 236  *
 237  * @param parent The parent object
 238  * @return The new object or NULL if it cannot be created
 239  *
 240  * @ingroup Check
 241  */
 242 EAPI Evas_Object *
 243 elm_check_add(Evas_Object *parent)
 244 {
 245    Evas_Object *obj;
 246    Evas *e;
 247    Widget_Data *wd;
 248
 249    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
 250
 251    ELM_SET_WIDTYPE(widtype, "check");
 252    elm_widget_type_set(obj, "check");
 253    elm_widget_sub_object_add(parent, obj);
 254    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 255    elm_widget_data_set(obj, wd);
 256    elm_widget_del_hook_set(obj, _del_hook);
 257    elm_widget_theme_hook_set(obj, _theme_hook);
 258    elm_widget_disable_hook_set(obj, _disable_hook);
 259    elm_widget_can_focus_set(obj, EINA_TRUE);
 260    elm_widget_activate_hook_set(obj, _activate_hook);
 261    elm_widget_event_hook_set(obj, _event_hook);
 262
 263    wd->chk = edje_object_add(e);
 264    _elm_theme_object_set(obj, wd->chk, "check", "base", "default");
 265    edje_object_signal_callback_add(wd->chk, "elm,action,check,on", "",
 266                                    _signal_check_on, obj);
 267    edje_object_signal_callback_add(wd->chk, "elm,action,check,off", "",
 268                                    _signal_check_off, obj);
 269    edje_object_signal_callback_add(wd->chk, "elm,action,check,toggle", "",
 270                                    _signal_check_toggle, obj);
 271    elm_widget_resize_object_set(obj, wd->chk);
 272
 273    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 274
 275    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 276    _sizing_eval(obj);
 277
 278    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 279    // TODO: and save some bytes, making descriptions per-class and not instance!
 280    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 281    return obj;
 282 }
 283
 284 /**
 285  * Set the text label of the check object
 286  *
 287  * @param obj The check object
 288  * @param label The text label string in UTF-8
 289  *
 290  * @ingroup Check
 291  */
 292 EAPI void
 293 elm_check_label_set(Evas_Object *obj, const char *label)
 294 {
 295    ELM_CHECK_WIDTYPE(obj, widtype);
 296    Widget_Data *wd = elm_widget_data_get(obj);
 297    if (!wd) return;
 298    eina_stringshare_replace(&wd->label, label);
 299    if (label)
 300      edje_object_signal_emit(wd->chk, "elm,state,text,visible", "elm");
 301    else
 302      edje_object_signal_emit(wd->chk, "elm,state,text,hidden", "elm");
 303    edje_object_message_signal_process(wd->chk);
 304    edje_object_part_text_set(wd->chk, "elm.text", label);
 305    _sizing_eval(obj);
 306 }
 307
 308 /**
 309  * Get the text label of the check object
 310  *
 311  * @param obj The check object
 312  * @return The text label string in UTF-8
 313  *
 314  * @ingroup Check
 315  */
 316 EAPI const char *
 317 elm_check_label_get(const Evas_Object *obj)
 318 {
 319    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 320    Widget_Data *wd = elm_widget_data_get(obj);
 321    if (!wd) return NULL;
 322    return wd->label;
 323 }
 324
 325 /**
 326  * Set the icon object of the check object
 327  *
 328  * Once the icon object is set, a previously set one will be deleted.
 329  * If you want to keep that old content object, use the
 330  * elm_check_icon_unset() function.
 331  *
 332  * @param obj The check object
 333  * @param icon The icon object
 334  *
 335  * @ingroup Check
 336  */
 337 EAPI void
 338 elm_check_icon_set(Evas_Object *obj, Evas_Object *icon)
 339 {
 340    ELM_CHECK_WIDTYPE(obj, widtype);
 341    Widget_Data *wd = elm_widget_data_get(obj);
 342    if (!wd) return;
 343    if (wd->icon == icon) return;
 344    if (wd->icon) evas_object_del(wd->icon);
 345    wd->icon = icon;
 346    if (icon)
 347      {
 348         elm_widget_sub_object_add(obj, icon);
 349         evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 350                                        _changed_size_hints, obj);
 351         edje_object_part_swallow(wd->chk, "elm.swallow.content", icon);
 352         edje_object_signal_emit(wd->chk, "elm,state,icon,visible", "elm");
 353         edje_object_message_signal_process(wd->chk);
 354      }
 355    _sizing_eval(obj);
 356 }
 357
 358 /**
 359  * Get the icon object of the check object
 360  *
 361  * @param obj The check object
 362  * @return The icon object
 363  *
 364  * @ingroup Check
 365  */
 366 EAPI Evas_Object *
 367 elm_check_icon_get(const Evas_Object *obj)
 368 {
 369    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 370    Widget_Data *wd = elm_widget_data_get(obj);
 371    if (!wd) return NULL;
 372    return wd->icon;
 373 }
 374
 375 /**
 376  * Unset the icon used for the check object
 377  *
 378  * Unparent and return the icon object which was set for this widget.
 379  *
 380  * @param obj The check object
 381  * @return The icon object that was being used
 382  *
 383  * @ingroup Check
 384  */
 385 EAPI Evas_Object *
 386 elm_check_icon_unset(Evas_Object *obj)
 387 {
 388    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 389    Widget_Data *wd = elm_widget_data_get(obj);
 390    if (!wd) return NULL;
 391    if (!wd->icon) return NULL;
 392    Evas_Object *icon = wd->icon;
 393    elm_widget_sub_object_del(obj, wd->icon);
 394    edje_object_part_unswallow(wd->chk, wd->icon);
 395    wd->icon = NULL;
 396    return icon;
 397 }
 398
 399 /**
 400  * Set the on/off state of the check object
 401  *
 402  * This sets the state of the check and will also set the value if pointed to
 403  * to the state supplied, but will not call any callbacks.
 404  *
 405  * @param obj The check object
 406  * @param state The state to use (1 == on, 0 == off)
 407  *
 408  * @ingroup Check
 409  */
 410 EAPI void
 411 elm_check_state_set(Evas_Object *obj, Eina_Bool state)
 412 {
 413    ELM_CHECK_WIDTYPE(obj, widtype);
 414    Widget_Data *wd = elm_widget_data_get(obj);
 415    if (!wd) return;
 416    if (state != wd->state)
 417      {
 418         wd->state = state;
 419         if (wd->statep) *wd->statep = wd->state;
 420         if (wd->state)
 421           edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 422         else
 423           edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 424      }
 425 }
 426
 427 /**
 428  * Get the state of the check object
 429  *
 430  * @param obj The check object
 431  * @return The boolean state
 432  *
 433  * @ingroup Check
 434  */
 435 EAPI Eina_Bool
 436 elm_check_state_get(const Evas_Object *obj)
 437 {
 438    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 439    Widget_Data *wd = elm_widget_data_get(obj);
 440    if (!wd) return EINA_FALSE;
 441    return wd->state;
 442 }
 443
 444 /**
 445  * Set a convenience pointer to a boolean to change
 446  *
 447  * This sets a pointer to a boolean, that, in addition to the check objects
 448  * state will also be modified directly. To stop setting the object pointed
 449  * to simply use NULL as the statep parameter. If statep is not NULL, then
 450  * when this is called, the check objects state will also be modified to
 451  * reflect the value of the boolean statep points to, just like calling
 452  * elm_check_state_set().
 453  *
 454  * @param obj The check object
 455  * @param statep Pointer to the boolean to modify
 456  *
 457  * @ingroup Check
 458  */
 459 EAPI void
 460 elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep)
 461 {
 462    ELM_CHECK_WIDTYPE(obj, widtype);
 463    Widget_Data *wd = elm_widget_data_get(obj);
 464    if (!wd) return;
 465    if (statep)
 466      {
 467         wd->statep = statep;
 468         if (*wd->statep != wd->state)
 469           {
 470              wd->state = *wd->statep;
 471              if (wd->state)
 472                edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 473              else
 474                edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 475           }
 476      }
 477    else
 478      wd->statep = NULL;
 479 }