lv_obj_scroll.h

API reference for lv_obj_scroll.h

Summary

Functions

Set how the scrollbars should behave.

void lv_obj_set_scrollbar_mode(lv_obj_t *obj, lv_scrollbar_mode_t mode)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`mode`	`lv_scrollbar_mode_t`	LV_SCROLL_MODE_ON/OFF/AUTO/ACTIVE

Set direction Widget can be scrolled

void lv_obj_set_scroll_dir(lv_obj_t *obj, lv_dir_t dir)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`dir`	`lv_dir_t`	one or more bit-wise OR-ed values of `lv_dir_t` enumeration

Set where to snap the children when scrolling ends horizontally

void lv_obj_set_scroll_snap_x(lv_obj_t *obj, lv_scroll_snap_t align)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`align`	`lv_scroll_snap_t`	value from `lv_scroll_snap_t` enumeration

Set where to snap the children when scrolling ends vertically

void lv_obj_set_scroll_snap_y(lv_obj_t *obj, lv_scroll_snap_t align)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`align`	`lv_scroll_snap_t`	value from `lv_scroll_snap_t` enumeration

Scrollbar modes: shows when should the scrollbars be visible

Name	Description
`LV_SCROLLBAR_MODE_OFF`	Never show scrollbars
`LV_SCROLLBAR_MODE_ON`	Always show scrollbars
`LV_SCROLLBAR_MODE_ACTIVE`	Show scroll bars when Widget is being scrolled
`LV_SCROLLBAR_MODE_AUTO`	Show scroll bars when the content is large enough to be scrolled

Used by 1 function

Scroll span align options. Tells where to align the snappable children when scroll stops.

Used by 2 functions

Indirect dependencies