Scrolling
Overview
In LVGL scrolling works very intuitively: if a Widget is outside its parent content area (the size without padding), the parent becomes scrollable and scrollbar(s) will appear. That's it.
Any Widget can be scrollable including Base Widget, lv_image
,
lv_button
, lv_meter
, etc
The Widget can either be scrolled horizontally or vertically in one stroke; diagonal scrolling is not possible.
Scrollbar
Mode
Scrollbars are displayed according to the configured scrollbar-mode
. The
following modes are available:
LV_SCROLLBAR_MODE_OFF
: Never show the scrollbarsLV_SCROLLBAR_MODE_ON
: Always show the scrollbarsLV_SCROLLBAR_MODE_ACTIVE
: Show scroll bars while a Widget is being scrolledLV_SCROLLBAR_MODE_AUTO
: Show scroll bars when the content is large enough to be scrolled
lv_obj_set_scrollbar_mode(widget, LV_SCROLLBAR_MODE_...) sets the scrollbar mode on a Widget.
Styling
A Scrollbar is a dedicated part of a Widget, called
LV_PART_SCROLLBAR
. For example, a scrollbar can turn to red like
this:
static lv_style_t style_red;
lv_style_init(&style_red);
lv_style_set_bg_color(&style_red, lv_color_red());
...
lv_obj_add_style(widget, &style_red, LV_PART_SCROLLBAR);
A Widget goes to the LV_STATE_SCROLLED
state while it's being
scrolled. This allows adding different styles to the Widget that will be effective
while it is being scrolled. For example, this code makes the scrollbar blue while
the Widget is being scrolled:
static lv_style_t style_blue;
lv_style_init(&style_blue);
lv_style_set_bg_color(&style_blue, lv_color_blue());
...
lv_obj_add_style(widget, &style_blue, LV_STATE_SCROLLED | LV_PART_SCROLLBAR);
If the base direction of the LV_PART_SCROLLBAR
is RTL
(LV_BASE_DIR_RTL
) the vertical scrollbar will be placed on the left.
Note that, the base_dir
style property is inherited. Therefore, it
can be set directly on the LV_PART_SCROLLBAR
part of a Widget, or
on the Widget's LV_PART_MAIN part, or that of any of its parents, to make a scrollbar
inherit the base direction.
pad_left/right/top/bottom
sets the spacing around the scrollbars,
width
sets the scrollbar's width and length
sets the scrollbar's length:
If length is not set or left at 0 the scrollbar's length will be set automatically according to the length of the content.
.. code-block:: c
static lv_style_t style_scrollbar; lv_style_init(&style_scrollbar); lv_style_set_pad_left(&style_scrollbar, 2); lv_style_set_pad_right(&style_scrollbar, 2); lv_style_set_pad_top(&style_scrollbar, 2); lv_style_set_pad_bottom(&style_scrollbar, 2); lv_style_set_width(&style_scrollbar, 10); lv_style_set_length(&style_scrollbar, 50);
...
lv_obj_add_style(widget, &style_scrollbar, LV_PART_SCROLLBAR);
The minimum length of the scrollbar is fixed to 10, while its maximum length is limited by the Widget's height or width, depending on whether the scrollbar is vertical or horizontal. Any length value set outside of these limits will automatically result in a length fixed to either limit.
Scrolling Events
The following events are emitted as part of scrolling:
LV_EVENT_SCROLL_BEGIN
: Signals that scrolling has begun. The event parameter isNULL
or anlv_anim_t *
with a scroll animation descriptor that can be modified if required.LV_EVENT_SCROLL_END
: Signals that scrolling has ended.LV_EVENT_SCROLL
: Signals that the scrolling position changed; triggered on every position change.
Features of Scrolling
Besides, managing "normal" scrolling there are many interesting and useful additional features.
Scrollable
It is possible to make a Widget non-scrollable with lv_obj_remove_flag(widget, LV_OBJ_FLAG_SCROLLABLE).
Non-scrollable Widgets can still propagate the scrolling (chain) to their parents.
The direction in which scrolling happens can be controlled by lv_obj_set_scroll_dir(widget, LV_DIR_...).
The following values can be used for the direction:
LV_DIR_TOP
: only scroll upLV_DIR_LEFT
: only scroll leftLV_DIR_BOTTOM
: only scroll downLV_DIR_RIGHT
: only scroll rightLV_DIR_HOR
: only scroll horizontallyLV_DIR_VER
: only scroll verticallyLV_DIR_ALL
: scroll any directions
OR-ed values are also possible. E.g. LV_DIR_TOP | LV_DIR_LEFT.
Scroll chaining
If a Widget can't be scrolled further (e.g. its content has reached the bottom-most position), additional scrolling is propagated to its parent. If the parent can be scrolled in that direction than it will be scrolled instead. It continues propagating up the Widget's parent hierarchy up to the Screen.
The propagation on scrolling is called "scroll chaining" and it can be
enabled/disabled with LV_OBJ_FLAG_SCROLL_CHAIN_HOR/VER
flag. If
chaining is disabled the propagation stops on the Widget and the
parent(s) won't be scrolled.
Scroll momentum
When the user scrolls a Widget and releases it, LVGL can emulate inertial momentum for the scrolling. It's like the Widget was "thrown" and scrolling slows down smoothly.
Scroll momentum can be enabled/disabled with the
LV_OBJ_FLAG_SCROLL_MOMENTUM
flag.
Elastic scroll
Normally a Widget can't be scrolled past the extremities of its content. That is, the top side of the content can't be below the top side of the Widget, and vice versa for the bottom side.
However, with LV_OBJ_FLAG_SCROLL_ELASTIC
a fancy effect is added
when the user "over-scrolls" the content. The scrolling slows down, and
the content can be scrolled inside the Widget. When the Widget is
released the content scrolled in it is animated back to the closest valid
position.
Snapping
The children of a Widget can be snapped according to specific rules
when scrolling ends. Children can be made snappable individually with
the LV_OBJ_FLAG_SNAPPABLE
flag.
A Widget can align snapped children in four ways:
LV_SCROLL_SNAP_NONE
: Snapping is disabled. (default)LV_SCROLL_SNAP_START
: Align the children to the left/top side of a scrolled WidgetLV_SCROLL_SNAP_END
: Align the children to the right/bottom side of a scrolled WidgetLV_SCROLL_SNAP_CENTER
: Align the children to the center of a scrolled Widget
Snap alignment is set with lv_obj_set_scroll_snap_x(widget, LV_SCROLL_SNAP_...) and lv_obj_set_scroll_snap_y(widget, LV_SCROLL_SNAP_...).
This is what happens under the hood:
user scrolls and releases a Widget;
LVGL calculates where the scroll would end considering scroll momentum;
LVGL finds the nearest scroll point;
LVGL scrolls to the snap point with an animation.
Scroll one
The "scroll one" feature tells LVGL to allow scrolling only one
snappable child at a time. This requires making the children snappable
and setting scroll snap alignment to something other than
LV_SCROLL_SNAP_NONE
.
This feature can be enabled by the LV_OBJ_FLAG_SCROLL_ONE
flag.
Scroll on focus
Imagine that there are a lot of Widgets in a group that are on a scrollable Widget. Pressing the "Tab" button moves focus to the next Widget but it might be outside the visible area of the scrollable Widget. If the "scroll on focus" feature is enabled LVGL will automatically scroll Widgets to bring the child Widget with focus into view. The scrolling happens recursively therefore even nested scrollable Widgets are handled properly. The Widget will be scrolled into view even if it is on a different page of a tabview.
Scrolling Programmatically
The following API functions allow programmatic scrolling of Widgets:
lv_obj_scroll_by(widget, x, y, LV_ANIM_ON/OFF)
scroll byx
andy
valueslv_obj_scroll_to(widget, x, y, LV_ANIM_ON/OFF)
scroll to bring the given coordinate to the top left cornerlv_obj_scroll_to_x(widget, x, LV_ANIM_ON/OFF)
scroll to bring the given coordinate to the left sidelv_obj_scroll_to_y(widget, y, LV_ANIM_ON/OFF)
scroll to bring the given coordinate to the top side
From time to time you may need to retrieve the scroll position of a scrollable Widget, either to restore it later, or to dynamically display some elements according to its current scroll position. Here is an example to illustrate how to combine scroll event and store the scroll-top position.
static int scroll_value = 0;
static void store_scroll_top_value_event_cb(lv_event_t* e) {
lv_obj_t * scr = lv_event_get_target(e);
scroll_value = lv_obj_get_scroll_top(scr);
printf("%d pixels are scrolled above top edge of display.\n", scroll_value);
}
lv_obj_t * scr = lv_obj_create(NULL);
lv_obj_add_event_cb(scr, store_scroll_top_value_event_cb, LV_EVENT_SCROLL, NULL);
Scroll coordinates can be retrieved from different axes with these functions:
lv_obj_get_scroll_x(widget) Pixels scrolled past left edge of Widget's view window.
lv_obj_get_scroll_y(widget) Pixels scrolled past top of Widget's view window.
lv_obj_get_scroll_top(widget) Identical to lv_obj_get_scroll_y(widget)
lv_obj_get_scroll_bottom(widget) Pixels scrolled past bottom of Widget's view window.
lv_obj_get_scroll_left(widget) Identical to lv_obj_get_scroll_x(widget).
lv_obj_get_scroll_right(widget) Pixels scrolled past right edge of Widget's view window.
Setting scroll position can be done with these functions:
lv_obj_scroll_by(widget, dx, dy, anim_enable) Scroll by given amount of pixels.
lv_obj_scroll_by_bounded(widget, dx, dy, animation_enable) Scroll by given amount of pixels.
lv_obj_scroll_to(widget, x, y, animation_enable) Scroll to given coordinate on Widget.
lv_obj_scroll_to_x(widget, x, animation_enable) Scroll to X coordinate on Widget.
lv_obj_scroll_to_y(widget, y, animation_enable) Scroll to Y coordinate on Widget.
lv_obj_scroll_to_view(widget, animation_enable) Scroll
obj
's parent Widget untilobj
becomes visible.lv_obj_scroll_to_view_recursive(widget, animation_enable) Scroll
obj
's parent Widgets recursively untilobj
becomes visible.
Self Size
Self size is a property of a Widget. Normally, the user shouldn't use this parameter but if a custom widget is created it might be useful.
In short, self size establishes the size of a Widget's content. To understand it better take the example of a table. Let's say it has 10 rows each with 50 px height. So the total height of the content is 500 px. In other words the "self height" is 500 px. If the user sets only 200 px height for the table LVGL will see that the self size is larger and make the table scrollable.
This means not only the children can make a Widget scrollable but a larger self size will as well.
LVGL uses the LV_EVENT_GET_SELF_SIZE
event to get the self size of
a Widget. Here is an example to see how to handle the event:
if(event_code == LV_EVENT_GET_SELF_SIZE) {
lv_point_t * p = lv_event_get_param(e);
/* If x or y < 0 then it doesn't need to be calculated now. */
if(p->x >= 0) {
p->x = 200; /* Set or calculate self width. */
}
if(p->y >= 0) {
p->y = 50; /* Set or calculate self height. */
}
}
Examples
Nested scrolling
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES
static lv_obj_t * panel;
static lv_obj_t * save_button;
static lv_obj_t * restore_button;
static int saved_scroll_x;
static int saved_scroll_y;
static void scroll_update_cb(lv_event_t * e);
static void button_event_cb(lv_event_t * e);
static void scroll_update_cb(lv_event_t * e)
{
LV_UNUSED(e);
LV_LOG("scroll info: x:%3"LV_PRId32", y:%3"LV_PRId32", top:%3"LV_PRId32", "
"bottom:%3"LV_PRId32", left:%3"LV_PRId32", right:%3"LV_PRId32"\n",
lv_obj_get_scroll_x(panel),
lv_obj_get_scroll_y(panel),
lv_obj_get_scroll_top(panel),
lv_obj_get_scroll_bottom(panel),
lv_obj_get_scroll_left(panel),
lv_obj_get_scroll_right(panel)
);
}
static void button_event_cb(lv_event_t * e)
{
lv_obj_t * obj = lv_event_get_target_obj(e);
if(obj == save_button) {
saved_scroll_x = lv_obj_get_scroll_x(panel);
saved_scroll_y = lv_obj_get_scroll_y(panel);
}
else {
lv_obj_scroll_to(panel, saved_scroll_x, saved_scroll_y, LV_ANIM_ON);
}
}
/**
* Demonstrate how scrolling appears automatically
*/
void lv_example_scroll_1(void)
{
/*Create an object with the new style*/
lv_obj_t * scr;
scr = lv_screen_active();
panel = lv_obj_create(scr);
lv_obj_set_size(panel, 200, 200);
lv_obj_align(panel, LV_ALIGN_CENTER, 44, 0);
lv_obj_t * child;
lv_obj_t * label;
child = lv_obj_create(panel);
lv_obj_set_pos(child, 0, 0);
lv_obj_set_size(child, 70, 70);
label = lv_label_create(child);
lv_label_set_text(label, "Zero");
lv_obj_center(label);
child = lv_obj_create(panel);
lv_obj_set_pos(child, 160, 80);
lv_obj_set_size(child, 80, 80);
lv_obj_t * child2 = lv_button_create(child);
lv_obj_set_size(child2, 100, 50);
label = lv_label_create(child2);
lv_label_set_text(label, "Right");
lv_obj_center(label);
child = lv_obj_create(panel);
lv_obj_set_pos(child, 40, 160);
lv_obj_set_size(child, 100, 70);
label = lv_label_create(child);
lv_label_set_text(label, "Bottom");
lv_obj_center(label);
/* When LV_OBJ_FLAG_SCROLL_ELASTIC is cleared, scrolling does not go past edge bounaries. */
/* lv_obj_clear_flag(panel, LV_OBJ_FLAG_SCROLL_ELASTIC); */
/* Call `scroll_update_cb` while panel is being scrolled. */
lv_obj_add_event_cb(panel, scroll_update_cb, LV_EVENT_SCROLL, NULL);
/* Set up buttons that save and restore scroll position. */
save_button = lv_button_create(scr);
restore_button = lv_button_create(scr);
lv_obj_t * lbl;
lbl = lv_label_create(save_button);
lv_label_set_text_static(lbl, "Save");
lbl = lv_label_create(restore_button);
lv_label_set_text_static(lbl, "Restore");
lv_obj_align_to(save_button, panel, LV_ALIGN_OUT_LEFT_MID, -10, -20);
lv_obj_align_to(restore_button, panel, LV_ALIGN_OUT_LEFT_MID, -10, 20);
lv_obj_add_event_cb(save_button, button_event_cb, LV_EVENT_CLICKED, NULL);
lv_obj_add_event_cb(restore_button, button_event_cb, LV_EVENT_CLICKED, NULL);
}
#endif
Snapping
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_USE_FLEX
static void sw_event_cb(lv_event_t * e)
{
lv_event_code_t code = lv_event_get_code(e);
lv_obj_t * sw = lv_event_get_target(e);
if(code == LV_EVENT_VALUE_CHANGED) {
lv_obj_t * list = lv_event_get_user_data(e);
if(lv_obj_has_state(sw, LV_STATE_CHECKED)) lv_obj_add_flag(list, LV_OBJ_FLAG_SCROLL_ONE);
else lv_obj_remove_flag(list, LV_OBJ_FLAG_SCROLL_ONE);
}
}
/**
* Show an example to scroll snap
*/
void lv_example_scroll_2(void)
{
lv_obj_t * panel = lv_obj_create(lv_screen_active());
lv_obj_set_size(panel, 280, 120);
lv_obj_set_scroll_snap_x(panel, LV_SCROLL_SNAP_CENTER);
lv_obj_set_flex_flow(panel, LV_FLEX_FLOW_ROW);
lv_obj_align(panel, LV_ALIGN_CENTER, 0, 20);
uint32_t i;
for(i = 0; i < 10; i++) {
lv_obj_t * btn = lv_button_create(panel);
lv_obj_set_size(btn, 150, lv_pct(100));
lv_obj_t * label = lv_label_create(btn);
if(i == 3) {
lv_label_set_text_fmt(label, "Panel %"LV_PRIu32"\nno snap", i);
lv_obj_remove_flag(btn, LV_OBJ_FLAG_SNAPPABLE);
}
else {
lv_label_set_text_fmt(label, "Panel %"LV_PRIu32, i);
}
lv_obj_center(label);
}
lv_obj_update_snap(panel, LV_ANIM_ON);
#if LV_USE_SWITCH
/*Switch between "One scroll" and "Normal scroll" mode*/
lv_obj_t * sw = lv_switch_create(lv_screen_active());
lv_obj_align(sw, LV_ALIGN_TOP_RIGHT, -20, 10);
lv_obj_add_event_cb(sw, sw_event_cb, LV_EVENT_ALL, panel);
lv_obj_t * label = lv_label_create(lv_screen_active());
lv_label_set_text(label, "One scroll");
lv_obj_align_to(label, sw, LV_ALIGN_OUT_BOTTOM_MID, 0, 5);
#endif
}
#endif
Styling the scrollbars
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_USE_LIST
/**
* Styling the scrollbars
*/
void lv_example_scroll_4(void)
{
lv_obj_t * obj = lv_obj_create(lv_screen_active());
lv_obj_set_size(obj, 200, 100);
lv_obj_center(obj);
lv_obj_t * label = lv_label_create(obj);
lv_label_set_text(label,
"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
"Etiam dictum, tortor vestibulum lacinia laoreet, mi neque consectetur neque, vel mattis odio dolor egestas ligula. \n"
"Sed vestibulum sapien nulla, id convallis ex porttitor nec. \n"
"Duis et massa eu libero accumsan faucibus a in arcu. \n"
"Ut pulvinar odio lorem, vel tempus turpis condimentum quis. Nam consectetur condimentum sem in auctor. \n"
"Sed nisl augue, venenatis in blandit et, gravida ac tortor. \n"
"Etiam dapibus elementum suscipit. \n"
"Proin mollis sollicitudin convallis. \n"
"Integer dapibus tempus arcu nec viverra. \n"
"Donec molestie nulla enim, eu interdum velit placerat quis. \n"
"Donec id efficitur risus, at molestie turpis. \n"
"Suspendisse vestibulum consectetur nunc ut commodo. \n"
"Fusce molestie rhoncus nisi sit amet tincidunt. \n"
"Suspendisse a nunc ut magna ornare volutpat.");
/*Remove the style of scrollbar to have clean start*/
lv_obj_remove_style(obj, NULL, LV_PART_SCROLLBAR | LV_STATE_ANY);
/*Create a transition the animate the some properties on state change*/
static const lv_style_prop_t props[] = {LV_STYLE_BG_OPA, LV_STYLE_WIDTH, 0};
static lv_style_transition_dsc_t trans;
lv_style_transition_dsc_init(&trans, props, lv_anim_path_linear, 200, 0, NULL);
/*Create a style for the scrollbars*/
static lv_style_t style;
lv_style_init(&style);
lv_style_set_width(&style, 4); /*Width of the scrollbar*/
lv_style_set_length(&style, 20); /*Length of the scrollbar*/
lv_style_set_pad_right(&style, 5); /*Space from the parallel side*/
lv_style_set_pad_top(&style, 5); /*Space from the perpendicular side*/
lv_style_set_radius(&style, 2);
lv_style_set_bg_opa(&style, LV_OPA_70);
lv_style_set_bg_color(&style, lv_palette_main(LV_PALETTE_BLUE));
lv_style_set_border_color(&style, lv_palette_darken(LV_PALETTE_BLUE, 3));
lv_style_set_border_width(&style, 2);
lv_style_set_shadow_width(&style, 8);
lv_style_set_shadow_spread(&style, 2);
lv_style_set_shadow_color(&style, lv_palette_darken(LV_PALETTE_BLUE, 1));
lv_style_set_transition(&style, &trans);
/*Make the scrollbars wider and use 100% opacity when scrolled*/
static lv_style_t style_scrolled;
lv_style_init(&style_scrolled);
lv_style_set_width(&style_scrolled, 8);
lv_style_set_bg_opa(&style_scrolled, LV_OPA_COVER);
lv_obj_add_style(obj, &style, LV_PART_SCROLLBAR);
lv_obj_add_style(obj, &style_scrolled, LV_PART_SCROLLBAR | LV_STATE_SCROLLED);
}
#endif
Right to left scrolling
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_FONT_DEJAVU_16_PERSIAN_HEBREW
/**
* Scrolling with Right To Left base direction
*/
void lv_example_scroll_5(void)
{
lv_obj_t * obj = lv_obj_create(lv_screen_active());
lv_obj_set_style_base_dir(obj, LV_BASE_DIR_RTL, 0);
lv_obj_set_size(obj, 200, 100);
lv_obj_center(obj);
lv_obj_t * label = lv_label_create(obj);
lv_label_set_text(label,
"میکروکُنترولر (به انگلیسی: Microcontroller) گونهای ریزپردازنده است که دارای حافظهٔ دسترسی تصادفی (RAM) و حافظهٔ فقطخواندنی (ROM)، تایمر، پورتهای ورودی و خروجی (I/O) و درگاه ترتیبی (Serial Port پورت سریال)، درون خود تراشه است، و میتواند به تنهایی ابزارهای دیگر را کنترل کند. به عبارت دیگر یک میکروکنترلر، مدار مجتمع کوچکی است که از یک CPU کوچک و اجزای دیگری مانند تایمر، درگاههای ورودی و خروجی آنالوگ و دیجیتال و حافظه تشکیل شدهاست.");
lv_obj_set_width(label, 400);
lv_obj_set_style_text_font(label, &lv_font_dejavu_16_persian_hebrew, 0);
}
#endif
Translate on scroll
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_USE_FLEX
static void scroll_event_cb(lv_event_t * e)
{
lv_obj_t * cont = lv_event_get_target(e);
lv_area_t cont_a;
lv_obj_get_coords(cont, &cont_a);
int32_t cont_y_center = cont_a.y1 + lv_area_get_height(&cont_a) / 2;
int32_t r = lv_obj_get_height(cont) * 7 / 10;
uint32_t i;
uint32_t child_cnt = lv_obj_get_child_count(cont);
for(i = 0; i < child_cnt; i++) {
lv_obj_t * child = lv_obj_get_child(cont, i);
lv_area_t child_a;
lv_obj_get_coords(child, &child_a);
int32_t child_y_center = child_a.y1 + lv_area_get_height(&child_a) / 2;
int32_t diff_y = child_y_center - cont_y_center;
diff_y = LV_ABS(diff_y);
/*Get the x of diff_y on a circle.*/
int32_t x;
/*If diff_y is out of the circle use the last point of the circle (the radius)*/
if(diff_y >= r) {
x = r;
}
else {
/*Use Pythagoras theorem to get x from radius and y*/
uint32_t x_sqr = r * r - diff_y * diff_y;
lv_sqrt_res_t res;
lv_sqrt(x_sqr, &res, 0x8000); /*Use lvgl's built in sqrt root function*/
x = r - res.i;
}
/*Translate the item by the calculated X coordinate*/
lv_obj_set_style_translate_x(child, x, 0);
/*Use some opacity with larger translations*/
lv_opa_t opa = lv_map(x, 0, r, LV_OPA_TRANSP, LV_OPA_COVER);
lv_obj_set_style_opa(child, LV_OPA_COVER - opa, 0);
}
}
/**
* Translate the object as they scroll
*/
void lv_example_scroll_6(void)
{
lv_obj_t * cont = lv_obj_create(lv_screen_active());
lv_obj_set_size(cont, 200, 200);
lv_obj_center(cont);
lv_obj_set_flex_flow(cont, LV_FLEX_FLOW_COLUMN);
lv_obj_add_event_cb(cont, scroll_event_cb, LV_EVENT_SCROLL, NULL);
lv_obj_set_style_radius(cont, LV_RADIUS_CIRCLE, 0);
lv_obj_set_style_clip_corner(cont, true, 0);
lv_obj_set_scroll_dir(cont, LV_DIR_VER);
lv_obj_set_scroll_snap_y(cont, LV_SCROLL_SNAP_CENTER);
lv_obj_set_scrollbar_mode(cont, LV_SCROLLBAR_MODE_OFF);
uint32_t i;
for(i = 0; i < 20; i++) {
lv_obj_t * btn = lv_button_create(cont);
lv_obj_set_width(btn, lv_pct(100));
lv_obj_t * label = lv_label_create(btn);
lv_label_set_text_fmt(label, "Button %"LV_PRIu32, i);
}
/*Update the buttons position manually for first*/
lv_obj_send_event(cont, LV_EVENT_SCROLL, NULL);
/*Be sure the fist button is in the middle*/
lv_obj_scroll_to_view(lv_obj_get_child(cont, 0), LV_ANIM_OFF);
}
#endif
Infinite scrolling
C code
View on GitHub#include "../lv_examples.h"
#if LV_BUILD_EXAMPLES && LV_USE_FLEX
static lv_obj_t * high_label;
static lv_obj_t * low_label;
static int32_t top_num;
static int32_t bottom_num;
static lv_obj_t * load_item(lv_obj_t * parent, int32_t num)
{
lv_obj_t * new = lv_obj_create(parent);
lv_obj_set_size(new, LV_PCT(100), LV_SIZE_CONTENT);
lv_obj_t * label = lv_label_create(new);
lv_label_set_text_fmt(label, "%"PRId32, num);
return new;
}
static void update_scroll(lv_obj_t * obj)
{
int32_t top_num_original = top_num;
int32_t bottom_num_original = bottom_num;
/* load items we're getting close to */
while(bottom_num > -30 && lv_obj_get_scroll_bottom(obj) < 200) {
bottom_num -= 1;
load_item(obj, bottom_num);
lv_obj_update_layout(obj);
LV_LOG_USER("loaded bottom num: %"PRId32, bottom_num);
}
while(top_num < 30 && lv_obj_get_scroll_top(obj) < 200) {
top_num += 1;
int32_t bottom_before = lv_obj_get_scroll_bottom(obj);
lv_obj_t * new_item = load_item(obj, top_num);
lv_obj_move_to_index(new_item, 0);
lv_obj_update_layout(obj);
int32_t bottom_after = lv_obj_get_scroll_bottom(obj);
lv_obj_scroll_by(obj, 0, bottom_before - bottom_after, LV_ANIM_OFF);
LV_LOG_USER("loaded top num: %"PRId32, top_num);
}
/* delete far-away items */
while(lv_obj_get_scroll_bottom(obj) > 600) {
bottom_num += 1;
lv_obj_t * child = lv_obj_get_child(obj, -1);
lv_obj_delete(child);
lv_obj_update_layout(obj);
LV_LOG_USER("deleted bottom num: %"PRId32, bottom_num);
}
while(lv_obj_get_scroll_top(obj) > 600) {
top_num -= 1;
int32_t bottom_before = lv_obj_get_scroll_bottom(obj);
lv_obj_t * child = lv_obj_get_child(obj, 0);
lv_obj_delete(child);
lv_obj_update_layout(obj);
int32_t bottom_after = lv_obj_get_scroll_bottom(obj);
lv_obj_scroll_by(obj, 0, bottom_before - bottom_after, LV_ANIM_OFF);
LV_LOG_USER("deleted top num: %"PRId32, top_num);
}
if(top_num != top_num_original) {
lv_label_set_text_fmt(high_label, "current largest\nloaded value:\n%"PRId32, top_num);
}
if(bottom_num != bottom_num_original) {
lv_label_set_text_fmt(low_label, "current smallest\nloaded value:\n%"PRId32, bottom_num);
}
}
static void scroll_cb(lv_event_t * e)
{
lv_obj_t * obj = lv_event_get_target_obj(e);
update_scroll(obj);
}
static void checkbox_cb(lv_event_t * e)
{
lv_obj_t * checkbox = lv_event_get_target_obj(e);
lv_obj_t * obj = lv_event_get_user_data(e);
bool checked = lv_obj_has_state(checkbox, LV_STATE_CHECKED);
lv_obj_set_style_opa(obj, checked ? LV_OPA_COVER : LV_OPA_TRANSP, LV_PART_SCROLLBAR);
}
/**
* Dynamically load widgets while scrolling
*/
void lv_example_scroll_7(void)
{
lv_obj_t * scr = lv_screen_active();
lv_obj_t * obj = lv_obj_create(scr);
lv_obj_set_size(obj, 160, 220);
lv_obj_align(obj, LV_ALIGN_RIGHT_MID, -10, 0);
lv_obj_set_flex_flow(obj, LV_FLEX_FLOW_COLUMN);
lv_obj_set_style_opa(obj, LV_OPA_TRANSP, LV_PART_SCROLLBAR);
high_label = lv_label_create(scr);
lv_label_set_text_static(high_label, "current largest\nloaded value:");
lv_obj_align(high_label, LV_ALIGN_TOP_LEFT, 10, 10);
lv_obj_t * checkbox = lv_checkbox_create(scr);
lv_checkbox_set_text_static(checkbox, "show\nscrollbar");
lv_obj_align(checkbox, LV_ALIGN_LEFT_MID, 10, 0);
lv_obj_add_event_cb(checkbox, checkbox_cb, LV_EVENT_VALUE_CHANGED, obj);
low_label = lv_label_create(scr);
lv_label_set_text_static(low_label, "current smallest\nloaded value:");
lv_obj_align(low_label, LV_ALIGN_BOTTOM_LEFT, 10, -10);
/* These counters hold the the highest/lowest number currently shown.
* Since no numbers are show yet, set them such that they will be
* correct after the first value is added.
* I.e., if a value is added at the top, `top_num` will be incremented
* and its new value (4) will be added to the top (`top_num`=4, `bottom_num`=4).
* If a value is added to the bottom, `bottom_num` will be decremented
* and its new value (3) will be added to the bottom (`top_num`=3, `bottom_num`=3).
*/
top_num = 3;
bottom_num = 4;
lv_obj_update_layout(obj);
update_scroll(obj);
lv_obj_add_event_cb(obj, scroll_cb, LV_EVENT_SCROLL, NULL);
}
#endif