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
  14  * until the toggle is released by the cursor (assuming it has been triggered
  15  * 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
  40 static const char SIG_CHANGED[] = "changed";
  41 static const Evas_Smart_Cb_Description _signals[] = {
  42   {SIG_CHANGED, ""},
  43   {NULL, NULL}
  44 };
  45
  46 static void
  47 _del_hook(Evas_Object *obj)
  48 {
  49    Widget_Data *wd = elm_widget_data_get(obj);
  50    if (!wd) return;
  51    if (wd->label) eina_stringshare_del(wd->label);
  52    if (wd->ontext) eina_stringshare_del(wd->ontext);
  53    if (wd->offtext) eina_stringshare_del(wd->offtext);
  54    free(wd);
  55 }
  56
  57 static void
  58 _disable_hook(Evas_Object *obj)
  59 {
  60    Widget_Data *wd = elm_widget_data_get(obj);
  61    if (!wd) return;
  62    if (elm_widget_disabled_get(obj))
  63      edje_object_signal_emit(wd->tgl, "elm,state,disabled", "elm");
  64    else
  65      edje_object_signal_emit(wd->tgl, "elm,state,enabled", "elm");
  66 }
  67
  68 static void
  69 _theme_hook(Evas_Object *obj)
  70 {
  71    Widget_Data *wd = elm_widget_data_get(obj);
  72    if (!wd) return;
  73    _elm_theme_object_set(obj, wd->tgl, "toggle", "base", elm_widget_style_get(obj));
  74    if (wd->icon)
  75      edje_object_signal_emit(wd->tgl, "elm,state,icon,visible", "elm");
  76    else
  77      edje_object_signal_emit(wd->tgl, "elm,state,icon,hidden", "elm");
  78    if (wd->state)
  79      edje_object_signal_emit(wd->tgl, "elm,state,toggle,on", "elm");
  80    else
  81      edje_object_signal_emit(wd->tgl, "elm,state,toggle,off", "elm");
  82    if (wd->label)
  83      edje_object_signal_emit(wd->tgl, "elm,state,text,visible", "elm");
  84    else
  85      edje_object_signal_emit(wd->tgl, "elm,state,text,hidden", "elm");
  86    edje_object_part_text_set(wd->tgl, "elm.text", wd->label);
  87    edje_object_part_text_set(wd->tgl, "elm.ontext", wd->ontext);
  88    edje_object_part_text_set(wd->tgl, "elm.offtext", wd->offtext);
  89    edje_object_message_signal_process(wd->tgl);
  90    edje_object_scale_set(wd->tgl, elm_widget_scale_get(obj) * _elm_config->scale);
  91    _sizing_eval(obj);
  92 }
  93
  94 static void
  95 _sizing_eval(Evas_Object *obj)
  96 {
  97    Widget_Data *wd = elm_widget_data_get(obj);
  98    Evas_Coord minw = -1, minh = -1;
  99
 100    if (!wd) return;
 101    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 102    edje_object_size_min_restricted_calc(wd->tgl, &minw, &minh, minw, minh);
 103    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 104    evas_object_size_hint_min_set(obj, minw, minh);
 105    evas_object_size_hint_max_set(obj, -1, -1);
 106 }
 107
 108 static void
 109 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 110 {
 111    Widget_Data *wd = elm_widget_data_get(data);
 112    if (!wd) return;
 113    if (obj != wd->icon) return;
 114    _sizing_eval(data);
 115 }
 116
 117 static void
 118 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 119 {
 120    Widget_Data *wd = elm_widget_data_get(obj);
 121    Evas_Object *sub = event_info;
 122    if (!wd) return;
 123    if (sub == wd->icon)
 124      {
 125         edje_object_signal_emit(wd->tgl, "elm,state,icon,hidden", "elm");
 126         evas_object_event_callback_del_full
 127           (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
 128         wd->icon = NULL;
 129         _sizing_eval(obj);
 130      }
 131 }
 132
 133 static void
 134 _signal_toggle_off(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 135 {
 136    Widget_Data *wd = elm_widget_data_get(data);
 137    if (!wd) return;
 138    wd->state = 0;
 139    if (wd->statep) *wd->statep = wd->state;
 140    evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
 141 }
 142
 143 static void
 144 _signal_toggle_on(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 145 {
 146    Widget_Data *wd = elm_widget_data_get(data);
 147    if (!wd) return;
 148    wd->state = 1;
 149    if (wd->statep) *wd->statep = wd->state;
 150    evas_object_smart_callback_call(data, SIG_CHANGED, NULL);
 151 }
 152
 153 /**
 154  * Add a toggle to @p parent.
 155  *
 156  * @param parent The parent object
 157  *
 158  * @return The toggle object
 159  *
 160  * @ingroup Toggle
 161  */
 162 EAPI Evas_Object *
 163 elm_toggle_add(Evas_Object *parent)
 164 {
 165    Evas_Object *obj;
 166    Evas *e;
 167    Widget_Data *wd;
 168
 169    wd = ELM_NEW(Widget_Data);
 170    e = evas_object_evas_get(parent);
 171    obj = elm_widget_add(e);
 172    ELM_SET_WIDTYPE(widtype, "toggle");
 173    elm_widget_type_set(obj, "toggle");
 174    elm_widget_sub_object_add(parent, obj);
 175    elm_widget_data_set(obj, wd);
 176    elm_widget_del_hook_set(obj, _del_hook);
 177    elm_widget_theme_hook_set(obj, _theme_hook);
 178    elm_widget_disable_hook_set(obj, _disable_hook);
 179
 180    wd->tgl = edje_object_add(e);
 181    _elm_theme_object_set(obj, wd->tgl, "toggle", "base", "default");
 182    wd->ontext = eina_stringshare_add("ON");
 183    wd->offtext = eina_stringshare_add("OFF");
 184    edje_object_signal_callback_add(wd->tgl, "elm,action,toggle,on", "",
 185                                    _signal_toggle_on, obj);
 186    edje_object_signal_callback_add(wd->tgl, "elm,action,toggle,off", "",
 187                                    _signal_toggle_off, obj);
 188    elm_widget_resize_object_set(obj, wd->tgl);
 189    edje_object_part_text_set(wd->tgl, "elm.ontext", wd->ontext);
 190    edje_object_part_text_set(wd->tgl, "elm.offtext", wd->offtext);
 191
 192    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 193
 194    _sizing_eval(obj);
 195
 196    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 197    // TODO: and save some bytes, making descriptions per-class and not instance!
 198    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 199    return obj;
 200 }
 201
 202 /**
 203  * Sets the label to be displayed with the toggle.
 204  *
 205  * @param obj The toggle object
 206  * @param label The label to be displayed
 207  *
 208  * @ingroup Toggle
 209  */
 210 EAPI void
 211 elm_toggle_label_set(Evas_Object *obj, const char *label)
 212 {
 213    ELM_CHECK_WIDTYPE(obj, widtype);
 214    Widget_Data *wd = elm_widget_data_get(obj);
 215    if (!wd) return;
 216    eina_stringshare_replace(&wd->label, label);
 217    if (label)
 218      edje_object_signal_emit(wd->tgl, "elm,state,text,visible", "elm");
 219    else
 220      edje_object_signal_emit(wd->tgl, "elm,state,text,hidden", "elm");
 221    edje_object_message_signal_process(wd->tgl);
 222    edje_object_part_text_set(wd->tgl, "elm.text", label);
 223    _sizing_eval(obj);
 224 }
 225
 226 /**
 227  * Gets the label of the toggle
 228  *
 229  * @param obj The toggle object
 230  * @return The label of the toggle
 231  *
 232  * @ingroup Toggle
 233  */
 234 EAPI const char *
 235 elm_toggle_label_get(const Evas_Object *obj)
 236 {
 237    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 238    Widget_Data *wd = elm_widget_data_get(obj);
 239    if (!wd) return NULL;
 240    return wd->label;
 241 }
 242
 243 /**
 244  * Sets the icon to be displayed with the toggle.
 245  *
 246  * @param obj The toggle object
 247  * @param icon The icon object to be displayed
 248  *
 249  * @ingroup Toggle
 250  */
 251 EAPI void
 252 elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon)
 253 {
 254    ELM_CHECK_WIDTYPE(obj, widtype);
 255    Widget_Data *wd = elm_widget_data_get(obj);
 256    if (!wd) return;
 257    if ((wd->icon != icon) && (wd->icon))
 258      elm_widget_sub_object_del(obj, wd->icon);
 259    wd->icon = icon;
 260    if (!icon) return;
 261    elm_widget_sub_object_add(obj, icon);
 262    evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 263                                   _changed_size_hints, obj);
 264    edje_object_part_swallow(wd->tgl, "elm.swallow.content", icon);
 265    edje_object_signal_emit(wd->tgl, "elm,state,icon,visible", "elm");
 266    _sizing_eval(obj);
 267 }
 268
 269 /**
 270  * Gets the icon of the toggle
 271  *
 272  * @param obj The toggle object
 273  * @return The icon object
 274  *
 275  * @ingroup Toggle
 276  */
 277 EAPI Evas_Object *
 278 elm_toggle_icon_get(const Evas_Object *obj)
 279 {
 280    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 281    Widget_Data *wd = elm_widget_data_get(obj);
 282    if (!wd) return NULL;
 283    return wd->icon;
 284 }
 285
 286 /**
 287  * Sets the labels to be associated with the on and off states of the toggle.
 288  *
 289  * @param obj The toggle object
 290  * @param onlabel The label displayed when the toggle is in the "on" state
 291  * @param offlabel The label displayed when the toggle is in the "off" state
 292  *
 293  * @ingroup Toggle
 294  */
 295 EAPI void
 296 elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel)
 297 {
 298    ELM_CHECK_WIDTYPE(obj, widtype);
 299    Widget_Data *wd = elm_widget_data_get(obj);
 300    if (!wd) return;
 301    eina_stringshare_replace(&wd->ontext, onlabel);
 302    eina_stringshare_replace(&wd->offtext, offlabel);
 303    edje_object_part_text_set(wd->tgl, "elm.ontext", onlabel);
 304    edje_object_part_text_set(wd->tgl, "elm.offtext", offlabel);
 305    _sizing_eval(obj);
 306 }
 307
 308
 309 /**
 310  * Gets the labels associated with the on and off states of the toggle.
 311  *
 312  * @param obj The toggle object
 313  * @param onlabel A char** to place the onlabel of @p obj into
 314  * @param offlabel A char** to place the offlabel of @p obj into
 315  *
 316  * @ingroup Toggle
 317  */
 318 EAPI void
 319 elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel)
 320 {
 321    if (onlabel) *onlabel = NULL;
 322    if (offlabel) *offlabel = NULL;
 323    ELM_CHECK_WIDTYPE(obj, widtype);
 324    Widget_Data *wd = elm_widget_data_get(obj);
 325    if (!wd) return;
 326    if (onlabel) *onlabel = wd->ontext;
 327    if (offlabel) *offlabel = wd->offtext;
 328 }
 329
 330 /**
 331  * Sets the state of the toggle to @p state.
 332  *
 333  * @param obj The toggle object
 334  * @param state The state of @p obj
 335  *
 336  * @ingroup Toggle
 337  */
 338 EAPI void
 339 elm_toggle_state_set(Evas_Object *obj, Eina_Bool state)
 340 {
 341    ELM_CHECK_WIDTYPE(obj, widtype);
 342    Widget_Data *wd = elm_widget_data_get(obj);
 343    if (!wd) return;
 344    if (state != wd->state)
 345      {
 346         wd->state = state;
 347         if (wd->statep) *wd->statep = wd->state;
 348         if (wd->state)
 349           edje_object_signal_emit(wd->tgl, "elm,state,toggle,on", "elm");
 350         else
 351           edje_object_signal_emit(wd->tgl, "elm,state,toggle,off", "elm");
 352      }
 353 }
 354
 355 /**
 356  * Gets the state of the toggle to @p state.
 357  *
 358  * @param obj The toggle object
 359  * @return The state of @p obj
 360  *
 361  * @ingroup Toggle
 362  */
 363 EAPI Eina_Bool
 364 elm_toggle_state_get(const Evas_Object *obj)
 365 {
 366    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 367    Widget_Data *wd = elm_widget_data_get(obj);
 368    if (!wd) return EINA_FALSE;
 369    return wd->state;
 370 }
 371
 372 /**
 373  * Sets the state pointer of the toggle to @p statep.
 374  *
 375  * @param obj The toggle object
 376  * @param statep The state pointer of @p obj
 377  *
 378  * @ingroup Toggle
 379  */
 380 EAPI void
 381 elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep)
 382 {
 383    ELM_CHECK_WIDTYPE(obj, widtype);
 384    Widget_Data *wd = elm_widget_data_get(obj);
 385    if (!wd) return;
 386    if (statep)
 387      {
 388         wd->statep = statep;
 389         if (*wd->statep != wd->state)
 390           {
 391              wd->state = *wd->statep;
 392              if (wd->state)
 393                edje_object_signal_emit(wd->tgl, "elm,state,toggle,on", "elm");
 394              else
 395                edje_object_signal_emit(wd->tgl, "elm,state,toggle,off", "elm");
 396           }
 397      }
 398    else
 399      wd->statep = NULL;
 400 }