Progressbar

The progressbar widget allows you to create widgets with three different effects. After created a progressbar widget, you can set the percentage of the widget to display.

Usage

Create movie-style widget

Unlike the above two normal single-picture progressbar, a movie-style progressbar consists of a series of pictures. You can create a movie style progressbar from memory address by using gui_progressbar_movie_create(void *parent, void **picture_array, uint16_t array_length, int16_t x, int16_t y), and gui_progressbar_movie_create_from_fs(void *parent, void **picture_array, uint16_t array_length, int16_t x, int16_t y) from filesystem. The first picture is shown at 0% progress and the last picture is shown at 100% progress.

Progress

For example, if you want to create a movie-style progressbar, you need to use gui_progressbar_set_progress(gui_progressbar_t *this, size_t progress) to set the progress and gui_progressbar_get_progress(gui_progressbar_t *this) to get the progress.

Percentage

The above usage of (Progress) applies to movie-style progressbar. For a normal single-image progressbar, if you want to use a progressbar to show the progress of a song, you can use gui_progressbar_set_percentage(gui_progressbar_t *this, float percentage) to set the current percentage progress after creating the progressbar. Additionally, you can also use gui_progressbar_get_percentage(gui_progressbar_t *this) to get the current percentage progress.

Get max number

This api gui_progressbar_get_max(gui_progressbar_t *this) is used to get the number of pictures in a movie style progressbar, so you can know how many pictures will be displayed in total.

Example

code

#include "root_image_hongkong/ui_resource.h"
#include "gui_progressbar.h"
#include "gui_text.h"
#include "draw_font.h"

static void *array[] = {DOG40_BIN, DOG60_BIN, DOG80_BIN, DOG100_BIN, DOG120_BIN, DOG140_BIN};

void page_tb_one(void *parent)
{
    gui_set_font_mem_resourse(24, TEST_FONT24_DOT_BIN, TEST_FONT24_TABLE_BIN);

    gui_progressbar_t *test_bar_one = gui_progressbar_img_v_create(parent, TEST_BIN, 50, 0);
    gui_progressbar_set_percentage(test_bar_one, 1);

    gui_progressbar_t *test_bar_two = gui_progressbar_img_v_create(parent, TEST_BIN, 150, 0);
    gui_progressbar_set_percentage(test_bar_two, 0.5);

    gui_text_t *text1 = gui_text_create(parent, "vertical1", 50, 250, 300, 24);
    gui_text_set(text1, "100%    50%  vertical", GUI_FONT_SRC_BMP, 0xffffffff, 21, 24);
    gui_text_mode_set(text1, LEFT);

    gui_text_t *text2 = gui_text_create(parent, "vertical2", 10, 300, 330, 24);
    gui_text_set(text2, "gui_progressbar_img_v_create", GUI_FONT_SRC_BMP, 0xff0000ff, 28, 24);
    gui_text_mode_set(text2, LEFT);
}

void page_tb_two(void *parent)
{
    gui_set_font_mem_resourse(24, TEST_FONT24_DOT_BIN, TEST_FONT24_TABLE_BIN);

    gui_progressbar_t *test_bar_three = gui_progressbar_img_h_create(parent, TEST_BIN, 50, 0);
    gui_progressbar_set_percentage(test_bar_three, 1);

    gui_progressbar_t *test_bar_four = gui_progressbar_img_h_create(parent, TEST_BIN, 150, 0);
    gui_progressbar_set_percentage(test_bar_four, 0.5);

    gui_text_t *text3 = gui_text_create(parent, "horizontal1", 50, 250, 300, 24);
    gui_text_set(text3, "100%    50%  horizontal", GUI_FONT_SRC_BMP, 0xffffffff, 23, 24);
    gui_text_mode_set(text3, LEFT);

    gui_text_t *text4 = gui_text_create(parent, "horizontal2", 10, 300, 330, 24);
    gui_text_set(text4, "gui_progressbar_img_h_create", GUI_FONT_SRC_BMP, 0xff0000ff, 28, 24);
    gui_text_mode_set(text4, LEFT);
}

void page_tb_three(void *parent)
{
    gui_set_font_mem_resourse(24, TEST_FONT24_DOT_BIN, TEST_FONT24_TABLE_BIN);

    gui_progressbar_t *test_bar_five = gui_progressbar_movie_create(parent, array, 6, 0, 0);

    gui_progressbar_t *test_bar_six = gui_progressbar_movie_create(parent, array, 6, 150, 0);
    gui_progressbar_set_progress(test_bar_six, 4);

    gui_text_t *text5 = gui_text_create(parent, "movie1", 80, 250, 300, 24);
    gui_text_set(text5, "pic0   pic4  movie", GUI_FONT_SRC_BMP, 0xffffffff, 18, 24);
    gui_text_mode_set(text5, LEFT);

    gui_text_t *text6 = gui_text_create(parent, "movie2", 10, 300, 330, 24);
    gui_text_set(text6, "gui_progressbar_movie_create", GUI_FONT_SRC_BMP, 0xff0000ff, 28, 24);
    gui_text_mode_set(text6, LEFT);
}

API

Functions

gui_progressbar_t *gui_progressbar_img_h_create(void *parent, void *picture, int16_t x, int16_t y)

create a horizontal progressbar based on picture

Parameters:

parent – parent widget
picture – the picture background
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

gui_progressbar_t *gui_progressbar_img_h_create_from_ftl(void *parent, void *picture, int16_t x, int16_t y)

create a horizontal progressbar based on picture

Parameters:

parent – parent widget
picture – the picture background, should be ftl addr
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

gui_progressbar_t *gui_progressbar_img_v_create(void *parent, void *picture, int16_t x, int16_t y)

create a vertical progressbar based on picture

Parameters:

parent – parent widget
picture – the picture background
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

gui_progressbar_t *gui_progressbar_img_v_create_from_ftl(void *parent, void *picture, int16_t x, int16_t y)

create a vertical progressbar based on picture

Parameters:

parent – parent widget
picture – the picture background, should be ftl addr
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

gui_progressbar_t *gui_progressbar_movie_create(void *parent, void **picture_array, uint16_t array_length, int16_t x, int16_t y)

create a frame progressbar based on pictures, file source is memory address.

Parameters:

parent – parent widget
picture_array – the pictures frame memory address
array_length – picture_array length
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

gui_progressbar_t *gui_progressbar_movie_create_from_fs(void *parent, void **picture_array, uint16_t array_length, int16_t x, int16_t y)

create a frame progressbar based on pictures, file source is filesystem.

Parameters:

parent – parent widget
picture_array – the pictures frame filepath
array_length – picture_array length
x – the X-axis coordinate of the widget.
y – the Y-axis coordinate of the widget.

Returns:

gui_progressbar_t*

void gui_progressbar_set_progress(gui_progressbar_t *this, size_t progress)

set progress

Parameters:

this –
progress –

size_t gui_progressbar_get_progress(gui_progressbar_t *this)

get_progress

Parameters:

this –

Returns:

size_t

void gui_progressbar_set_percentage(gui_progressbar_t *this, float percentage)

set_percentage

Parameters:

this –
percentage –

float gui_progressbar_get_percentage(gui_progressbar_t *this)

get_percentage

Parameters:

this –

Returns:

float

size_t gui_progressbar_get_max(gui_progressbar_t *this)

get_max

Parameters:

this –

Returns:

size_t

struct gui_progressbar_t

#include <gui_progressbar.h>

…

Public Members

gui_obj_t base

gui_canvas_t *c

uint32_t color

uint32_t color_hl

size_t max

float per

void (*ctor)(struct gui_progressbar *this, gui_obj_t *parent, const char *name, int16_t x, int16_t y, int16_t w, int16_t h)

IMG_SOURCE_MODE_TYPE src_mode

Progressbar

Usage

Create horizontal widget

Create vertical widget

Create movie-style widget

Progress

Percentage

Get max number

Example

API