lv_obj_class.h

API reference for lv_obj_class.h

Summary

Functions

public/core/lv_obj_class.h:79function

lv_obj_set_external_data

Associates an array of external data pointers with an LVGL object.

Associates custom user data with an LVGL object and specifies a destructor function that will be automatically invoked when the object is deleted to properly clean up the associated resources.

void lv_obj_set_external_data(lv_obj_t *obj, void *data, void(*free_cb)(void *data))

Name	Type	Description
`obj`	`lv_obj_t *`	Target LVGL object
`data`	`void *`	User-defined data pointer to associate with a object May be `NULL`.
`free_cb`	`void()(void data)`	Cleanup function called for each non-NULL data pointer during object deletion. Receives single data pointer as parameter. May be `NULL`. When NULL no automatic cleanup is performed.

public/core/lv_obj_class.h:57function

lv_obj_class_create_obj

Create an object form a class descriptor

lv_obj_t * lv_obj_class_create_obj(const lv_obj_class_t *class_p, lv_obj_t *parent)

Name	Type	Description
`class_p`	`const lv_obj_class_t *`	pointer to a class
`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 object

public/core/lv_obj_class.h:59function

lv_obj_class_init_obj

void lv_obj_class_init_obj(lv_obj_t *obj)

Name	Type
`obj`	`lv_obj_t *`

public/core/lv_obj_class.h:61function

lv_obj_is_editable

bool lv_obj_is_editable(const lv_obj_t *obj)

Name	Type
`obj`	`const lv_obj_t *`

public/core/lv_obj_class.h:63function

lv_obj_is_group_def

bool lv_obj_is_group_def(const lv_obj_t *obj)

Name	Type
`obj`	`const lv_obj_t *`

Enums

public/core/lv_obj_class.h:28enum

lv_obj_class_editable_t

Name	Description
`LV_OBJ_CLASS_EDITABLE_INHERIT`	Check the base class. Must have 0 value to let zero initialized class inherit
`LV_OBJ_CLASS_EDITABLE_TRUE`
`LV_OBJ_CLASS_EDITABLE_FALSE`

public/core/lv_obj_class.h:34enum

lv_obj_class_group_def_t

Name	Description
`LV_OBJ_CLASS_GROUP_DEF_INHERIT`	Check the base class. Must have 0 value to let zero initialized class inherit
`LV_OBJ_CLASS_GROUP_DEF_TRUE`
`LV_OBJ_CLASS_GROUP_DEF_FALSE`

public/core/lv_obj_class.h:40enum

lv_obj_class_theme_inheritable_t

Name	Description
`LV_OBJ_CLASS_THEME_INHERITABLE_FALSE`	Do not inherit theme from base class.
`LV_OBJ_CLASS_THEME_INHERITABLE_TRUE`

Typedefs

public/core/lv_obj_class.h:45typedef

lv_obj_class_event_cb_t

typedef void(* lv_obj_class_event_cb_t) (lv_obj_class_t *class_p, lv_event_t *e)