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    evas_object_event_callback_del_full(wd->icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 219                                        _changed_size_hints, obj);
 220    edje_object_part_unswallow(wd->btn, wd->icon);
 221    wd->icon = NULL;
 222    return icon;
 223 }
 224
 225 static void
 226 _sizing_eval(Evas_Object *obj)
 227 {
 228    Widget_Data *wd = elm_widget_data_get(obj);
 229    Evas_Coord minw = -1, minh = -1;
 230
 231    if (!wd) return;
 232    if (wd->delete_me) return;
 233    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 234    edje_object_size_min_restricted_calc(wd->btn, &minw, &minh, minw, minh);
 235    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 236    evas_object_size_hint_min_set(obj, minw, minh);
 237 }
 238
 239 static void
 240 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 241 {
 242    Widget_Data *wd = elm_widget_data_get(data);
 243    if (!wd) return;
 244    if (obj != wd->icon) return;
 245    _sizing_eval(data);
 246 }
 247
 248 static void
 249 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 250 {
 251    Widget_Data *wd = elm_widget_data_get(obj);
 252    Evas_Object *sub = event_info;
 253    if (!wd) return;
 254    if (sub == wd->icon)
 255      {
 256         edje_object_signal_emit(wd->btn, "elm,state,icon,hidden", "elm");
 257         evas_object_event_callback_del_full(sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 258                                             _changed_size_hints, obj);
 259         wd->icon = NULL;
 260         edje_object_message_signal_process(wd->btn);
 261         _sizing_eval(obj);
 262      }
 263 }
 264
 265 static void
 266 _activate(Evas_Object *obj)
 267 {
 268    Widget_Data *wd = elm_widget_data_get(obj);
 269    if (!wd) return;
 270    if (wd->timer)
 271      {
 272         ecore_timer_del(wd->timer);
 273         wd->timer = NULL;
 274      }
 275    wd->repeating = EINA_FALSE;
 276    if ((_elm_config->access_mode == ELM_ACCESS_MODE_OFF) ||
 277        (_elm_access_2nd_click_timeout(obj)))
 278      {
 279         if (_elm_config->access_mode != ELM_ACCESS_MODE_OFF)
 280            _elm_access_say(E_("Clicked"));
 281         evas_object_smart_callback_call(obj, SIG_CLICKED, NULL);
 282      }
 283 }
 284
 285 static void
 286 _activate_hook(Evas_Object *obj)
 287 {
 288    _activate(obj);
 289 }
 290
 291 static void
 292 _signal_clicked(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 293 {
 294    _activate(data);
 295 }
 296
 297 static Eina_Bool
 298 _autorepeat_send(void *data)
 299 {
 300    Widget_Data *wd = elm_widget_data_get(data);
 301    if (!wd) return ECORE_CALLBACK_CANCEL;
 302
 303    evas_object_smart_callback_call(data, SIG_REPEATED, NULL);
 304    if (!wd->repeating)
 305      {
 306         wd->timer = NULL;
 307         return ECORE_CALLBACK_CANCEL;
 308      }
 309
 310    return ECORE_CALLBACK_RENEW;
 311 }
 312
 313 static Eina_Bool
 314 _autorepeat_initial_send(void *data)
 315 {
 316    Widget_Data *wd = elm_widget_data_get(data);
 317    if (!wd) return ECORE_CALLBACK_CANCEL;
 318
 319    if (wd->timer) ecore_timer_del(wd->timer);
 320    wd->repeating = EINA_TRUE;
 321    _autorepeat_send(data);
 322    wd->timer = ecore_timer_add(wd->ar_interval, _autorepeat_send, data);
 323
 324    return ECORE_CALLBACK_CANCEL;
 325 }
 326
 327 static void
 328 _signal_pressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 329 {
 330    Widget_Data *wd = elm_widget_data_get(data);
 331    if (!wd) return;
 332
 333    if ((wd->autorepeat) && (!wd->repeating))
 334      {
 335         if (wd->ar_threshold <= 0.0)
 336           _autorepeat_initial_send(data); /* call immediately */
 337         else
 338           wd->timer = ecore_timer_add(wd->ar_threshold, _autorepeat_initial_send, data);
 339      }
 340
 341    evas_object_smart_callback_call(data, SIG_PRESSED, NULL);
 342 }
 343
 344 static void
 345 _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 346 {
 347    Widget_Data *wd = elm_widget_data_get(data);
 348    if (!wd) return;
 349
 350    if (wd->timer)
 351      {
 352         ecore_timer_del(wd->timer);
 353         wd->timer = NULL;
 354      }
 355    wd->repeating = EINA_FALSE;
 356    evas_object_smart_callback_call(data, SIG_UNPRESSED, NULL);
 357 }
 358
 359 static void
 360 _elm_button_label_set(Evas_Object *obj, const char *item, const char *label)
 361 {
 362    ELM_CHECK_WIDTYPE(obj, widtype);
 363    Widget_Data *wd = elm_widget_data_get(obj);
 364    if (item && strcmp(item, "default")) return;
 365    if (!wd) return;
 366    eina_stringshare_replace(&wd->label, label);
 367    if (label)
 368      edje_object_signal_emit(wd->btn, "elm,state,text,visible", "elm");
 369    else
 370      edje_object_signal_emit(wd->btn, "elm,state,text,hidden", "elm");
 371    edje_object_message_signal_process(wd->btn);
 372    edje_object_part_text_set(wd->btn, "elm.text", label);
 373    _sizing_eval(obj);
 374 }
 375
 376 static const char *
 377 _elm_button_label_get(const Evas_Object *obj, const char *item)
 378 {
 379    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 380    Widget_Data *wd = elm_widget_data_get(obj);
 381    if (item && strcmp(item, "default")) return NULL;
 382    if (!wd) return NULL;
 383    return wd->label;
 384 }
 385
 386 static char *
 387 _access_info_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
 388 {
 389    const char *txt = elm_widget_access_info_get(obj);
 390    if (!txt) txt = _elm_button_label_get(obj, NULL);
 391    if (txt) return strdup(txt);
 392    return NULL;
 393 }
 394
 395 static char *
 396 _access_state_cb(void *data __UNUSED__, Evas_Object *obj, Elm_Widget_Item *item __UNUSED__)
 397 {
 398    if (elm_widget_disabled_get(obj))
 399      return strdup(E_("State: Disabled"));
 400    return NULL;
 401 }
 402
 403 EAPI Evas_Object *
 404 elm_button_add(Evas_Object *parent)
 405 {
 406    Evas_Object *obj;
 407    Evas *e;
 408    Widget_Data *wd;
 409
 410    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
 411
 412    ELM_SET_WIDTYPE(widtype, "button");
 413    elm_widget_type_set(obj, "button");
 414    elm_widget_sub_object_add(parent, obj);
 415    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 416    elm_widget_data_set(obj, wd);
 417    elm_widget_del_hook_set(obj, _del_hook);
 418    elm_widget_del_pre_hook_set(obj, _del_pre_hook);
 419    elm_widget_theme_hook_set(obj, _theme_hook);
 420    elm_widget_disable_hook_set(obj, _disable_hook);
 421    elm_widget_can_focus_set(obj, EINA_TRUE);
 422    elm_widget_activate_hook_set(obj, _activate_hook);
 423    elm_widget_event_hook_set(obj, _event_hook);
 424    elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
 425    elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
 426    elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
 427    elm_widget_text_set_hook_set(obj, _elm_button_label_set);
 428    elm_widget_text_get_hook_set(obj, _elm_button_label_get);
 429    elm_widget_content_set_hook_set(obj, _content_set_hook);
 430    elm_widget_content_get_hook_set(obj, _content_get_hook);
 431    elm_widget_content_unset_hook_set(obj, _content_unset_hook);
 432
 433    wd->btn = edje_object_add(e);
 434    _elm_theme_object_set(obj, wd->btn, "button", "base", "default");
 435    edje_object_signal_callback_add(wd->btn, "elm,action,click", "",
 436                                    _signal_clicked, obj);
 437    edje_object_signal_callback_add(wd->btn, "elm,action,press", "",
 438                                    _signal_pressed, obj);
 439    edje_object_signal_callback_add(wd->btn, "elm,action,unpress", "",
 440                                    _signal_unpressed, obj);
 441    elm_widget_resize_object_set(obj, wd->btn);
 442
 443    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 444
 445    _theme_hook(obj);
 446
 447    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 448    // TODO: and save some bytes, making descriptions per-class and not instance!
 449    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 450
 451    _elm_access_object_register(obj, wd->btn);
 452    _elm_access_text_set(_elm_access_object_get(obj),
 453                         ELM_ACCESS_TYPE, E_("Button"));
 454    _elm_access_callback_set(_elm_access_object_get(obj),
 455                             ELM_ACCESS_INFO, _access_info_cb, obj);
 456    _elm_access_callback_set(_elm_access_object_get(obj),
 457                             ELM_ACCESS_STATE, _access_state_cb, obj);
 458    return obj;
 459 }
 460
 461 EAPI void
 462 elm_button_label_set(Evas_Object *obj, const char *label)
 463 {
 464    _elm_button_label_set(obj, NULL, label);
 465 }
 466
 467 EAPI const char *
 468 elm_button_label_get(const Evas_Object *obj)
 469 {
 470    return _elm_button_label_get(obj, NULL);
 471 }
 472
 473
 474 EAPI void
 475 elm_button_icon_set(Evas_Object *obj, Evas_Object *icon)
 476 {
 477    _content_set_hook(obj, NULL, icon);
 478 }
 479
 480 EAPI Evas_Object *
 481 elm_button_icon_get(const Evas_Object *obj)
 482 {
 483    return _content_get_hook(obj, NULL);
 484 }
 485
 486 EAPI Evas_Object *
 487 elm_button_icon_unset(Evas_Object *obj)
 488 {
 489    return _content_unset_hook(obj, NULL);
 490 }
 491
 492 EAPI void
 493 elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on)
 494 {
 495    ELM_CHECK_WIDTYPE(obj, widtype);
 496    Widget_Data *wd = elm_widget_data_get(obj);
 497    if (!wd) return;
 498    if (wd->timer)
 499      {
 500         ecore_timer_del(wd->timer);
 501         wd->timer = NULL;
 502      }
 503    wd->autorepeat = on;
 504    wd->repeating = EINA_FALSE;
 505 }
 506
 507 EAPI Eina_Bool
 508 elm_button_autorepeat_get(const Evas_Object *obj)
 509 {
 510    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 511    Widget_Data *wd = elm_widget_data_get(obj);
 512    if (!wd) return EINA_FALSE;
 513    return wd->autorepeat;
 514 }
 515
 516 EAPI void
 517 elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t)
 518 {
 519    ELM_CHECK_WIDTYPE(obj, widtype);
 520    Widget_Data *wd = elm_widget_data_get(obj);
 521    if (!wd) return;
 522    if (wd->ar_threshold == t) return;
 523    if (wd->timer)
 524      {
 525         ecore_timer_del(wd->timer);
 526         wd->timer = NULL;
 527      }
 528    wd->ar_threshold = t;
 529 }
 530
 531 EAPI double
 532 elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj)
 533 {
 534    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
 535    Widget_Data *wd = elm_widget_data_get(obj);
 536    if (!wd) return 0.0;
 537    return wd->ar_threshold;
 538 }
 539
 540 EAPI void
 541 elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t)
 542 {
 543    ELM_CHECK_WIDTYPE(obj, widtype);
 544    Widget_Data *wd = elm_widget_data_get(obj);
 545    if (!wd) return;
 546    if (wd->ar_interval == t) return;
 547
 548    wd->ar_interval = t;
 549    if ((wd->repeating) && (wd->timer)) ecore_timer_interval_set(wd->timer, t);
 550 }
 551
 552 EAPI double
 553 elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj)
 554 {
 555    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
 556    Widget_Data *wd = elm_widget_data_get(obj);
 557    if (!wd) return 0.0;
 558    return wd->ar_interval;
 559 }