src/lib/elm_toggle.c

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