src/lib/elm_radio.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 /**
   5  * @defgroup Radio Radio
   6  * @ingroup Elementary
   7  *
   8  * The radio button allows for 1 or more selectors to be created to select 1
   9  * of a set of options.
  10  *
  11  * Signals that you can add callbacks for are:
  12  *
  13  * changed - This is called whenever the user changes the state of one of the
  14  * radio objects within the group of radio objects that work together.
  15  *
  16  * A radio object contains an indicator, an optional Label and an optional
  17  * icon object. They work normally in groups of 2 or more. When you create a
  18  * radio (if it is not the first member of the group), simply add it to the
  19  * group by adding it to any other member of the group that already exists
  20  * (or the first member) with elm_radio_group_add() with the second parameter
  21  * being the existing group member. The radio object(s) will select from one
  22  * of a set of integer values, so any value they are configuring needs to be
  23  * mapped to a set of integers. To configure what value that radio object
  24  * represents, use  elm_radio_state_value_set() to set the integer it
  25  * represents. To set the value the whole group is to indicate use
  26  * elm_radio_value_set() on any group member, and to get the groups value use
  27  * elm_radio_value_get(). For convenience the radio objects are also able to
  28  * directly set an integer (int) to the value that is selected. To specify
  29  * the pointer to this integer to modify, use elm_radio_value_pointer_set().
  30  * The radio objects will modify this directly. That implies the pointer must
  31  * point to valid memory for as long as the radio objects exist.
  32  */
  33
  34 typedef struct _Widget_Data Widget_Data;
  35 typedef struct _Group Group;
  36
  37 struct _Group
  38 {
  39    int value;
  40    int *valuep;
  41    Eina_List *radios;
  42 };
  43
  44 struct _Widget_Data
  45 {
  46    Evas_Object *radio;
  47    Evas_Object *icon;
  48    int value;
  49    const char *label;
  50    Eina_Bool state;
  51    Group *group;
  52 };
  53
  54 static const char *widtype = NULL;
  55 static void _state_set(Evas_Object *obj, Eina_Bool state);
  56 static void _del_hook(Evas_Object *obj);
  57 static void _theme_hook(Evas_Object *obj);
  58 static void _disable_hook(Evas_Object *obj);
  59 static void _sizing_eval(Evas_Object *obj);
  60 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
  61 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  62 static void _signal_radio_on(void *data, Evas_Object *obj, const char *emission, const char *source);
  63 static void _on_focus_hook(void *data, Evas_Object *obj);
  64 static void _activate(Evas_Object *obj);
  65 static void _activate_hook(Evas_Object *obj);
  66 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
  67                              Evas_Callback_Type type, void *event_info);
  68
  69 static const char SIG_CHANGED[] = "changed";
  70 static const Evas_Smart_Cb_Description _signals[] = {
  71   {SIG_CHANGED, ""},
  72   {NULL, NULL}
  73 };
  74
  75 static Eina_Bool
  76 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
  77 {
  78    if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
  79    Evas_Event_Key_Down *ev = event_info;
  80    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
  81    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
  82
  83    if ((strcmp(ev->keyname, "Return")) &&
  84        (strcmp(ev->keyname, "KP_Enter")) &&
  85        (strcmp(ev->keyname, "space")))
  86      return EINA_FALSE;
  87    _activate(obj);
  88    ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
  89    return EINA_TRUE;
  90 }
  91
  92 static void
  93 _del_hook(Evas_Object *obj)
  94 {
  95    Widget_Data *wd = elm_widget_data_get(obj);
  96    if (!wd) return;
  97    if (wd->label) eina_stringshare_del(wd->label);
  98    wd->group->radios = eina_list_remove(wd->group->radios, obj);
  99    if (!wd->group->radios) free(wd->group);
 100    wd->group = NULL;
 101    free(wd);
 102 }
 103
 104 static void
 105 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
 106 {
 107    Widget_Data *wd = elm_widget_data_get(obj);
 108    if (!wd) return;
 109    if (elm_widget_focus_get(obj))
 110      {
 111         edje_object_signal_emit(wd->radio, "elm,action,focus", "elm");
 112         evas_object_focus_set(wd->radio, EINA_TRUE);
 113      }
 114    else
 115      {
 116         edje_object_signal_emit(wd->radio, "elm,action,unfocus", "elm");
 117         evas_object_focus_set(wd->radio, EINA_FALSE);
 118      }
 119 }
 120
 121 static void
 122 _theme_hook(Evas_Object *obj)
 123 {
 124    Widget_Data *wd = elm_widget_data_get(obj);
 125    if (!wd) return;
 126    _elm_theme_object_set(obj, wd->radio, "radio", "base", elm_widget_style_get(obj));
 127    if (wd->icon)
 128      edje_object_signal_emit(wd->radio, "elm,state,icon,visible", "elm");
 129    else
 130      edje_object_signal_emit(wd->radio, "elm,state,icon,hidden", "elm");
 131    if (wd->state)
 132      edje_object_signal_emit(wd->radio, "elm,state,radio,on", "elm");
 133    else
 134      edje_object_signal_emit(wd->radio, "elm,state,radio,off", "elm");
 135    if (wd->label)
 136      edje_object_signal_emit(wd->radio, "elm,state,text,visible", "elm");
 137    else
 138      edje_object_signal_emit(wd->radio, "elm,state,text,hidden", "elm");
 139    edje_object_part_text_set(wd->radio, "elm.text", wd->label);
 140    if (elm_widget_disabled_get(obj))
 141      {
 142         edje_object_signal_emit(wd->radio, "elm,state,disabled", "elm");
 143         if (wd->state) _state_set(obj, 0);
 144      }
 145    edje_object_message_signal_process(wd->radio);
 146    edje_object_scale_set(wd->radio, elm_widget_scale_get(obj) * _elm_config->scale);
 147    _sizing_eval(obj);
 148 }
 149
 150 static void
 151 _disable_hook(Evas_Object *obj)
 152 {
 153    Widget_Data *wd = elm_widget_data_get(obj);
 154    if (!wd) return;
 155    if (elm_widget_disabled_get(obj))
 156      {
 157         edje_object_signal_emit(wd->radio, "elm,state,disabled", "elm");
 158         if (wd->state) _state_set(obj, 0);
 159      }
 160    else
 161      edje_object_signal_emit(wd->radio, "elm,state,enabled", "elm");
 162 }
 163
 164 static void
 165 _sizing_eval(Evas_Object *obj)
 166 {
 167    Widget_Data *wd = elm_widget_data_get(obj);
 168    Evas_Coord minw = -1, minh = -1;
 169    if (!wd) return;
 170    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 171    edje_object_size_min_restricted_calc(wd->radio, &minw, &minh, minw, minh);
 172    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 173    evas_object_size_hint_min_set(obj, minw, minh);
 174    evas_object_size_hint_max_set(obj, -1, -1);
 175 }
 176
 177 static void
 178 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 179 {
 180    Widget_Data *wd = elm_widget_data_get(data);
 181    if (!wd) return;
 182    if (obj != wd->icon) return;
 183    _sizing_eval(data);
 184 }
 185
 186 static void
 187 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 188 {
 189    Widget_Data *wd = elm_widget_data_get(obj);
 190    Evas_Object *sub = event_info;
 191    if (!wd) return;
 192    if (sub == wd->icon)
 193      {
 194         edje_object_signal_emit(wd->radio, "elm,state,icon,hidden", "elm");
 195         evas_object_event_callback_del_full
 196           (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
 197         wd->icon = NULL;
 198         _sizing_eval(obj);
 199      }
 200 }
 201
 202 static void
 203 _state_set(Evas_Object *obj, Eina_Bool state)
 204 {
 205    Widget_Data *wd = elm_widget_data_get(obj);
 206    if (!wd) return;
 207    if ((state != wd->state) && (!elm_widget_disabled_get(obj)))
 208      {
 209         wd->state = state;
 210         if (wd->state)
 211           edje_object_signal_emit(wd->radio, "elm,state,radio,on", "elm");
 212         else
 213           edje_object_signal_emit(wd->radio, "elm,state,radio,off", "elm");
 214      }
 215 }
 216
 217 static void
 218 _state_set_all(Widget_Data *wd)
 219 {
 220    const Eina_List *l;
 221    Evas_Object *child, *selected = NULL;
 222    Eina_Bool disabled = EINA_FALSE;
 223    EINA_LIST_FOREACH(wd->group->radios, l, child)
 224      {
 225         Widget_Data *wd2 = elm_widget_data_get(child);
 226         if (wd2->state) selected = child;
 227         if (wd2->value == wd->group->value)
 228           {
 229              _state_set(child, 1);
 230              if (!wd2->state) disabled = EINA_TRUE;
 231           }
 232         else _state_set(child, 0);
 233      }
 234    if ((disabled) && (selected)) _state_set(selected, 1);
 235 }
 236
 237 static void
 238 _activate(Evas_Object *obj)
 239 {
 240    Widget_Data *wd = elm_widget_data_get(obj);
 241    if (!wd) return;
 242    if (wd->group->value == wd->value) return;
 243    wd->group->value = wd->value;
 244    if (wd->group->valuep) *(wd->group->valuep) = wd->group->value;
 245    _state_set_all(wd);
 246    evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
 247 }
 248
 249 static void
 250 _activate_hook(Evas_Object *obj)
 251 {
 252    _activate(obj);
 253 }
 254
 255 static void
 256 _signal_radio_on(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 257 {
 258    _activate(data);
 259 }
 260
 261 /**
 262   * Add a new radio to the parent
 263   *
 264   * @param parent The parent object
 265   * @return The new object or NULL if it cannot be created
 266   *
 267   * @ingroup Radio
 268   */
 269 EAPI Evas_Object *
 270 elm_radio_add(Evas_Object *parent)
 271 {
 272    Evas_Object *obj;
 273    Evas *e;
 274    Widget_Data *wd;
 275
 276    EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
 277
 278    wd = ELM_NEW(Widget_Data);
 279    e = evas_object_evas_get(parent);
 280    if (!e) return NULL;
 281    obj = elm_widget_add(e);
 282    ELM_SET_WIDTYPE(widtype, "radio");
 283    elm_widget_type_set(obj, "radio");
 284    elm_widget_sub_object_add(parent, obj);
 285    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 286    elm_widget_data_set(obj, wd);
 287    elm_widget_del_hook_set(obj, _del_hook);
 288    elm_widget_theme_hook_set(obj, _theme_hook);
 289    elm_widget_disable_hook_set(obj, _disable_hook);
 290    elm_widget_can_focus_set(obj, EINA_TRUE);
 291    elm_widget_activate_hook_set(obj, _activate_hook);
 292    elm_widget_event_hook_set(obj, _event_hook);
 293
 294    wd->radio = edje_object_add(e);
 295    _elm_theme_object_set(obj, wd->radio, "radio", "base", "default");
 296    edje_object_signal_callback_add(wd->radio, "elm,action,radio,on", "", _signal_radio_on, obj);
 297    edje_object_signal_callback_add(wd->radio, "elm,action,radio,toggle", "", _signal_radio_on, obj);
 298    elm_widget_resize_object_set(obj, wd->radio);
 299
 300    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 301
 302    wd->group = calloc(1, sizeof(Group));
 303    wd->group->radios = eina_list_append(wd->group->radios, obj);
 304    wd->state = 0;
 305
 306    _sizing_eval(obj);
 307
 308    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 309    // TODO: and save some bytes, making descriptions per-class and not instance!
 310    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 311    return obj;
 312 }
 313
 314 /**
 315  * Set the text label of the radio object
 316  *
 317  * @param obj The radio object
 318  * @param label The text label string in UTF-8
 319  *
 320  * @ingroup Radio
 321  */
 322 EAPI void
 323 elm_radio_label_set(Evas_Object *obj, const char *label)
 324 {
 325    ELM_CHECK_WIDTYPE(obj, widtype);
 326    Widget_Data *wd = elm_widget_data_get(obj);
 327    if (!wd) return;
 328    eina_stringshare_replace(&wd->label, label);
 329    if (label)
 330      {
 331         edje_object_signal_emit(wd->radio, "elm,state,text,visible", "elm");
 332         edje_object_message_signal_process(wd->radio);
 333      }
 334    else
 335      {
 336         edje_object_signal_emit(wd->radio, "elm,state,text,hidden", "elm");
 337         edje_object_message_signal_process(wd->radio);
 338      }
 339    edje_object_part_text_set(wd->radio, "elm.text", label);
 340    _sizing_eval(obj);
 341 }
 342
 343 /**
 344  * Get the text label of the radio object
 345  *
 346  * @param obj The radio object
 347  * @return The text label string in UTF-8
 348  *
 349  * @ingroup Radio
 350  */
 351 EAPI const char *
 352 elm_radio_label_get(const Evas_Object *obj)
 353 {
 354    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 355    Widget_Data *wd = elm_widget_data_get(obj);
 356    if (!wd) return NULL;
 357    return wd->label;
 358 }
 359
 360 /**
 361  * Set the icon object of the radio object
 362  *
 363  * Once the icon object is set, a previously set one will be deleted.
 364  * If you want to keep that old content object, use the
 365  * elm_radio_icon_unset() function.
 366  *
 367  * @param obj The radio object
 368  * @param icon The icon object
 369  *
 370  * @ingroup Radio
 371  */
 372 EAPI void
 373 elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
 374 {
 375    ELM_CHECK_WIDTYPE(obj, widtype);
 376    Widget_Data *wd = elm_widget_data_get(obj);
 377    if (!wd) return;
 378    if (wd->icon == icon) return;
 379    if (wd->icon) evas_object_del(wd->icon);
 380    wd->icon = icon;
 381    if (icon)
 382      {
 383         elm_widget_sub_object_add(obj, icon);
 384         evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 385                                        _changed_size_hints, obj);
 386         edje_object_part_swallow(wd->radio, "elm.swallow.content", icon);
 387         edje_object_signal_emit(wd->radio, "elm,state,icon,visible", "elm");
 388         edje_object_message_signal_process(wd->radio);
 389      }
 390    _sizing_eval(obj);
 391 }
 392
 393 /**
 394  * Get the icon object of the radio object
 395  *
 396  * @param obj The radio object
 397  * @return The icon object
 398  *
 399  * @ingroup Radio
 400  */
 401 EAPI Evas_Object *
 402 elm_radio_icon_get(const Evas_Object *obj)
 403 {
 404    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 405    Widget_Data *wd = elm_widget_data_get(obj);
 406    if (!wd) return NULL;
 407    return wd->icon;
 408 }
 409
 410 /**
 411  * Unset the icon used for the radio object
 412  *
 413  * Unparent and return the icon object which was set for this widget.
 414  *
 415  * @param obj The radio object
 416  * @return The icon object that was being used
 417  *
 418  * @ingroup Radio
 419  */
 420 EAPI Evas_Object *
 421 elm_radio_icon_unset(Evas_Object *obj)
 422 {
 423    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 424    Widget_Data *wd = elm_widget_data_get(obj);
 425    if (!wd) return NULL;
 426    if (!wd->icon) return NULL;
 427    Evas_Object *icon = wd->icon;
 428    elm_widget_sub_object_del(obj, wd->icon);
 429    edje_object_part_unswallow(wd->radio, wd->icon);
 430    wd->icon = NULL;
 431    return icon;
 432 }
 433
 434 /**
 435  * Add this radio to a group of other radio objects
 436  *
 437  * Radio objects work in groups. Each member should have a different integer
 438  * value assigned. In order ro have them work as a group, they need to know
 439  * about eacthother. This adds the given radio object to the group of which
 440  * the group object indicated is a member.
 441  *
 442  * @param obj The radio object
 443  * @param group The object whose group the object is to join
 444  *
 445  * @ingroup Radio
 446  */
 447 EAPI void
 448 elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
 449 {
 450    ELM_CHECK_WIDTYPE(obj, widtype);
 451    Widget_Data *wd = elm_widget_data_get(obj);
 452    Widget_Data *wd2 = elm_widget_data_get(group);
 453    if (!wd) return;
 454    if (!wd2)
 455      {
 456         if (eina_list_count(wd->group->radios) == 1)
 457           return;
 458         wd->group->radios = eina_list_remove(wd->group->radios, obj);
 459         wd->group = calloc(1, sizeof(Group));
 460         wd->group->radios = eina_list_append(wd->group->radios, obj);
 461      }
 462    else if (wd->group == wd2->group) return;
 463    else
 464      {
 465         wd->group->radios = eina_list_remove(wd->group->radios, obj);
 466         if (!wd->group->radios) free(wd->group);
 467         wd->group = wd2->group;
 468         wd->group->radios = eina_list_append(wd->group->radios, obj);
 469      }
 470    if (wd->value == wd->group->value) _state_set(obj, 1);
 471    else _state_set(obj, 0);
 472 }
 473
 474 /**
 475  * Set the integer value that this radio object represents
 476  *
 477  * This sets the value of the radio.
 478  *
 479  * @param obj The radio object
 480  * @param value The value to use if this radio object is selected
 481  *
 482  * @ingroup Radio
 483  */
 484 EAPI void
 485 elm_radio_state_value_set(Evas_Object *obj, int value)
 486 {
 487    ELM_CHECK_WIDTYPE(obj, widtype);
 488    Widget_Data *wd = elm_widget_data_get(obj);
 489    if (!wd) return;
 490    wd->value = value;
 491    if (wd->value == wd->group->value) _state_set(obj, 1);
 492    else _state_set(obj, 0);
 493 }
 494
 495 /**
 496  * Get the integer value that this radio object represents
 497  *
 498  * This gets the value of the radio.
 499  *
 500  * @param obj The radio object
 501  * @return The value used if this radio object is selected
 502  *
 503  * @ingroup Radio
 504  */
 505 EAPI int
 506 elm_radio_state_value_get(const Evas_Object *obj)
 507 {
 508    ELM_CHECK_WIDTYPE(obj, widtype) 0;
 509    Widget_Data *wd = elm_widget_data_get(obj);
 510    if (!wd) return 0;
 511    return wd->value;
 512 }
 513
 514 /**
 515  * Set the value of the radio.
 516  *
 517  * This sets the value of the radio group and will also set the value if
 518  * pointed to, to the value supplied, but will not call any callbacks.
 519  *
 520  * @param obj The radio object
 521  * @param value The value to use for the group
 522  *
 523  * @ingroup Radio
 524  */
 525 EAPI void
 526 elm_radio_value_set(Evas_Object *obj, int value)
 527 {
 528    ELM_CHECK_WIDTYPE(obj, widtype);
 529    Widget_Data *wd = elm_widget_data_get(obj);
 530    if (!wd) return;
 531    if (value == wd->group->value) return;
 532    wd->group->value = value;
 533    if (wd->group->valuep) *(wd->group->valuep) = wd->group->value;
 534    _state_set_all(wd);
 535 }
 536
 537 /**
 538  * Get the state of the radio object
 539  *
 540  * @param obj The radio object
 541  * @return The integer state
 542  *
 543  * @ingroup Radio
 544  */
 545 EAPI int
 546 elm_radio_value_get(const Evas_Object *obj)
 547 {
 548    ELM_CHECK_WIDTYPE(obj, widtype) 0;
 549    Widget_Data *wd = elm_widget_data_get(obj);
 550    if (!wd) return 0;
 551    return wd->group->value;
 552 }
 553
 554 /**
 555  * Set a convenience pointer to a integer to change
 556  *
 557  * This sets a pointer to a integer, that, in addition to the radio objects
 558  * state will also be modified directly. To stop setting the object pointed
 559  * to simply use NULL as the valuep parameter. If valuep is not NULL, then
 560  * when this is called, the radio objects state will also be modified to
 561  * reflect the value of the integer valuep points to, just like calling
 562  * elm_radio_value_set().
 563  *
 564  * @param obj The radio object
 565  * @param valuep Pointer to the integer to modify
 566  *
 567  * @ingroup Radio
 568  */
 569 EAPI void
 570 elm_radio_value_pointer_set(Evas_Object *obj, int *valuep)
 571 {
 572    ELM_CHECK_WIDTYPE(obj, widtype);
 573    Widget_Data *wd = elm_widget_data_get(obj);
 574    if (!wd) return;
 575    if (valuep)
 576      {
 577         wd->group->valuep = valuep;
 578         if (*(wd->group->valuep) != wd->group->value)
 579           {
 580              wd->group->value = *(wd->group->valuep);
 581              _state_set_all(wd);
 582           }
 583      }
 584    else
 585      {
 586         wd->group->valuep = NULL;
 587      }
 588 }