Button (gfx_button)

Functions

gfx_button_create()

Create a button object on a display

gfx_obj_t * gfx_button_create(gfx_disp_t *disp);

Parameters:

disp - Display from gfx_disp_add()

Returns:

Pointer to the created button object

gfx_button_set_text()

Set the label text for a button

esp_err_t gfx_button_set_text(gfx_obj_t *obj, const char *text);

Parameters:

obj - Button object
text - Text string; NULL is treated as an empty string

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_text_fmt()

Set the label text for a button using printf-style formatting

esp_err_t gfx_button_set_text_fmt(gfx_obj_t *obj, const char *fmt, ...);

Parameters:

obj - Button object
fmt - Format string

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_font()

Set the font used by the button label

esp_err_t gfx_button_set_font(gfx_obj_t *obj, gfx_font_t font);

Parameters:

obj - Button object
font - Font handle

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_text_color()

Set the label text color for a button

esp_err_t gfx_button_set_text_color(gfx_obj_t *obj, gfx_color_t color);

Parameters:

obj - Button object
color - Text color

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_bg_color()

Set the normal background color for a button

esp_err_t gfx_button_set_bg_color(gfx_obj_t *obj, gfx_color_t color);

Parameters:

obj - Button object
color - Background color

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_bg_color_pressed()

Set the pressed background color for a button

esp_err_t gfx_button_set_bg_color_pressed(gfx_obj_t *obj, gfx_color_t color);

Parameters:

obj - Button object
color - Pressed background color

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_border_color()

Set the border color for a button

esp_err_t gfx_button_set_border_color(gfx_obj_t *obj, gfx_color_t color);

Parameters:

obj - Button object
color - Border color

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_border_width()

Set the border width for a button

esp_err_t gfx_button_set_border_width(gfx_obj_t *obj, uint16_t width);

Parameters:

obj - Button object
width - Border width in pixels; 0 disables the border

Returns:

ESP_OK on success, error code otherwise

gfx_button_set_text_align()

Set the text alignment for a button label

esp_err_t gfx_button_set_text_align(gfx_obj_t *obj, gfx_text_align_t align);

Parameters:

obj - Button object
align - Text alignment

Returns:

ESP_OK on success, error code otherwise