Page List

The pagelist widget has a similar function as the page widget, and it is expected to use less RAM size. The pagelist widget behaves like a scroll on the y-axis. When it moves on the y-axis, the child nodes will also move with the pagelist widget. Two switch widgets can be set to indicate the first and the last, and two border lines to indicate the top and bottom. The first one will move from top to bottom when it reaches the top. The last one will move from bottom to top when it reaches the bottom. This characteristic makes the child widgets look like more than what is really created.

Usage

Increase Page List

You can increase the number of real lists using gui_pagelist_increase_real_list_max().

Decrease Page List

You can decrease the number of real lists using gui_pagelist_decrease_real_list_max().

Add Callback

The API gui_pagelist_add_list_update_cb() is used to add an update callback when the pagelist slides up and down, typically for updating text.

Set Attribute

Attributes for a pagelist widget can be set using gui_pagelist_set_att().

Add Picture

By using this API gui_pagelist_add_scroll_bar(), you can add a scroll bar image for a pagelist widget, with the file source being a memory address.

Example

#include "root_image/ui_resource.h"
#include "gui_img.h"
#include "gui_text.h"
#include "gui_switch.h"
#include "gui_pagelistview.h"
#include "gui_pagelist.h"

int8_t show_num = 4;
int16_t real_num = 20;
int16_t list_gap_y = 20;
int16_t index_first = 0;
int16_t index_last = 0;

void design_pagelist_test(void *parent)
{
    pagelist_test = gui_pagelist_create(pagelistview_test, "pagelist", 0, 0, LCD_W, LCD_H);
    for (int8_t i = 0; i < show_num; i++)
    {
        switch_pagelist_test[i] = gui_switch_create(pagelist_test, 83, 111 + i * (list_gap_y + 64), 288, 64,
                                                    ICON_TEXT_BASE_DARK_BIN, ICON_TEXT_BASE_DARK_BIN);
        switch_pagelist_test[i]->off_hl_pic_addr = ICON_TEXT_BASE_BLUE_BIN;
        switch_pagelist_test[i]->on_hl_pic_addr = ICON_TEXT_BASE_BLUE_BIN;
        scroll_text_pagelist_test[i] = gui_scroll_text_create(switch_pagelist_test[i],
                                                            "scroll_text_record_files", 0, 0, 128, FONT_H_32);
        gui_scroll_text_set(scroll_text_pagelist_test[i], files_name_test[i],
                            GUI_FONT_SRC_BMP, gui_rgb(UINT8_MAX, UINT8_MAX, UINT8_MAX), strlen(files_name_test[i]),
                            FONT_H_32);
        gui_scroll_text_scroll_set(scroll_text_pagelist_test[i], SCROLL_X, 0, 0, 5000, 0);
        gui_obj_add_event_cb(switch_pagelist_test[i], (gui_event_cb_t)switch_pagelist_touch_cb, GUI_EVENT_1,
                            NULL);
        gui_obj_add_event_cb(switch_pagelist_test[i], (gui_event_cb_t)switch_pagelist_touch_cb, GUI_EVENT_2,
                            NULL);
    }
    index_first = 0;
    index_last = MAX_SHOW_FILE_LIST_NUM - 1;
    gui_pagelist_set_att(pagelist_test, real_num, show_num, list_gap_y, switch_pagelist_test[0],
                        switch_pagelist_test[MAX_SHOW_FILE_LIST_NUM - 1]);
    gui_pagelist_add_list_update_cb(pagelist_test,
                                    (gui_pagelist_update_cb_t)pagelist_test_update_list_first_cb,
                                    (gui_pagelist_update_cb_t)pagelist_test_update_list_last_cb);
}

API

Typedefs

typedef void (*gui_pagelist_update_cb_t)(void *obj, void *list): Pagelist widget structure.

Functions

void gui_pagelist_increase_real_list_max(gui_pagelist_t *this, int16_t real_list_max)

increase number of real lists.

Parameters:

this – pagelist widget.
real_list_max – number to increase.

void gui_pagelist_decrease_real_list_max(gui_pagelist_t *this, int16_t real_list_max)

decrease number of real lists.

Parameters:

this – pagelist widget.
real_list_max – number to decrease.

void gui_pagelist_add_list_update_cb(gui_pagelist_t *this, gui_pagelist_update_cb_t list_first_cb, gui_pagelist_update_cb_t list_last_cb)

add update callback when pagelist slide up and down to update text typically.

Parameters:

this – pagelist widget.
list_first_cb – update callback of the top show list.
list_last_cb – update callback of the botoom show list.

void gui_pagelist_set_att(gui_pagelist_t *this, int16_t real_list_max, int16_t show_list_max, int16_t list_gap_y, gui_switch_t *list_first, gui_switch_t *list_last)

set attribute for a pagelist widget.

Parameters:

this – pagelist widget.
real_list_max – real quality of file lists to show. larger than show_list_max typically.
show_list_max – quality of switch widgets, which should be created as child nodes of this pagelist widget.
list_gap_y – y gap between two show lists.
list_first – index of the top show list.
list_last – index of the bottom show list.

void gui_pagelist_add_scroll_bar(gui_pagelist_t *this, void *bar_pic, IMG_SOURCE_MODE_TYPE src_mode)

add a scroll bar picture for a pagelist widget, file source is memory address.

Parameters:

this – pagelist widget.
bar_pic – bar picture.

gui_pagelist_t *gui_pagelist_create(void *parent, const char *name, int16_t x, int16_t y, int16_t w, int16_t h)

create a pagelist widget.

Parameters:

parent – parent of this widget.
name – name of this widget.
x – x of this widget.
y – y of this widget.
w – w of this widget.
h – h of this widget.
parent –
name –
data –
x –
y –
w –
h –

Returns:

gui_pagelist_t*.

Returns:

gui_pagelist_t*

struct gui_pagelist_t

Public Members

gui_obj_t base

int8_t show_list_max

int16_t real_list_max

gui_switch_t *list_first

gui_switch_t *list_last

gui_img_t *scroll_bar

int16_t x_init

int16_t y_init

int16_t x_stop_scroll

int16_t y_stop_scroll

int16_t list_gap_y

int16_t show_border_top

int16_t show_border_bottom

bool h_set_done

gui_pagelist_update_cb_t update_list_first_cb

gui_pagelist_update_cb_t update_list_last_cb

int16_t list_count

IMG_SOURCE_MODE_TYPE src_mode

Page List

Usage

Increase Page List

Decrease Page List

Add Callback

Set Attribute

Add Picture

Create Widget

Example

API