src/lib/elm_button.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 typedef struct _Widget_Data Widget_Data;
   5
   6 struct _Widget_Data
   7 {
   8    Evas_Object *btn, *icon;
   9    const char *label;
  10    double ar_threshold;
  11    double ar_interval;
  12    Ecore_Timer *timer;
  13    Eina_Bool autorepeat : 1;
  14    Eina_Bool repeating : 1;
  15    Eina_Bool delete_me : 1;
  16 };
  17
  18 static const char *widtype = NULL;
  19 static void _del_hook(Evas_Object *obj);
  20 static void _del_pre_hook(Evas_Object *obj);
  21 static void _theme_hook(Evas_Object *obj);
  22 static void _disable_hook(Evas_Object *obj);
  23 static void _content_set_hook(Evas_Object *obj, const char *part, Evas_Object *content);
  24 static Evas_Object *_content_get_hook(const Evas_Object *obj, const char *part);
  25 static Evas_Object *_content_unset_hook(Evas_Object *obj, const char *part);
  26 static void _sizing_eval(Evas_Object *obj);
  27 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
  28 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  29 static void _signal_clicked(void *data, Evas_Object *obj, const char *emission, const char *source);
  30 static void _signal_pressed(void *data, Evas_Object *obj, const char *emission, const char *source);
  31 static void _signal_unpressed(void *data, Evas_Object *obj, const char *emission, const char *source);
  32 static void _on_focus_hook(void *data, Evas_Object *obj);
  33 static void _activate(Evas_Object *obj);
  34 static void _activate_hook(Evas_Object *obj);
  35 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
  36                              Evas_Callback_Type type, void *event_info);
  37
  38 static const char SIG_CLICKED[] = "clicked";
  39 static const char SIG_REPEATED[] = "repeated";
  40 static const char SIG_PRESSED[] = "pressed";
  41 static const char SIG_UNPRESSED[] = "unpressed";
  42 static const Evas_Smart_Cb_Description _signals[] = {
  43        {SIG_CLICKED, ""},
  44        {SIG_REPEATED, ""},
  45        {SIG_PRESSED, ""},
  46        {SIG_UNPRESSED, ""},
  47        {NULL, NULL}
  48 };
  49
  50 static Eina_Bool
  51 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
  52 {
  53    if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
  54    Evas_Event_Key_Down *ev = event_info;
  55    Widget_Data *wd = elm_widget_data_get(obj);
  56    if (!wd) return EINA_FALSE;
  57    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
  58    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
  59    if ((strcmp(ev->keyname, "Return")) &&
  60        (strcmp(ev->keyname, "KP_Enter")) &&
  61        (strcmp(ev->keyname, "space")))
  62      return EINA_FALSE;
  63    _activate(obj);
  64    ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
  65    edje_object_signal_emit(wd->btn, "elm,anim,activate", "elm");
  66    return EINA_TRUE;
  67 }
  68
  69 static void
  70 _del_pre_hook(Evas_Object *obj)
  71 {
  72    Widget_Data *wd = elm_widget_data_get(obj);
  73    if (!wd) return;
  74    wd->delete_me = EINA_TRUE;
  75 }
  76
  77 static void
  78 _del_hook(Evas_Object *obj)
  79 {
  80    Widget_Data *wd = elm_widget_data_get(obj);
  81    if (!wd) return;
  82    if (wd->label) eina_stringshare_del(wd->label);
  83    free(wd);
  84 }
  85
  86 static void
  87 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
  88 {
  89    Widget_Data *wd = elm_widget_data_get(obj);
  90    if (!wd) return;
  91    if (elm_widget_focus_get(obj))
  92      {
  93         edje_object_signal_emit(wd->btn, "elm,action,focus", "elm");
  94         evas_object_focus_set(wd->btn, EINA_TRUE);
  95      }
  96    else
  97      {
  98         edje_object_signal_emit(wd->btn, "elm,action,unfocus", "elm");
  99         evas_object_focus_set(wd->btn, EINA_FALSE);
 100      }
 101 }
 102
 103 static void
 104 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
 105 {
 106    Widget_Data *wd = elm_widget_data_get(obj);
 107    if (!wd) return;
 108    edje_object_mirrored_set(wd->btn, rtl);
 109 }
 110
 111 static void
 112 _theme_hook(Evas_Object *obj)
 113 {
 114    Widget_Data *wd = elm_widget_data_get(obj);
 115    const char *str;
 116    if (!wd) return;
 117    _elm_widget_mirrored_reload(obj);
 118    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 119    _elm_theme_object_set(obj, wd->btn, "button", "base", elm_widget_style_get(obj));
 120    if (wd->icon)
 121      edje_object_part_swallow(wd->btn, "elm.swallow.content", wd->icon);
 122    if (wd->label)
 123      edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
 124    else
 125      edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
 126    if (wd->icon)
 127      edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
 128    else
 129      edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
 130    edje_object_part_text_set(wd->btn, "elm.text", wd->label);
 131    if (elm_object_disabled_get(obj))
 132      edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
 133    edje_object_message_signal_process(wd->btn);
 134    edje_object_scale_set(wd->btn, elm_widget_scale_get(obj) * _elm_config->scale);
 135    str = edje_object_data_get(wd->btn, "focus_highlight");
 136    if ((str) && (!strcmp(str, "on")))
 137      elm_widget_highlight_in_theme_set(obj, EINA_TRUE);
 138    else
 139      elm_widget_highlight_in_theme_set(obj, EINA_FALSE);
 140    _sizing_eval(obj);
 141 }
 142
 143 static void
 144 _disable_hook(Evas_Object *obj)
 145 {
 146    Widget_Data *wd = elm_widget_data_get(obj);
 147    if (!wd) return;
 148    if (elm_widget_disabled_get(obj))
 149      edje_object_signal_emit(wd->btn, "elm,state,disabled", "elm");
 150    else
 151      edje_object_signal_emit(wd->btn, "elm,state,enabled", "elm");
 152 }
 153
 154 static void
 155 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
 156 {
 157    Widget_Data *wd = elm_widget_data_get(obj);
 158    if (!wd) return;
 159    edje_object_signal_emit(wd->btn, emission, source);
 160 }
 161
 162 static void
 163 _signal_callback_add_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
 164 {
 165    Widget_Data *wd = elm_widget_data_get(obj);
 166    if (!wd) return;
 167    edje_object_signal_callback_add(wd->btn, emission, source, func_cb, data);
 168 }
 169
 170 static void
 171 _signal_callback_del_hook(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data)
 172 {
 173    Widget_Data *wd = elm_widget_data_get(obj);
 174    edje_object_signal_callback_del_full(wd->btn, emission, source, func_cb,
 175                                         data);
 176 }
 177
 178 static void
 179 _content_set_hook(Evas_Object *obj, const char *part __UNUSED__, Evas_Object *content)
 180 {
 181    ELM_CHECK_WIDTYPE(obj, widtype);
 182    Widget_Data *wd = elm_widget_data_get(obj);
 183    if (!wd) return;
 184    if (wd->icon == content) return;
 185    if (wd->icon) evas_object_del(wd->icon);
 186    wd->icon = content;
 187    if (content)
 188      {
 189         elm_widget_sub_object_add(obj, content);
 190         evas_object_event_callback_add(content,
 191                                        EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 192                                        _changed_size_hints, obj);
 193         edje_object_part_swallow(wd->btn, "elm.swallow.content", content);
 194         edje_object_signal_emit(wd->btn, "elm,state,icon,visible", "elm");
 195         edje_object_message_signal_process(wd->btn);
 196      }
 197    _sizing_eval(obj);
 198 }
 199
 200 static Evas_Object *
 201 _content_get_hook(const Evas_Object *obj, const char *part __UNUSED__)
 202 {
 203    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 204    Widget_Data *wd = elm_widget_data_get(obj);
 205    if (!wd) return NULL;
 206    return wd->icon;
 207 }
 208
 209 static Evas_Object *
 210 _content_unset_hook(Evas_Object *obj, const char *part __UNUSED__)
 211 {
 212    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 213    Widget_Data *wd = elm_widget_data_get(obj);
 214    if (!wd) return NULL;
 215    if (!wd->icon) return NULL;
 216    Evas_Object *icon = wd->icon;
 217    elm_widget_sub_object_del(obj, wd->icon);
 218    edje_object_part_unswallow(wd->btn, wd->icon);
 219    wd->icon = NULL;
 220    return icon;
 221 }
 222
 223 static void
 224 _sizing_eval(Evas_Object *obj)
 225 {
 226    Widget_Data *wd = elm_widget_data_get(obj);
 227    Evas_Coord minw = -1, minh = -1;
 228
 229    if (!wd) return;
 230    if (wd->delete_me) return;
 231    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 232    edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
 233    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 234    evas_object_size_hint_min_set(obj, minw, minh);
 235 }
 236
 237 static void
 238 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 239 {
 240    Widget_Data *wd = elm_widget_data_get(data);
 241    if (!wd) return;
 242    if (obj != wd->icon) return;
 243    _sizing_eval(data);
 244 }
 245
 246 static void
 247 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 248 {
 249    Widget_Data *wd = elm_widget_data_get(obj);
 250    Evas_Object *sub = event_info;
 251    if (!wd) return;
 252    if (sub == wd->icon)
 253      {
 254         edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
 255         evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 256                                             _changed_size_hints, obj);
 257         wd->icon = NULL;
 258         edje_object_message_signal_process(wd->btn);
 259         _sizing_eval(obj);
 260      }
 261 }
 262
 263 static void
 264 _activate(Evas_Object *obj)
 265 {
 266    Widget_Data *wd = elm_widget_data_get(obj);
 267    if (!wd) return;
 268    if (wd->timer)
 269      {
 270         ecore_timer_del(wd->timer);
 271         wd->timer = NULL;
 272      }
 273    wd->repeating = EINA_FALSE;
 274    if ((_elm_config->access_mode == ELM_ACCESS_MODE_OFF) ||
 275        (_elm_access_2nd_click_timeout(obj)))
 276      {
 277         if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
 278            _elm_access_say(E_("Clicked"));
 279         evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
 280      }
 281 }
 282
 283 static void
 284 _activate_hook(Evas_Object *obj)
 285 {
 286    _activate(obj);
 287 }
 288
 289 static void
 290 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 291 {
 292    _activate(data);
 293 }
 294
 295 static Eina_Bool
 296 _autorepeat_send(void *data)
 297 {
 298    Widget_Data *wd = elm_widget_data_get(data);
 299    if (!wd) return ECORE_CALLBACK_CANCEL;
 300
 301    evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
 302    if (!wd->repeating)
 303      {
 304         wd->timer = NULL;
 305         return ECORE_CALLBACK_CANCEL;
 306      }
 307
 308    return ECORE_CALLBACK_RENEW;
 309 }
 310
 311 static Eina_Bool
 312 _autorepeat_initial_send(void *data)
 313 {
 314    Widget_Data *wd = elm_widget_data_get(data);
 315    if (!wd) return ECORE_CALLBACK_CANCEL;
 316
 317    if (wd->timer) ecore_timer_del(wd->timer);
 318    wd->repeating = EINA_TRUE;
 319    _autorepeat_send(data);
 320    wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
 321
 322    return ECORE_CALLBACK_CANCEL;
 323 }
 324
 325 static void
 326 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 327 {
 328    Widget_Data *wd = elm_widget_data_get(data);
 329    if (!wd) return;
 330
 331    if ((wd->autorepeat) && (!wd->repeating))
 332      {
 333         if (wd->ar_threshold <= 0.0)
 334           _autorepeat_initial_send(data); /* call immediately */
 335         else
 336           wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
 337      }
 338
 339    evas_object_smart_callback_call(data, SIG_PRESSED, NULL);
 340 }
 341
 342 static void
 343 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 344 {
 345    Widget_Data *wd = elm_widget_data_get(data);
 346    if (!wd) return;
 347
 348    if (wd->timer)
 349      {
 350         ecore_timer_del(wd->timer);
 351         wd->timer = NULL;
 352      }
 353    wd->repeating = EINA_FALSE;
 354    evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
 355 }
 356
 357 static void
 358 _elm_button_label_set(Evas_Object *obj, const char *item, const char *label)
 359 {
 360    ELM_CHECK_WIDTYPE(obj, widtype);
 361    Widget_Data *wd = elm_widget_data_get(obj);
 362    if (item && strcmp(item, "default")) return;
 363    if (!wd) return;
 364    eina_stringshare_replace(&wd->label, label);
 365    if (label)
 366      edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
 367    else
 368      edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
 369    edje_object_message_signal_process(wd->btn);
 370    edje_object_part_text_set(wd->btn, "elm.text", label);
 371    _sizing_eval(obj);
 372 }
 373
 374 static const char *
 375 _elm_button_label_get(const Evas_Object *obj, const char *item)
 376 {
 377    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 378    Widget_Data *wd = elm_widget_data_get(obj);
 379    if (item && strcmp(item, "default")) return NULL;
 380    if (!wd) return NULL;
 381    return wd->label;
 382 }
 383
 384 static char *
 385 _access_info_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
 386 {
 387    const char *txt = elm_widget_access_info_get(obj);
 388    if (!txt) txt = _elm_button_label_get(obj, NULL);
 389    if (txt) return strdup(txt);
 390    return NULL;
 391 }
 392
 393 static char *
 394 _access_state_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
 395 {
 396    if (elm_widget_disabled_get(obj))
 397      return strdup(E_("State: Disabled"));
 398    return NULL;
 399 }
 400
 401 EAPI Evas_Object *
 402 elm_button_add(Evas_Object *parent)
 403 {
 404    Evas_Object *obj;
 405    Evas *e;
 406    Widget_Data *wd;
 407
 408    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
 409
 410    ELM_SET_WIDTYPE(widtype, "button");
 411    elm_widget_type_set(obj, "button");
 412    elm_widget_sub_object_add(parent, obj);
 413    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 414    elm_widget_data_set(obj, wd);
 415    elm_widget_del_hook_set(obj, _del_hook);
 416    elm_widget_del_pre_hook_set(obj, _del_pre_hook);
 417    elm_widget_theme_hook_set(obj, _theme_hook);
 418    elm_widget_disable_hook_set(obj, _disable_hook);
 419    elm_widget_can_focus_set(obj, EINA_TRUE);
 420    elm_widget_activate_hook_set(obj, _activate_hook);
 421    elm_widget_event_hook_set(obj, _event_hook);
 422    elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
 423    elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
 424    elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
 425    elm_widget_text_set_hook_set(obj, _elm_button_label_set);
 426    elm_widget_text_get_hook_set(obj, _elm_button_label_get);
 427    elm_widget_content_set_hook_set(obj, _content_set_hook);
 428    elm_widget_content_get_hook_set(obj, _content_get_hook);
 429    elm_widget_content_unset_hook_set(obj, _content_unset_hook);
 430
 431    wd->btn = edje_object_add(e);
 432    _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
 433    edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
 434                                    _signal_clicked, obj);
 435    edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
 436                                    _signal_pressed, obj);
 437    edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
 438                                    _signal_unpressed, obj);
 439    elm_widget_resize_object_set(obj, wd->btn);
 440
 441    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 442
 443    _theme_hook(obj);
 444
 445    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 446    // TODO: and save some bytes, making descriptions per-class and not instance!
 447    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 448
 449    _elm_access_object_register(obj, wd->btn);
 450    _elm_access_text_set(_elm_access_object_get(obj),
 451                         ELM_ACCESS_TYPE, E_("Button"));
 452    _elm_access_callback_set(_elm_access_object_get(obj),
 453                             ELM_ACCESS_INFO, _access_info_cb, obj);
 454    _elm_access_callback_set(_elm_access_object_get(obj),
 455                             ELM_ACCESS_STATE, _access_state_cb, obj);
 456    return obj;
 457 }
 458
 459 EAPI void
 460 elm_button_label_set(Evas_Object *obj, const char *label)
 461 {
 462    _elm_button_label_set(obj, NULL, label);
 463 }
 464
 465 EAPI const char *
 466 elm_button_label_get(const Evas_Object *obj)
 467 {
 468    return _elm_button_label_get(obj, NULL);
 469 }
 470
 471
 472 EAPI void
 473 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
 474 {
 475    _content_set_hook(obj, NULL, icon);
 476 }
 477
 478 EAPI Evas_Object *
 479 elm_button_icon_get(const Evas_Object *obj)
 480 {
 481    return _content_get_hook(obj, NULL);
 482 }
 483
 484 EAPI Evas_Object *
 485 elm_button_icon_unset(Evas_Object *obj)
 486 {
 487    return _content_unset_hook(obj, NULL);
 488 }
 489
 490 EAPI void
 491 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
 492 {
 493    ELM_CHECK_WIDTYPE(obj, widtype);
 494    Widget_Data *wd = elm_widget_data_get(obj);
 495    if (!wd) return;
 496    if (wd->timer)
 497      {
 498         ecore_timer_del(wd->timer);
 499         wd->timer = NULL;
 500      }
 501    wd->autorepeat = on;
 502    wd->repeating = EINA_FALSE;
 503 }
 504
 505 EAPI Eina_Bool
 506 elm_button_autorepeat_get(const Evas_Object *obj)
 507 {
 508    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 509    Widget_Data *wd = elm_widget_data_get(obj);
 510    if (!wd) return EINA_FALSE;
 511    return wd->autorepeat;
 512 }
 513
 514 EAPI void
 515 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
 516 {
 517    ELM_CHECK_WIDTYPE(obj, widtype);
 518    Widget_Data *wd = elm_widget_data_get(obj);
 519    if (!wd) return;
 520    if (wd->ar_threshold == t) return;
 521    if (wd->timer)
 522      {
 523         ecore_timer_del(wd->timer);
 524         wd->timer = NULL;
 525      }
 526    wd->ar_threshold = t;
 527 }
 528
 529 EAPI double
 530 elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj)
 531 {
 532    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
 533    Widget_Data *wd = elm_widget_data_get(obj);
 534    if (!wd) return 0.0;
 535    return wd->ar_threshold;
 536 }
 537
 538 EAPI void
 539 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
 540 {
 541    ELM_CHECK_WIDTYPE(obj, widtype);
 542    Widget_Data *wd = elm_widget_data_get(obj);
 543    if (!wd) return;
 544    if (wd->ar_interval == t) return;
 545
 546    wd->ar_interval = t;
 547    if ((wd->repeating) && (wd->timer)) ecore_timer_interval_set(wd->timer, t);
 548 }
 549
 550 EAPI double
 551 elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj)
 552 {
 553    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
 554    Widget_Data *wd = elm_widget_data_get(obj);
 555    if (!wd) return 0.0;
 556    return wd->ar_interval;
 557 }