Efl.Ui.Scrollable (interface)

Description

Interface for widgets capable of displaying content through a viewport, which might be smaller than the actual content. This interface does not control how the content is added. This is typically done through Efl.Content.

When the content does not fit inside the viewport, typically Efl.Ui.Scrollbar widgets will be used, but this is beyond the scope of this interface.

Since 1.23

Members

bounce_enabled (get, set)

When scrolling, the scroller may "bounce" when reaching the edge of the content object. This is a visual way to indicate the end has been reached. This is enabled by default for both axes. This property determines if bouncing is enabled in each axis. When bouncing is disabled, scrolling just stops upon reaching the end of the content.
void efl_ui_scrollable_bounce_enabled_get(const Eo *obj, Eina_Bool *horiz, Eina_Bool *vert);
void efl_ui_scrollable_bounce_enabled_set(Eo *obj, Eina_Bool horiz, Eina_Bool vert);


content_pos (get, set)

Position of the content inside the scroller.
Eina_Position2D efl_ui_scrollable_content_pos_get(const Eo *obj);
void efl_ui_scrollable_content_pos_set(Eo *obj, Eina_Position2D pos);


content_size (get)

Eina_Size2D efl_ui_scrollable_content_size_get(const Eo *obj);


gravity (get, set)

Control scrolling gravity on the scrollable.
void efl_ui_scrollable_gravity_get(const Eo *obj, double *x, double *y);
void efl_ui_scrollable_gravity_set(Eo *obj, double x, double y);


looping (get, set)

Controls infinite looping for a scroller.
void efl_ui_scrollable_looping_get(const Eo *obj, Eina_Bool *loop_h, Eina_Bool *loop_v);
void efl_ui_scrollable_looping_set(Eo *obj, Eina_Bool loop_h, Eina_Bool loop_v);


match_content (set)

void efl_ui_scrollable_match_content_set(Eo *obj, Eina_Bool w, Eina_Bool h);


movement_block (get, set)

Blocking of scrolling (per axis).
Efl_Ui_Layout_Orientation efl_ui_scrollable_movement_block_get(const Eo *obj);
void efl_ui_scrollable_movement_block_set(Eo *obj, Efl_Ui_Layout_Orientation block);


scroll

Show a specific virtual region within the scroller content object.
void efl_ui_scrollable_scroll(Eo *obj, Eina_Rect rect, Eina_Bool animation);


scroll_freeze (get, set)

Freezes scrolling movement (by input of a user). Unlike Efl.Ui.Scrollable.movement_block, this property freezes bidirectionally. If you want to freeze in only one direction, see Efl.Ui.Scrollable.movement_block.
Eina_Bool efl_ui_scrollable_scroll_freeze_get(const Eo *obj);
void efl_ui_scrollable_scroll_freeze_set(Eo *obj, Eina_Bool freeze);


scroll_hold (get, set)

When hold turns on, it only scrolls by holding action.
Eina_Bool efl_ui_scrollable_scroll_hold_get(const Eo *obj);
void efl_ui_scrollable_scroll_hold_set(Eo *obj, Eina_Bool hold);


step_size (get, set)

Amount to scroll in response to cursor key presses.
Eina_Position2D efl_ui_scrollable_step_size_get(const Eo *obj);
void efl_ui_scrollable_step_size_set(Eo *obj, Eina_Position2D step);


viewport_geometry (get)

Eina_Rect efl_ui_scrollable_viewport_geometry_get(const Eo *obj);


Events

edge,down

Called when hitting the bottom edge.
EFL_UI_EVENT_EDGE_DOWN(void)


edge,left

Called when hitting the left edge.
EFL_UI_EVENT_EDGE_LEFT(void)


edge,right

Called when hitting the right edge.
EFL_UI_EVENT_EDGE_RIGHT(void)


edge,up

Called when hitting the top edge.
EFL_UI_EVENT_EDGE_UP(void)


scroll,anim,finished

Called when scroll animation finishes.
EFL_UI_EVENT_SCROLL_ANIM_FINISHED(void)


scroll,anim,started

Called when scroll animation starts.
EFL_UI_EVENT_SCROLL_ANIM_STARTED(void)


scroll,changed

Called when scrolling.
EFL_UI_EVENT_SCROLL_CHANGED(void)


scroll,down

Called when scrolling downwards.
EFL_UI_EVENT_SCROLL_DOWN(void)


scroll,drag,finished

Called when scroll drag finishes.
EFL_UI_EVENT_SCROLL_DRAG_FINISHED(void)


scroll,drag,started

Called when scroll drag starts.
EFL_UI_EVENT_SCROLL_DRAG_STARTED(void)


scroll,finished

Called when scroll operation finishes.
EFL_UI_EVENT_SCROLL_FINISHED(void)


scroll,left

Called when scrolling left.
EFL_UI_EVENT_SCROLL_LEFT(void)


scroll,right

Called when scrolling right.
EFL_UI_EVENT_SCROLL_RIGHT(void)


scroll,started

Called when scroll operation starts.
EFL_UI_EVENT_SCROLL_STARTED(void)


scroll,up

Called when scrolling upwards.
EFL_UI_EVENT_SCROLL_UP(void)