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  * Signals that you can add callbacks for are:
  10  *
  11  * changed - This is called whenever the user changes the state of one of the
  12  * check object.
  13  *
  14  * Check objects are a lot like radio objects in layout and functionality
  15  * except they do not work as a group, but independently and only toggle the
  16  * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
  17  * the boolean state (1 for true, 0 for false), and elm_check_state_get()
  18  * returns the current state. For convenience, like the radio objects, you
  19  * can set a pointer to a boolean directly with elm_check_state_pointer_set()
  20  * for it to modify.
  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    EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
 250
 251    wd = ELM_NEW(Widget_Data);
 252    e = evas_object_evas_get(parent);
 253    if (!e) return NULL;
 254    obj = elm_widget_add(e);
 255    ELM_SET_WIDTYPE(widtype, "check");
 256    elm_widget_type_set(obj, "check");
 257    elm_widget_sub_object_add(parent, obj);
 258    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 259    elm_widget_data_set(obj, wd);
 260    elm_widget_del_hook_set(obj, _del_hook);
 261    elm_widget_theme_hook_set(obj, _theme_hook);
 262    elm_widget_disable_hook_set(obj, _disable_hook);
 263    elm_widget_can_focus_set(obj, EINA_TRUE);
 264    elm_widget_activate_hook_set(obj, _activate_hook);
 265    elm_widget_event_hook_set(obj, _event_hook);
 266
 267    wd->chk = edje_object_add(e);
 268    _elm_theme_object_set(obj, wd->chk, "check", "base", "default");
 269    edje_object_signal_callback_add(wd->chk, "elm,action,check,on", "",
 270                                    _signal_check_on, obj);
 271    edje_object_signal_callback_add(wd->chk, "elm,action,check,off", "",
 272                                    _signal_check_off, obj);
 273    edje_object_signal_callback_add(wd->chk, "elm,action,check,toggle", "",
 274                                    _signal_check_toggle, obj);
 275    elm_widget_resize_object_set(obj, wd->chk);
 276
 277    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 278
 279    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 280    _sizing_eval(obj);
 281
 282    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 283    // TODO: and save some bytes, making descriptions per-class and not instance!
 284    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 285    return obj;
 286 }
 287
 288 /**
 289  * Set the text label of the check object
 290  *
 291  * @param obj The check object
 292  * @param label The text label string in UTF-8
 293  *
 294  * @ingroup Check
 295  */
 296 EAPI void
 297 elm_check_label_set(Evas_Object *obj, const char *label)
 298 {
 299    ELM_CHECK_WIDTYPE(obj, widtype);
 300    Widget_Data *wd = elm_widget_data_get(obj);
 301    if (!wd) return;
 302    eina_stringshare_replace(&wd->label, label);
 303    if (label)
 304      edje_object_signal_emit(wd->chk, "elm,state,text,visible", "elm");
 305    else
 306      edje_object_signal_emit(wd->chk, "elm,state,text,hidden", "elm");
 307    edje_object_message_signal_process(wd->chk);
 308    edje_object_part_text_set(wd->chk, "elm.text", label);
 309    _sizing_eval(obj);
 310 }
 311
 312 /**
 313  * Get the text label of the check object
 314  *
 315  * @param obj The check object
 316  * @return The text label string in UTF-8
 317  *
 318  * @ingroup Check
 319  */
 320 EAPI const char *
 321 elm_check_label_get(const Evas_Object *obj)
 322 {
 323    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 324    Widget_Data *wd = elm_widget_data_get(obj);
 325    if (!wd) return NULL;
 326    return wd->label;
 327 }
 328
 329 /**
 330  * Set the icon object of the check object
 331  *
 332  * Once the icon object is set, a previously set one will be deleted.
 333  * If you want to keep that old content object, use the
 334  * elm_check_icon_unset() function.
 335  *
 336  * @param obj The check object
 337  * @param icon The icon object
 338  *
 339  * @ingroup Check
 340  */
 341 EAPI void
 342 elm_check_icon_set(Evas_Object *obj, Evas_Object *icon)
 343 {
 344    ELM_CHECK_WIDTYPE(obj, widtype);
 345    Widget_Data *wd = elm_widget_data_get(obj);
 346    if (!wd) return;
 347    if (wd->icon == icon) return;
 348    if (wd->icon) evas_object_del(wd->icon);
 349    wd->icon = icon;
 350    if (icon)
 351      {
 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->chk, "elm.swallow.content", icon);
 356         edje_object_signal_emit(wd->chk, "elm,state,icon,visible", "elm");
 357         edje_object_message_signal_process(wd->chk);
 358      }
 359    _sizing_eval(obj);
 360 }
 361
 362 /**
 363  * Get the icon object of the check object
 364  *
 365  * @param obj The check object
 366  * @return The icon object
 367  *
 368  * @ingroup Check
 369  */
 370 EAPI Evas_Object *
 371 elm_check_icon_get(const Evas_Object *obj)
 372 {
 373    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 374    Widget_Data *wd = elm_widget_data_get(obj);
 375    if (!wd) return NULL;
 376    return wd->icon;
 377 }
 378
 379 /**
 380  * Unset the icon used for the check object
 381  *
 382  * Unparent and return the icon object which was set for this widget.
 383  *
 384  * @param obj The check object
 385  * @return The icon object that was being used
 386  *
 387  * @ingroup Check
 388  */
 389 EAPI Evas_Object *
 390 elm_check_icon_unset(Evas_Object *obj)
 391 {
 392    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 393    Widget_Data *wd = elm_widget_data_get(obj);
 394    if (!wd) return NULL;
 395    if (!wd->icon) return NULL;
 396    Evas_Object *icon = wd->icon;
 397    elm_widget_sub_object_del(obj, wd->icon);
 398    edje_object_part_unswallow(wd->chk, wd->icon);
 399    wd->icon = NULL;
 400    return icon;
 401 }
 402
 403 /**
 404  * Set the on/off state of the check object
 405  *
 406  * This sets the state of the check and will also set the value if pointed to
 407  * to the state supplied, but will not call any callbacks.
 408  *
 409  * @param obj The check object
 410  * @param state The state to use (1 == on, 0 == off)
 411  *
 412  * @ingroup Check
 413  */
 414 EAPI void
 415 elm_check_state_set(Evas_Object *obj, Eina_Bool state)
 416 {
 417    ELM_CHECK_WIDTYPE(obj, widtype);
 418    Widget_Data *wd = elm_widget_data_get(obj);
 419    if (!wd) return;
 420    if (state != wd->state)
 421      {
 422         wd->state = state;
 423         if (wd->statep) *wd->statep = wd->state;
 424         if (wd->state)
 425           edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 426         else
 427           edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 428      }
 429 }
 430
 431 /**
 432  * Get the state of the check object
 433  *
 434  * @param obj The check object
 435  * @return The boolean state
 436  *
 437  * @ingroup Check
 438  */
 439 EAPI Eina_Bool
 440 elm_check_state_get(const Evas_Object *obj)
 441 {
 442    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 443    Widget_Data *wd = elm_widget_data_get(obj);
 444    if (!wd) return EINA_FALSE;
 445    return wd->state;
 446 }
 447
 448 /**
 449  * Set a convenience pointer to a boolean to change
 450  *
 451  * This sets a pointer to a boolean, that, in addition to the check objects
 452  * state will also be modified directly. To stop setting the object pointed
 453  * to simply use NULL as the statep parameter. If statep is not NULL, then
 454  * when this is called, the check objects state will also be modified to
 455  * reflect the value of the boolean statep points to, just like calling
 456  * elm_check_state_set().
 457  *
 458  * @param obj The check object
 459  * @param statep Pointer to the boolean to modify
 460  *
 461  * @ingroup Check
 462  */
 463 EAPI void
 464 elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep)
 465 {
 466    ELM_CHECK_WIDTYPE(obj, widtype);
 467    Widget_Data *wd = elm_widget_data_get(obj);
 468    if (!wd) return;
 469    if (statep)
 470      {
 471         wd->statep = statep;
 472         if (*wd->statep != wd->state)
 473           {
 474              wd->state = *wd->statep;
 475              if (wd->state)
 476                edje_object_signal_emit(wd->chk, "elm,state,check,on", "elm");
 477              else
 478                edje_object_signal_emit(wd->chk, "elm,state,check,off", "elm");
 479           }
 480      }
 481    else
 482      wd->statep = NULL;
 483 }