src/lib/elm_scroller.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 /**
   5  * @defgroup Scroller Scroller
   6  * @ingroup Elementary
   7  *
   8  * A scroller holds a single object and "scrolls it around". This means that
   9  * it allows the user to use a scrollbar (or a finger) to drag the viewable
  10  * region around, allowing to move through a much larger object that is
  11  * contained in the scroller. The scroiller will always have a small minimum
  12  * size by default as it won't be limited by the contents of the scroller.
  13  *
  14  * Signals that you can add callbacks for are:
  15  *
  16  * edge,left - the left edge of the content has been reached
  17  *
  18  * edge,right - the right edge of the content has been reached
  19  *
  20  * edge,top - the top edge of the content has been reached
  21  *
  22  * edge,bottom - the bottom edge of the content has been reached
  23  *
  24  * scroll - the content has been scrolled (moved)
  25  *
  26  * scroll,anim,start - scrolling animation has started
  27  *
  28  * scroll,anim,stop - scrolling animation has stopped
  29  *
  30  * scroll,drag,start - dragging the contents around has started
  31  *
  32  * scroll,drag,stop - dragging the contents around has stopped
  33  */
  34 typedef struct _Widget_Data Widget_Data;
  35
  36 struct _Widget_Data
  37 {
  38    Evas_Object *scr;
  39    Evas_Object *content;
  40    const char *widget_name, *widget_base;
  41    Eina_Bool min_w : 1;
  42    Eina_Bool min_h : 1;
  43    double pagerel_h, pagerel_v;
  44    Evas_Coord pagesize_h, pagesize_v;
  45 };
  46
  47 static const char *widtype = NULL;
  48 static void _del_hook(Evas_Object *obj);
  49 static void _theme_hook(Evas_Object *obj);
  50 static void _show_region_hook(void *data, Evas_Object *obj);
  51 static void _sizing_eval(Evas_Object *obj);
  52 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  53 static void _on_focus_hook(void *data, Evas_Object *obj);
  54 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
  55                              Evas_Callback_Type type, void *event_info);
  56
  57
  58 static const char SIG_SCROLL[] = "scroll";
  59 static const char SIG_SCROLL_ANIM_START[] = "scroll,anim,start";
  60 static const char SIG_SCROLL_ANIM_STOP[] = "scroll,anim,stop";
  61 static const char SIG_SCROLL_DRAG_START[] = "scroll,drag,start";
  62 static const char SIG_SCROLL_DRAG_STOP[] = "scroll,drag,stop";
  63 static const char SIG_EDGE_LEFT[] = "edge,left";
  64 static const char SIG_EDGE_RIGHT[] = "edge,right";
  65 static const char SIG_EDGE_TOP[] = "edge,top";
  66 static const char SIG_EDGE_BOTTOM[] = "edge,bottom";
  67 static const Evas_Smart_Cb_Description _signals[] = {
  68   {SIG_SCROLL, ""},
  69   {SIG_SCROLL_ANIM_START, ""},
  70   {SIG_SCROLL_ANIM_STOP, ""},
  71   {SIG_SCROLL_DRAG_START, ""},
  72   {SIG_SCROLL_DRAG_STOP, ""},
  73   {SIG_EDGE_LEFT, ""},
  74   {SIG_EDGE_RIGHT, ""},
  75   {SIG_EDGE_TOP, ""},
  76   {SIG_EDGE_BOTTOM, ""},
  77   {NULL, NULL}
  78 };
  79
  80 static Eina_Bool
  81 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
  82 {
  83    if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
  84    Evas_Event_Key_Down *ev = event_info;
  85    Widget_Data *wd = elm_widget_data_get(obj);
  86    if (!wd) return EINA_FALSE;
  87    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
  88    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
  89
  90    Evas_Coord x = 0;
  91    Evas_Coord y = 0;
  92    Evas_Coord step_x = 0;
  93    Evas_Coord step_y = 0;
  94    Evas_Coord max_x = 0;
  95    Evas_Coord max_y = 0;
  96    Evas_Coord v_w = 0;
  97    Evas_Coord v_h = 0;
  98    Evas_Coord page_x = 0;
  99    Evas_Coord page_y = 0;
 100
 101    elm_smart_scroller_child_pos_get(wd->scr, &x, &y);
 102    elm_smart_scroller_step_size_get(wd->scr, &step_x, &step_y);
 103    elm_smart_scroller_page_size_get(wd->scr, &page_x, &page_y);
 104    elm_smart_scroller_child_viewport_size_get(wd->scr, &v_w, &v_h);
 105    elm_scroller_child_size_get(obj, &max_x, &max_y);
 106
 107    if ((!strcmp(ev->keyname, "Left")) || (!strcmp(ev->keyname, "KP_Left")))
 108      {
 109         x -= step_x;
 110      }
 111    else if ((!strcmp(ev->keyname, "Right")) || (!strcmp(ev->keyname, "KP_Right")))
 112      {
 113         x += step_x;
 114      }
 115    else if ((!strcmp(ev->keyname, "Up"))  || (!strcmp(ev->keyname, "KP_Up")))
 116      {
 117         y -= step_y;
 118      }
 119    else if ((!strcmp(ev->keyname, "Down")) || (!strcmp(ev->keyname, "KP_Down")))
 120      {
 121         y += step_y;
 122      }
 123    else if ((!strcmp(ev->keyname, "Home")) || (!strcmp(ev->keyname, "KP_Home")))
 124      {
 125         y = 0;
 126      }
 127    else if ((!strcmp(ev->keyname, "End")) || (!strcmp(ev->keyname, "KP_End")))
 128      {
 129         y = max_y - v_h;
 130      }
 131    else if ((!strcmp(ev->keyname, "Prior")) || (!strcmp(ev->keyname, "KP_Prior")))
 132      {
 133         if (page_y < 0)
 134           y -= -(page_y * v_h) / 100;
 135         else
 136            y -= page_y;
 137      }
 138    else if ((!strcmp(ev->keyname, "Next")) || (!strcmp(ev->keyname, "KP_Next")))
 139      {
 140         if (page_y < 0)
 141           y += -(page_y * v_h) / 100;
 142         else
 143           y += page_y;
 144      }
 145    else return EINA_FALSE;
 146
 147    ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 148    elm_smart_scroller_child_pos_set(wd->scr, x, y);
 149    return EINA_TRUE;
 150 }
 151
 152 static void
 153 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
 154 {
 155    Widget_Data *wd = elm_widget_data_get(obj);
 156    if (!wd) return;
 157    if (elm_widget_focus_get(obj))
 158      {
 159         edje_object_signal_emit(wd->scr, "elm,action,focus", "elm");
 160         evas_object_focus_set(wd->scr, EINA_TRUE);
 161      }
 162    else
 163      {
 164         edje_object_signal_emit(wd->scr, "elm,action,unfocus", "elm");
 165         evas_object_focus_set(wd->scr, EINA_FALSE);
 166      }
 167 }
 168
 169 static void
 170 _del_hook(Evas_Object *obj)
 171 {
 172    Widget_Data *wd = elm_widget_data_get(obj);
 173    if (!wd) return;
 174    free(wd);
 175 }
 176
 177 static void
 178 _theme_hook(Evas_Object *obj)
 179 {
 180    Widget_Data *wd = elm_widget_data_get(obj);
 181    if (!wd) return;
 182    if (wd->scr)
 183      {
 184         Evas_Object *edj;
 185         const char *str;
 186
 187         elm_smart_scroller_object_theme_set(obj, wd->scr,
 188                                             wd->widget_name, wd->widget_base,
 189                                             elm_widget_style_get(obj));
 190 //        edje_object_scale_set(wd->scr, elm_widget_scale_get(obj) * _elm_config->scale);
 191         edj = elm_smart_scroller_edje_object_get(wd->scr);
 192         str = edje_object_data_get(edj, "focus_highlight");
 193         if ((str) && (!strcmp(str, "on")))
 194           elm_widget_highlight_in_theme_set(obj, EINA_TRUE);
 195         else
 196           elm_widget_highlight_in_theme_set(obj, EINA_FALSE);
 197      }
 198    _sizing_eval(obj);
 199 }
 200
 201 static Eina_Bool
 202 _elm_scroller_focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next)
 203 {
 204    Widget_Data *wd = elm_widget_data_get(obj);
 205    Evas_Object *cur;
 206
 207    if ((!wd) || (!wd->content))
 208      return EINA_FALSE;
 209
 210    cur = wd->content;
 211
 212    /* Try Focus cycle in subitem */
 213    if ((elm_widget_can_focus_get(cur)) || (elm_widget_child_can_focus_get(cur)))
 214       return elm_widget_focus_next_get(cur, dir, next);
 215
 216    /* Return */
 217    *next = (Evas_Object *)obj;
 218    return !elm_widget_focus_get(obj);
 219 }
 220
 221 static void
 222 _signal_emit_hook(Evas_Object *obj, const char *emission, const char *source)
 223 {
 224    Widget_Data *wd = elm_widget_data_get(obj);
 225    if (!wd) return;
 226    edje_object_signal_emit(elm_smart_scroller_edje_object_get(wd->scr),
 227          emission, source);
 228 }
 229
 230 static void
 231 _signal_callback_add_hook(Evas_Object *obj, const char *emission, const char *source, void (*func_cb) (void *data, Evas_Object *o, const char *emission, const char *source), void *data)
 232 {
 233    Widget_Data *wd = elm_widget_data_get(obj);
 234    if (!wd) return;
 235    edje_object_signal_callback_add(elm_smart_scroller_edje_object_get(wd->scr),
 236          emission, source, func_cb, data);
 237 }
 238
 239 static void
 240 _signal_callback_del_hook(Evas_Object *obj, const char *emission, const char *source, void (*func_cb) (void *data, Evas_Object *o, const char *emission, const char *source), void *data)
 241 {
 242    Widget_Data *wd = elm_widget_data_get(obj);
 243    edje_object_signal_callback_del_full(
 244          elm_smart_scroller_edje_object_get(wd->scr), emission, source,
 245          func_cb, data);
 246 }
 247
 248 static void
 249 _show_region_hook(void *data, Evas_Object *obj)
 250 {
 251    Widget_Data *wd = elm_widget_data_get(data);
 252    Evas_Coord x, y, w, h;
 253    if (!wd) return;
 254    elm_widget_show_region_get(obj, &x, &y, &w, &h);
 255    elm_scroller_region_show(data, x, y, w, h);
 256    if (wd->scr)
 257       elm_smart_scroller_child_region_show(wd->scr, x, y, w, h);
 258 }
 259
 260 static void
 261 _focus_region_hook(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 262 {
 263    elm_scroller_region_show(obj, x, y, w, h);
 264 }
 265
 266 static void
 267 _sizing_eval(Evas_Object *obj)
 268 {
 269    Widget_Data *wd = elm_widget_data_get(obj);
 270    Evas_Coord  vw, vh, minw, minh, maxw, maxh, w, h, vmw, vmh;
 271    double xw, yw;
 272
 273    if (!wd) return;
 274    evas_object_size_hint_min_get(wd->content, &minw, &minh);
 275    evas_object_size_hint_max_get(wd->content, &maxw, &maxh);
 276    evas_object_size_hint_weight_get(wd->content, &xw, &yw);
 277    if (wd->scr)
 278      {
 279         elm_smart_scroller_child_viewport_size_get(wd->scr, &vw, &vh);
 280         if (xw > 0.0)
 281           {
 282              if ((minw > 0) && (vw < minw)) vw = minw;
 283              else if ((maxw > 0) && (vw > maxw)) vw = maxw;
 284           }
 285         else if (minw > 0) vw = minw;
 286         if (yw > 0.0)
 287           {
 288              if ((minh > 0) && (vh < minh)) vh = minh;
 289              else if ((maxh > 0) && (vh > maxh)) vh = maxh;
 290           }
 291         else if (minh > 0) vh = minh;
 292         evas_object_resize(wd->content, vw, vh);
 293         w = -1;
 294         h = -1;
 295         edje_object_size_min_calc(elm_smart_scroller_edje_object_get(wd->scr), &vmw, &vmh);
 296         if (wd->min_w) w = vmw + minw;
 297         if (wd->min_h) h = vmh + minh;
 298         evas_object_size_hint_max_get(obj, &maxw, &maxh);
 299         if ((maxw > 0) && (w > maxw)) w = maxw;
 300         if ((maxh > 0) && (h > maxh)) h = maxh;
 301         evas_object_size_hint_min_set(obj, w, h);
 302      }
 303 }
 304
 305 static void
 306 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 307 {
 308    _sizing_eval(data);
 309 }
 310
 311 static void
 312 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 313 {
 314    Widget_Data *wd = elm_widget_data_get(obj);
 315    Evas_Object *sub = event_info;
 316
 317    if (!wd) return;
 318    if (sub == wd->content)
 319      {
 320         elm_widget_on_show_region_hook_set(wd->content, NULL, NULL);
 321         evas_object_event_callback_del_full (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 322            _changed_size_hints, obj);
 323         wd->content = NULL;
 324         _sizing_eval(obj);
 325      }
 326    else if (sub == wd->scr)
 327      wd->scr = NULL;
 328 }
 329
 330 static void
 331 _hold_on(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 332 {
 333    Widget_Data *wd = elm_widget_data_get(obj);
 334
 335    if (!wd) return;
 336    if (wd->scr)
 337      elm_smart_scroller_hold_set(wd->scr, 1);
 338 }
 339
 340 static void
 341 _hold_off(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 342 {
 343    Widget_Data *wd = elm_widget_data_get(obj);
 344
 345    if (!wd) return;
 346    if (wd->scr)
 347      elm_smart_scroller_hold_set(wd->scr, 0);
 348 }
 349
 350 static void
 351 _freeze_on(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 352 {
 353    Widget_Data *wd = elm_widget_data_get(obj);
 354
 355    if (!wd) return;
 356    if (wd->scr)
 357      elm_smart_scroller_freeze_set(wd->scr, 1);
 358 }
 359
 360 static void
 361 _freeze_off(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 362 {
 363    Widget_Data *wd = elm_widget_data_get(obj);
 364
 365    if (!wd) return;
 366    if (wd->scr)
 367      elm_smart_scroller_freeze_set(wd->scr, 0);
 368 }
 369
 370 static void
 371 _resize(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 372 {
 373    _sizing_eval(data);
 374 }
 375
 376 static void
 377 _edge_left(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 378 {
 379    evas_object_smart_callback_call(data, SIG_EDGE_LEFT, NULL);
 380 }
 381
 382 static void
 383 _edge_right(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 384 {
 385    evas_object_smart_callback_call(data, SIG_EDGE_RIGHT, NULL);
 386 }
 387
 388 static void
 389 _edge_top(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 390 {
 391    evas_object_smart_callback_call(data, SIG_EDGE_TOP, NULL);
 392 }
 393
 394 static void
 395 _edge_bottom(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 396 {
 397    evas_object_smart_callback_call(data, SIG_EDGE_BOTTOM, NULL);
 398 }
 399
 400 static void
 401 _scroll(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 402 {
 403    evas_object_smart_callback_call(data, SIG_SCROLL, NULL);
 404 }
 405
 406 static void
 407 _scroll_anim_start(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 408 {
 409    evas_object_smart_callback_call(data, SIG_SCROLL_ANIM_START, NULL);
 410 }
 411
 412 static void
 413 _scroll_anim_stop(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 414 {
 415    evas_object_smart_callback_call(data, SIG_SCROLL_ANIM_STOP, NULL);
 416 }
 417
 418 static void
 419 _scroll_drag_start(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 420 {
 421    evas_object_smart_callback_call(data, SIG_SCROLL_DRAG_START, NULL);
 422 }
 423
 424 static void
 425 _scroll_drag_stop(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
 426 {
 427    evas_object_smart_callback_call(data, SIG_SCROLL_DRAG_STOP, NULL);
 428 }
 429
 430 /**
 431  * Add a new scroller to the parent
 432  *
 433  * @param parent The parent object
 434  * @return The new object or NULL if it cannot be created
 435  *
 436  * @ingroup Scroller
 437  */
 438 EAPI Evas_Object *
 439 elm_scroller_add(Evas_Object *parent)
 440 {
 441    Evas_Object *obj;
 442    Evas *e;
 443    Widget_Data *wd;
 444    Evas_Coord minw, minh;
 445
 446    EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
 447
 448    wd = ELM_NEW(Widget_Data);
 449    e = evas_object_evas_get(parent);
 450    if (!e) return NULL;
 451    obj = elm_widget_add(e);
 452    ELM_SET_WIDTYPE(widtype, "scroller");
 453    elm_widget_type_set(obj, "scroller");
 454    elm_widget_sub_object_add(parent, obj);
 455    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 456    elm_widget_data_set(obj, wd);
 457    elm_widget_del_hook_set(obj, _del_hook);
 458    elm_widget_theme_hook_set(obj, _theme_hook);
 459    elm_widget_signal_emit_hook_set(obj, _signal_emit_hook);
 460    elm_widget_signal_callback_add_hook_set(obj, _signal_callback_add_hook);
 461    elm_widget_signal_callback_del_hook_set(obj, _signal_callback_del_hook);
 462    elm_widget_focus_next_hook_set(obj, _elm_scroller_focus_next_hook);
 463    elm_widget_can_focus_set(obj, EINA_TRUE);
 464    elm_widget_event_hook_set(obj, _event_hook);
 465    elm_widget_focus_region_hook_set(obj, _focus_region_hook);
 466
 467    wd->widget_name = eina_stringshare_add("scroller");
 468    wd->widget_base = eina_stringshare_add("base");
 469
 470    wd->scr = elm_smart_scroller_add(e);
 471    elm_smart_scroller_widget_set(wd->scr, obj);
 472    _theme_hook(obj);
 473    elm_widget_resize_object_set(obj, wd->scr);
 474    evas_object_event_callback_add(wd->scr, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 475                                   _changed_size_hints, obj);
 476
 477    edje_object_size_min_calc(elm_smart_scroller_edje_object_get(wd->scr), &minw, &minh);
 478    evas_object_size_hint_min_set(obj, minw, minh);
 479    evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE, _resize, obj);
 480
 481    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 482    evas_object_smart_callback_add(obj, "scroll-hold-on", _hold_on, obj);
 483    evas_object_smart_callback_add(obj, "scroll-hold-off", _hold_off, obj);
 484    evas_object_smart_callback_add(obj, "scroll-freeze-on", _freeze_on, obj);
 485    evas_object_smart_callback_add(obj, "scroll-freeze-off", _freeze_off, obj);
 486
 487    evas_object_smart_callback_add(wd->scr, "edge,left", _edge_left, obj);
 488    evas_object_smart_callback_add(wd->scr, "edge,right", _edge_right, obj);
 489    evas_object_smart_callback_add(wd->scr, "edge,top", _edge_top, obj);
 490    evas_object_smart_callback_add(wd->scr, "edge,bottom", _edge_bottom, obj);
 491    evas_object_smart_callback_add(wd->scr, "scroll", _scroll, obj);
 492    evas_object_smart_callback_add(wd->scr, "animate,start", _scroll_anim_start, obj);
 493    evas_object_smart_callback_add(wd->scr, "animate,stop", _scroll_anim_stop, obj);
 494    evas_object_smart_callback_add(wd->scr, "drag,start", _scroll_drag_start, obj);
 495    evas_object_smart_callback_add(wd->scr, "drag,stop", _scroll_drag_stop, obj);
 496
 497    _sizing_eval(obj);
 498
 499    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 500    // TODO: and save some bytes, making descriptions per-class and not instance!
 501    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 502    return obj;
 503 }
 504
 505 Evas_Object *
 506 _elm_scroller_edje_object_get(Evas_Object *obj)
 507 {
 508    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 509    Widget_Data *wd = elm_widget_data_get(obj);
 510    if (!wd) return NULL;
 511    return elm_smart_scroller_edje_object_get(wd->scr);
 512 }
 513
 514 /**
 515  * Set the content of the scroller widget (the object to be scrolled around).
 516  *
 517  * Once the content object is set, a previously set one will be deleted.
 518  * If you want to keep that old content object, use the
 519  * elm_scroller_content_unset() function.
 520  *
 521  * @param obj The scroller object
 522  * @param content The new content object
 523  *
 524  * @ingroup Scroller
 525  */
 526 EAPI void
 527 elm_scroller_content_set(Evas_Object *obj, Evas_Object *content)
 528 {
 529    ELM_CHECK_WIDTYPE(obj, widtype);
 530    Widget_Data *wd = elm_widget_data_get(obj);
 531    if (!wd) return;
 532    if (wd->content == content) return;
 533    if (wd->content) evas_object_del(wd->content);
 534
 535    wd->content = content;
 536    if (content)
 537      {
 538         elm_widget_on_show_region_hook_set(content, _show_region_hook, obj);
 539         elm_widget_sub_object_add(obj, content);
 540         if (wd->scr)
 541           elm_smart_scroller_child_set(wd->scr, content);
 542         evas_object_event_callback_add(content, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 543                                        _changed_size_hints, obj);
 544      }
 545    _sizing_eval(obj);
 546 }
 547
 548 /**
 549  * Get the content of the scroller widget
 550  *
 551  * Return the content object which is set for this widget
 552  *
 553  * @param obj The slider object
 554  * @return The content that is being used
 555  *
 556  * @ingroup Scroller
 557  */
 558 EAPI Evas_Object *
 559 elm_scroller_content_get(const Evas_Object *obj)
 560 {
 561    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 562    Widget_Data *wd = elm_widget_data_get(obj);
 563    if (!wd) return NULL;
 564    return wd->content;
 565 }
 566
 567 /**
 568  * Unset the content of the scroller widget
 569  *
 570  * Unparent and return the content object which was set for this widget
 571  *
 572  * @param obj The slider object
 573  * @return The content that was being used
 574  *
 575  * @ingroup Scroller
 576  */
 577 EAPI Evas_Object *
 578 elm_scroller_content_unset(Evas_Object *obj)
 579 {
 580    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 581    Widget_Data *wd = elm_widget_data_get(obj);
 582    Evas_Object *content;
 583    if (!wd) return NULL;
 584    if (!wd->content) return NULL;
 585    content = wd->content;
 586    elm_widget_sub_object_del(obj, wd->content);
 587    edje_object_part_unswallow(wd->scr, wd->content);
 588    wd->content = NULL;
 589    return content;
 590 }
 591
 592 /**
 593  * Set custom theme elements for the scroller
 594  *
 595  * @param obj The scroller object
 596  * @param widget The widget name to use (default is "scroller")
 597  * @param base The base name to use (default is "base")
 598  *
 599  * @ingroup Scroller
 600  */
 601 EAPI void
 602 elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base)
 603 {
 604    ELM_CHECK_WIDTYPE(obj, widtype);
 605    Widget_Data *wd = elm_widget_data_get(obj);
 606    if (!wd) return;
 607    EINA_SAFETY_ON_NULL_RETURN(widget);
 608    EINA_SAFETY_ON_NULL_RETURN(base);
 609    if (eina_stringshare_replace(&wd->widget_name, widget) |
 610        eina_stringshare_replace(&wd->widget_base, base))
 611      _theme_hook(obj);
 612 }
 613
 614 /**
 615  * Make the scroller minimum size limited to the minimum size of the content
 616  *
 617  * By default the scroller will be as small as its design allows, irrespective
 618  * of its content. This will make the scroller minimum size the right size
 619  * horizontally and/or vertically to perfectly fit its content.
 620  *
 621  * @param obj The scroller object
 622  * @param w Enable limiting minimum size horizontally
 623  * @param h Enable limiting minimum size vertically
 624  *
 625  * @ingroup Scroller
 626  */
 627 EAPI void
 628 elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h)
 629 {
 630    ELM_CHECK_WIDTYPE(obj, widtype);
 631    Widget_Data *wd = elm_widget_data_get(obj);
 632    if (!wd) return;
 633    wd->min_w = w;
 634    wd->min_h = h;
 635    _sizing_eval(obj);
 636 }
 637
 638 /**
 639  * Show a specific virtual region within the scroller content object
 640  *
 641  * This will ensure all (or part if it does not fit) of the designated
 642  * region in the virtual content object (0, 0 starting at the top-left of the
 643  * virtual content object) is shown within the scroller.
 644  *
 645  * @param obj The scroller object
 646  * @param x X coordinate of the region
 647  * @param y Y coordinate of the region
 648  * @param w Width of the region
 649  * @param h Height of the region
 650  *
 651  * @ingroup Scroller
 652  */
 653 EAPI void
 654 elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 655 {
 656    ELM_CHECK_WIDTYPE(obj, widtype);
 657    Widget_Data *wd = elm_widget_data_get(obj);
 658    if ((!wd) || (!wd->scr)) return;
 659
 660    elm_smart_scroller_child_region_show(wd->scr, x, y, w, h);
 661 }
 662
 663 /**
 664  * Set the scroller scrollbar policy
 665  *
 666  * This sets the scrollbar visibility policy for the given scroller.
 667  * ELM_SMART_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
 668  * is needed, and otherwise kept hidden. ELM_SMART_SCROLLER_POLICY_ON turns
 669  * it on all the time, and ELM_SMART_SCROLLER_POLICY_OFF always keeps it off.
 670  * This applies respectively for the horizontal and vertical scrollbars.
 671  *
 672  * @param obj The scroller object
 673  * @param policy_h Horizontal scrollbar policy
 674  * @param policy_v Vertical scrollbar policy
 675  *
 676  * @ingroup Scroller
 677  */
 678 EAPI void
 679 elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v)
 680 {
 681    ELM_CHECK_WIDTYPE(obj, widtype);
 682    Widget_Data *wd = elm_widget_data_get(obj);
 683    const Elm_Scroller_Policy map[3] =
 684      {
 685         ELM_SMART_SCROLLER_POLICY_AUTO,
 686           ELM_SMART_SCROLLER_POLICY_ON,
 687           ELM_SMART_SCROLLER_POLICY_OFF
 688      };
 689    if ((!wd) || (!wd->scr)) return;
 690    if ((policy_h >= 3) || (policy_v >= 3)) return;
 691    elm_smart_scroller_policy_set(wd->scr, map[policy_h], map[policy_v]);
 692 }
 693
 694 EAPI void
 695 elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v)
 696 {
 697    ELM_CHECK_WIDTYPE(obj, widtype);
 698    Widget_Data *wd = elm_widget_data_get(obj);
 699    if ((!wd) || (!wd->scr)) return;
 700    elm_smart_scroller_policy_get(wd->scr,
 701                                  (Elm_Smart_Scroller_Policy *) policy_h,
 702                                  (Elm_Smart_Scroller_Policy *) policy_v);
 703 }
 704
 705 /**
 706  * Get the currently visible content region
 707  *
 708  * This gets the current region in the content object that is visible through
 709  * the scroller. Also see elm_scroller_region_show(). The region co-ordinates
 710  * are returned in the @p x, @p y, @p w, @p h values pointed to.
 711  *
 712  * @param obj The scroller object
 713  * @param x X coordinate of the region
 714  * @param y Y coordinate of the region
 715  * @param w Width of the region
 716  * @param h Height of the region
 717  *
 718  * @ingroup Scroller
 719  */
 720 EAPI void
 721 elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 722 {
 723    ELM_CHECK_WIDTYPE(obj, widtype);
 724    Widget_Data *wd = elm_widget_data_get(obj);
 725    if ((!wd) || (!wd->scr)) return;
 726    if ((x) || (y)) elm_smart_scroller_child_pos_get(wd->scr, x, y);
 727    if ((w) || (h)) elm_smart_scroller_child_viewport_size_get(wd->scr, w, h);
 728 }
 729
 730 /**
 731  * Get the size of the content child object
 732  *
 733  * This gets the size of the child object of the scroller. Actually the
 734  * content of a scroller doesn't specifically need to be an actual object
 735  * as it can be virtual and defined purely by callbacks.
 736  *
 737  * @param obj The scroller object
 738  * @param w Width return
 739  * @param h Height return
 740  *
 741  * @ingroup Scroller
 742  */
 743 EAPI void
 744 elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
 745 {
 746    ELM_CHECK_WIDTYPE(obj, widtype);
 747    Widget_Data *wd = elm_widget_data_get(obj);
 748    if (!wd) return;
 749    evas_object_geometry_get(wd->content, NULL, NULL, w, h);
 750 }
 751
 752 /**
 753  * Set bouncing behavior
 754  *
 755  * When scrolling, the scroller may "bounce" when reaching an edge of the child
 756  * object. This is a visual way to indicate the end has been reached. This is
 757  * enabled by default for both axes. This will set if it is enabled for that
 758  * axis with the boolean parameters for each axis.
 759  *
 760  * @param obj The scroller object
 761  * @param h_bounce Will the scroller bounce horizontally or not
 762  * @param v_bounce Will the scroller bounce vertically or not
 763  *
 764  * @ingroup Scroller
 765  */
 766 EAPI void
 767 elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
 768 {
 769    ELM_CHECK_WIDTYPE(obj, widtype);
 770    Widget_Data *wd = elm_widget_data_get(obj);
 771    if ((!wd) || (!wd->scr)) return;
 772    elm_smart_scroller_bounce_allow_set(wd->scr, h_bounce, v_bounce);
 773 }
 774
 775 /**
 776  * Get the bounce mode
 777  *
 778  * @param obj The Scroller object
 779  * @param h_bounce Allow bounce horizontally
 780  * @param v_bounce Allow bounce vertically
 781  *
 782  * @ingroup Scroller
 783  */
 784 EAPI void
 785 elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
 786 {
 787    ELM_CHECK_WIDTYPE(obj, widtype);
 788    Widget_Data *wd = elm_widget_data_get(obj);
 789    if (!wd) return;
 790    elm_smart_scroller_bounce_allow_get(wd->scr, h_bounce, v_bounce);
 791 }
 792
 793 /**
 794  * Set scroll page size relative to viewport size.
 795  *
 796  * The scroller is capable of limiting scrolling by the user to "pages". That
 797  * is to jump by and only show a "whole page" at a time as if the continuous
 798  * area of the scroller content is split into page sized pieces. This sets
 799  * the size of a page relative to the viewport of the scroller. 1.0 is "1
 800  * viewport" is size (horizontally or vertically). 0.0 turns it off in that
 801  * axis. This is mutually exclusive with page size
 802  * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
 803  * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
 804  * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
 805  * the other axis.
 806  *
 807  * @param obj The scroller object
 808  * @param h_pagerel The horizontal page relative size
 809  * @param v_pagerel The vertical page relative size
 810  *
 811  * @ingroup Scroller
 812  */
 813 EAPI void
 814 elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel)
 815 {
 816    ELM_CHECK_WIDTYPE(obj, widtype);
 817    Widget_Data *wd = elm_widget_data_get(obj);
 818    if (!wd) return;
 819    wd->pagerel_h = h_pagerel;
 820    wd->pagerel_v = v_pagerel;
 821    if (wd->scr)
 822      elm_smart_scroller_paging_set(wd->scr, wd->pagerel_h, wd->pagerel_v,
 823                                    wd->pagesize_h, wd->pagesize_v);
 824 }
 825
 826 /**
 827  * Set scroll page size.
 828  *
 829  * See also elm_scroller_page_relative_set(). This, instead of a page size
 830  * being relative to the viewport, sets it to an absolute fixed value, with
 831  * 0 turning it off for that axis.
 832  *
 833  * @param obj The scroller object
 834  * @param h_pagesize The horizontal page size
 835  * @param v_pagesize The vertical page size
 836  *
 837  * @ingroup Scroller
 838  */
 839 EAPI void
 840 elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize)
 841 {
 842    ELM_CHECK_WIDTYPE(obj, widtype);
 843    Widget_Data *wd = elm_widget_data_get(obj);
 844    if (!wd) return;
 845    wd->pagesize_h = h_pagesize;
 846    wd->pagesize_v = v_pagesize;
 847    if (wd->scr)
 848      elm_smart_scroller_paging_set(wd->scr, wd->pagerel_h, wd->pagerel_v,
 849                                    wd->pagesize_h, wd->pagesize_v);
 850 }
 851
 852 /**
 853  * Show a specific virtual region within the scroller content object.
 854  *
 855  * This will ensure all (or part if it does not fit) of the designated
 856  * region in the virtual content object (0, 0 starting at the top-left of the
 857  * virtual content object) is shown within the scroller. Unlike
 858  * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
 859  * to this location (if configuration in general calls for transitions). It
 860  * may not jump immediately to the new location and make take a while and
 861  * show other content along the way.
 862  *
 863  * @param obj The scroller object
 864  * @param x X coordinate of the region
 865  * @param y Y coordinate of the region
 866  * @param w Width of the region
 867  * @param h Height of the region
 868  *
 869  * @ingroup Scroller
 870  */
 871 EAPI void
 872 elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h)
 873 {
 874    ELM_CHECK_WIDTYPE(obj, widtype);
 875    Widget_Data *wd = elm_widget_data_get(obj);
 876    if ((!wd) || (!wd->scr)) return;
 877
 878    elm_smart_scroller_region_bring_in(wd->scr, x, y, w, h);
 879 }
 880
 881
 882 /**
 883  * Set event propagation on a scroller
 884  *
 885  * This enables or disabled event propagation from the scroller content to
 886  * the scroller and its parent. By default event propagation is disabled.
 887  *
 888  * @param obj The scroller object
 889  * @param propagation If propagation is enabled or not
 890  *
 891  * @ingroup Scroller
 892  */
 893 EAPI void
 894 elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation)
 895 {
 896    ELM_CHECK_WIDTYPE(obj, widtype);
 897    Widget_Data *wd = elm_widget_data_get(obj);
 898    if (!wd) return;
 899
 900    elm_smart_scroller_propagate_events_set(wd->scr, propagation);
 901 }
 902
 903 /**
 904  * Get event propagation for a scroller
 905  *
 906  * This gets the event propagation for a scroller. See
 907  * elm_scroller_propagate_events_set() for more information
 908  *
 909  * @param obj The scroller object
 910  * @return The propagation state
 911  *
 912  * @ingroup Scroller
 913  */
 914 EAPI Eina_Bool
 915 elm_scroller_propagate_events_get(const Evas_Object *obj)
 916 {
 917    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 918    Widget_Data *wd = elm_widget_data_get(obj);
 919    if (!wd) return EINA_FALSE;
 920
 921    return elm_smart_scroller_propagate_events_get(wd->scr);
 922 }
 923
 924
 925
 926 EAPI void
 927 elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set)
 928 {
 929    return ;
 930 }