lv_obj_tree.h

lv_obj_set_parent

Move the parent of an object. The relative coordinates will be kept.

void lv_obj_set_parent(lv_obj_t *obj, lv_obj_t *parent)

lv_obj_set_name

Set a name for a widget. The name will be allocated and freed when the widget is deleted or a new name is set.

void lv_obj_set_name(lv_obj_t *obj, const char *name)

lv_obj_set_name_static

Set a name for a widget. Only a pointer will be saved.

void lv_obj_set_name_static(lv_obj_t *obj, const char *name)

lv_obj_get_screen

Get the screen of an object

lv_obj_t * lv_obj_get_screen(const lv_obj_t *obj)

Returns: lv_obj_t * — pointer to the object's screen

lv_obj_get_display

Get the display of the object

lv_display_t * lv_obj_get_display(const lv_obj_t *obj)

Returns: lv_display_t * — pointer to the object's display

lv_obj_get_parent

Get the parent of an object

lv_obj_t * lv_obj_get_parent(const lv_obj_t *obj)

Returns: lv_obj_t * — the parent of the object. (NULL if obj was a screen)

lv_obj_get_child

Get the child of an object by the child's index.

lv_obj_t * lv_obj_get_child(const lv_obj_t *obj, int32_t idx)

Returns: lv_obj_t * — pointer to the child or NULL if the index was invalid

lv_obj_get_child_by_type

Get the child of an object by the child's index. Consider the children only with a given type.

lv_obj_t * lv_obj_get_child_by_type(const lv_obj_t *obj, int32_t idx, const lv_obj_class_t *class_p)

Returns: lv_obj_t * — pointer to the child or NULL if the index was invalid

lv_obj_get_sibling

Return a sibling of an object

lv_obj_t * lv_obj_get_sibling(const lv_obj_t *obj, int32_t idx)

Returns: lv_obj_t * — pointer to the requested sibling or NULL if there is no such sibling - would navigate outside the array of children using the index (get the -3rd sibling of the second child of the parent)

lv_obj_get_sibling_by_type

Return a sibling of an object. Consider the siblings only with a given type.

lv_obj_t * lv_obj_get_sibling_by_type(const lv_obj_t *obj, int32_t idx, const lv_obj_class_t *class_p)

Returns: lv_obj_t * — pointer to the requested sibling or NULL if there is no such sibling or would navigate outside the array of children using the index (get the -3rd sibling of the second child of the parent)

lv_obj_get_child_count

Get the number of children

uint32_t lv_obj_get_child_count(const lv_obj_t *obj)

Returns: uint32_t — the number of children

lv_obj_get_child_count_by_type

Get the number of children having a given type.

uint32_t lv_obj_get_child_count_by_type(const lv_obj_t *obj, const lv_obj_class_t *class_p)

Returns: uint32_t — the number of children

lv_obj_get_name

Get the set name as it was set.

const char * lv_obj_get_name(const lv_obj_t *obj)

Returns: const char * — get the set name or NULL if it wasn't set yet

lv_obj_get_name_resolved

Get the set name or craft a name automatically.

void lv_obj_get_name_resolved(const lv_obj_t *obj, char buf[], size_t buf_size)

lv_obj_get_child_by_name

Get an object by name. The name can be a path too, for example "main_container/lv_button_1/label". In this case the first part of the name-path should be the direct child of the parent, the second part, should the direct child of first one, etc.

If the name of a widget was not set a name like "lv_button_1" will be created for it using lv_obj_get_name_resolved.

lv_obj_t * lv_obj_get_child_by_name(const lv_obj_t *parent, const char *name_path)

Returns: lv_obj_t * — the found widget or NULL if not found.

lv_obj_get_index

Get the index of a child.

int32_t lv_obj_get_index(const lv_obj_t *obj)

Returns: int32_t — the child index of the object. E.g. 0: the oldest (firstly created child). (-1 if child could not be found or no parent exists)

lv_obj_get_index_by_type

Get the index of a child. Consider the children only with a given type.

int32_t lv_obj_get_index_by_type(const lv_obj_t *obj, const lv_obj_class_t *class_p)

Returns: int32_t — the child index of the object. E.g. 0: the oldest (firstly created child with the given class). (-1 if child could not be found or no parent exists)

lv_obj_delete

Delete an object and all of its children. Also remove the objects from their group and remove all animations (if any). Send LV_EVENT_DELETE to deleted objects.

void lv_obj_delete(lv_obj_t *obj)

lv_obj_clean

Delete all children of an object. Also remove the objects from their group and remove all animations (if any). Send LV_EVENT_DELETE to deleted objects.

void lv_obj_clean(lv_obj_t *obj)

lv_obj_delete_delayed

Delete an object after some delay

void lv_obj_delete_delayed(lv_obj_t *obj, uint32_t delay_ms)

lv_obj_delete_anim_completed_cb

A function to be easily used in animation ready callback to delete an object when the animation is ready

void lv_obj_delete_anim_completed_cb(lv_anim_t *a)

lv_obj_delete_async

Helper function for asynchronously deleting objects. Useful for cases where you can't delete an object directly in an LV_EVENT_DELETE handler (i.e. parent).

void lv_obj_delete_async(lv_obj_t *obj)

See also: lv_async_call

lv_obj_swap

Swap the positions of two objects. When used in listboxes, it can be used to sort the listbox items.

void lv_obj_swap(lv_obj_t *obj1, lv_obj_t *obj2)

lv_obj_move_to_index

moves the object to the given index in its parent. When used in listboxes, it can be used to sort the listbox items.

void lv_obj_move_to_index(lv_obj_t *obj, int32_t index)

lv_obj_find_by_name

Find a child with a given name on a parent. This child doesn't have to be the direct child of the parent. First direct children of the parent will be checked, and the direct children of the first child, etc. (Breadth-first search).

If the name of a widget was not set a name like "lv_button_1" will be created for it using lv_obj_get_name_resolved.

lv_obj_t * lv_obj_find_by_name(const lv_obj_t *parent, const char *name)

Returns: lv_obj_t * — the found widget or NULL if not found.

lv_obj_tree_walk

Iterate through all children of any object.

void lv_obj_tree_walk(lv_obj_t *start_obj, lv_obj_tree_walk_cb_t cb, void *user_data)

lv_obj_dump_tree

Iterate through all children of any object and print their ID.

void lv_obj_dump_tree(lv_obj_t *start_obj)