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