lv_table.h

API reference for lv_table.h

Summary

Functions

public/widgets/lv_table.h:81function

lv_table_set_cell_value

Set the value of a cell.

void lv_table_set_cell_value(lv_obj_t *obj, uint32_t row, uint32_t col, const char *txt)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]
`txt`	`const char *`	text to display in the cell. It will be copied and saved so this variable is not required after this function call.

New roes/columns are added automatically if required

public/widgets/lv_table.h:91function

lv_table_set_cell_value_fmt

Set the value of a cell. Memory will be allocated to store the text by the table.

void lv_table_set_cell_value_fmt(lv_obj_t *obj, uint32_t row, uint32_t col, const char *fmt,...)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]
`fmt`	`const char *`	`printf`-like format
`...`

New roes/columns are added automatically if required

public/widgets/lv_table.h:99function

lv_table_set_row_count

Set the number of rows

void lv_table_set_row_count(lv_obj_t *obj, uint32_t row_cnt)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object
`row_cnt`	`uint32_t`	number of rows

public/widgets/lv_table.h:106function

lv_table_set_column_count

Set the number of columns

void lv_table_set_column_count(lv_obj_t *obj, uint32_t col_cnt)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object
`col_cnt`	`uint32_t`	number of columns.

public/widgets/lv_table.h:114function

lv_table_set_column_width

Set the width of a column

void lv_table_set_column_width(lv_obj_t *obj, uint32_t col_id, int32_t w)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object
`col_id`	`uint32_t`	id of the column [0 .. LV_TABLE_COL_MAX -1]
`w`	`int32_t`	width of the column

public/widgets/lv_table.h:123function

lv_table_set_cell_ctrl

Add control bits to the cell.

void lv_table_set_cell_ctrl(lv_obj_t *obj, uint32_t row, uint32_t col, lv_table_cell_ctrl_t ctrl)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]
`ctrl`	`lv_table_cell_ctrl_t`	OR-ed values from `lv_table_cell_ctrl_t`

public/widgets/lv_table.h:144function

lv_table_set_cell_user_data

Add custom user data to the cell.

void lv_table_set_cell_user_data(lv_obj_t *obj, uint16_t row, uint16_t col, void *user_data)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint16_t`	id of the row [0 .. row_cnt -1]
`col`	`uint16_t`	id of the column [0 .. col_cnt -1]
`user_data`	`void *`	pointer to the new user_data. May be `NULL`. Should be allocated by `lv_malloc`, and it will be freed automatically when the table is deleted or when the cell is dropped due to lower row or column count.

public/widgets/lv_table.h:152function

lv_table_set_selected_cell

Set the selected cell

void lv_table_set_selected_cell(lv_obj_t *obj, uint16_t row, uint16_t col)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a table object
`row`	`uint16_t`	id of the cell row to select
`col`	`uint16_t`	id of the cell column to select

public/widgets/lv_table.h:165function

lv_table_get_cell_value

Get the value of a cell.

const char * lv_table_get_cell_value(lv_obj_t *obj, uint32_t row, uint32_t col)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]

Returns: const char * — text in the cell

public/widgets/lv_table.h:172function

lv_table_get_row_count

Get the number of rows.

uint32_t lv_table_get_row_count(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object

Returns: uint32_t — number of rows.

public/widgets/lv_table.h:179function

lv_table_get_column_count

Get the number of columns.

uint32_t lv_table_get_column_count(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object

Returns: uint32_t — number of columns.

public/widgets/lv_table.h:187function

lv_table_get_column_width

Get the width of a column

int32_t lv_table_get_column_width(lv_obj_t *obj, uint32_t col)

Name	Type	Description
`obj`	`lv_obj_t *`	table pointer to a Table object
`col`	`uint32_t`	id of the column [0 .. LV_TABLE_COL_MAX -1]

Returns: int32_t — width of the column

public/widgets/lv_table.h:205function

lv_table_get_selected_cell

Get the selected cell (pressed and or focused)

void lv_table_get_selected_cell(lv_obj_t *obj, uint32_t *row, uint32_t *col)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a table object
`row`	`uint32_t *`	pointer to variable to store the selected row (LV_TABLE_CELL_NONE: if no cell selected)
`col`	`uint32_t *`	pointer to variable to store the selected column (LV_TABLE_CELL_NONE: if no cell selected)

public/widgets/lv_table.h:213function

lv_table_get_cell_user_data

Get custom user data to the cell.

void * lv_table_get_cell_user_data(lv_obj_t *obj, uint16_t row, uint16_t col)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint16_t`	id of the row [0 .. row_cnt -1]
`col`	`uint16_t`	id of the column [0 .. col_cnt -1]

public/widgets/lv_table.h:67function

lv_table_create

Create a table object

lv_obj_t * lv_table_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created table

public/widgets/lv_table.h:132function

lv_table_clear_cell_ctrl

Clear control bits of the cell.

void lv_table_clear_cell_ctrl(lv_obj_t *obj, uint32_t row, uint32_t col, lv_table_cell_ctrl_t ctrl)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]
`ctrl`	`lv_table_cell_ctrl_t`	OR-ed values from `lv_table_cell_ctrl_t`

public/widgets/lv_table.h:197function

lv_table_has_cell_ctrl

Get whether a cell has the control bits

bool lv_table_has_cell_ctrl(lv_obj_t *obj, uint32_t row, uint32_t col, lv_table_cell_ctrl_t ctrl)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a Table object
`row`	`uint32_t`	id of the row [0 .. row_cnt -1]
`col`	`uint32_t`	id of the column [0 .. col_cnt -1]
`ctrl`	`lv_table_cell_ctrl_t`	OR-ed values from `lv_table_cell_ctrl_t`

Returns: bool — true: all control bits are set; false: not all control bits are set

Enums

public/widgets/lv_table.h:37enum

lv_table_cell_ctrl_t

Name	Value
`LV_TABLE_CELL_CTRL_NONE`	`0 << 0`
`LV_TABLE_CELL_CTRL_MERGE_RIGHT`	`1 << 0`
`LV_TABLE_CELL_CTRL_TEXT_CROP`	`1 << 1`
`LV_TABLE_CELL_CTRL_CUSTOM_1`	`1 << 4`
`LV_TABLE_CELL_CTRL_CUSTOM_2`	`1 << 5`
`LV_TABLE_CELL_CTRL_CUSTOM_3`	`1 << 6`
`LV_TABLE_CELL_CTRL_CUSTOM_4`	`1 << 7`

Used by 3 functions

lv_table_set_cell_ctrl — param ctrl
lv_table_clear_cell_ctrl — param ctrl
lv_table_has_cell_ctrl — param ctrl

public/widgets/lv_table.h:50enum

_lv_property_table_id_t

Name	Value
`LV_PROPERTY_TABLE_ROW_COUNT`	`(LV_PROPERTY_TABLE_START + ((int) 0 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_TABLE_COLUMN_COUNT`	`(LV_PROPERTY_TABLE_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_TABLE_END`