lv_tree.h

API reference for lv_tree.h

Summary

Functions

private/misc/lv_tree.h:73function

lv_tree_node_create

Create a tree node.

lv_tree_node_t * lv_tree_node_create(const lv_tree_class_t *class_p, lv_tree_node_t *parent)

Name	Type	Description
`class_p`	`const lv_tree_class_t *`	pointer to a class of the node
`parent`	`lv_tree_node_t *`	pointer to the parent node (or NULL if it's the root node)

Returns: lv_tree_node_t * — pointer to the new node

private/misc/lv_tree.h:79function

lv_tree_node_delete

Delete a tree node and all its children recursively.

void lv_tree_node_delete(lv_tree_node_t *node)

Name	Type	Description
`node`	`lv_tree_node_t *`	pointer to the node to delete

private/misc/lv_tree.h:91function

lv_tree_walk

Walk the tree recursively and call a callback function on each node.

bool lv_tree_walk(const lv_tree_node_t *node, lv_tree_walk_mode_t mode, lv_tree_traverse_cb_t cb, lv_tree_before_cb_t bcb, lv_tree_after_cb_t acb, void *user_data)

Name	Type	Description
`node`	`const lv_tree_node_t *`	pointer to the root node of the tree
`mode`	`lv_tree_walk_mode_t`	LV_TREE_WALK_PRE_ORDER or LV_TREE_WALK_POST_ORDER
`cb`	`lv_tree_traverse_cb_t`	callback function to call on each node
`bcb`	`lv_tree_before_cb_t`	callback function to call before visiting a node
`acb`	`lv_tree_after_cb_t`	callback function to call after visiting a node
`user_data`	`void *`	user data to pass to the callback functions May be `NULL`.

Returns: bool — true: traversal is finished; false: traversal broken

Enums

private/misc/lv_tree.h:51enum

_lv_tree_walk_mode_t

Name	Value
`LV_TREE_WALK_PRE_ORDER`	`0`
`LV_TREE_WALK_POST_ORDER`

Structs

struct

_lv_tree_class_t

Describe the common methods of every object. Similar to a C++ class.

Member	Type	Description
`base_class`	`const lv_tree_class_t *`
`instance_size`	`uint32_t`
`constructor_cb`	`lv_tree_constructor_cb_t`
`destructor_cb`	`lv_tree_destructor_cb_t`

struct

_lv_tree_node_t

Description of a tree node

Member	Type	Description
`parent`	`lv_tree_node_t *`
`children`	`lv_tree_node_t **`
`child_cnt`	`uint32_t`
`child_cap`	`uint32_t`
`class_p`	`const lv_tree_class_t *`

Typedefs

private/misc/lv_tree.h:28typedef

lv_tree_constructor_cb_t

typedef void(* lv_tree_constructor_cb_t) (const lv_tree_class_t *class_p, lv_tree_node_t *node)

private/misc/lv_tree.h:29typedef

lv_tree_destructor_cb_t

typedef void(* lv_tree_destructor_cb_t) (const lv_tree_class_t *class_p, lv_tree_node_t *node)

private/misc/lv_tree.h:55typedef

lv_tree_walk_mode_t

typedef uint8_t lv_tree_walk_mode_t

Used by 1 function

lv_tree_walk — param mode

private/misc/lv_tree.h:57typedef

lv_tree_traverse_cb_t

typedef bool(* lv_tree_traverse_cb_t) (const lv_tree_node_t *node, void *user_data)

Used by 1 function

lv_tree_walk — param cb

private/misc/lv_tree.h:58typedef

lv_tree_before_cb_t

typedef bool(* lv_tree_before_cb_t) (const lv_tree_node_t *node, void *user_data)

Used by 1 function

lv_tree_walk — param bcb

private/misc/lv_tree.h:59typedef

lv_tree_after_cb_t

typedef void(* lv_tree_after_cb_t) (const lv_tree_node_t *node, void *user_data)

Used by 1 function

lv_tree_walk — param acb

Macros

private/misc/lv_tree.h:21macro

LV_TREE_NODE

#define LV_TREE_NODE(n) \
    ((lv_tree_node_t*)(n))

Variables

private/misc/lv_tree.h:65variable

lv_tree_node_class

const lv_tree_class_t lv_tree_node_class

Dependencies

lvgl_public.h

lv_tree.h

On this page