lv_obj_property.h

API reference for lv_obj_property.h

Summary

Functions

core/lv_obj_property.h:209function

lv_obj_set_property

Set Widget property.

lv_result_t lv_obj_set_property(lv_obj_t *obj, const lv_property_t *value)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`value`	`const lv_property_t *`	property value to set

Returns: lv_result_t — return LV_RESULT_OK if call succeeded

core/lv_obj_property.h:218function

lv_obj_set_properties

Set multiple Widget properties. Helper LV_OBJ_SET_PROPERTY_ARRAY can be used for constant property array.

lv_result_t lv_obj_set_properties(lv_obj_t *obj, const lv_property_t *value, uint32_t count)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Widget
`value`	`const lv_property_t *`	property value array to set
`count`	`uint32_t`	number of array elements

Returns: lv_result_t — return LV_RESULT_OK if call succeeded

Enums

core/lv_obj_property.h:91enum

_lv_prop_id_range_boundary_t

Group of predefined widget ID start value.

Name	Value
`LV_PROPERTY_ID_INVALID`	`0`
`LV_PROPERTY_STYLE_START`	`0x00`
`LV_PROPERTY_ID_START`	`0x0100`
`LV_PROPERTY_OBJ_START`	`0x0100`
`LV_PROPERTY_IMAGE_START`	`0x0200`
`LV_PROPERTY_LABEL_START`	`0x0300`
`LV_PROPERTY_KEYBOARD_START`	`0x0400`
`LV_PROPERTY_TEXTAREA_START`	`0x0500`
`LV_PROPERTY_ROLLER_START`	`0x0600`
`LV_PROPERTY_DROPDOWN_START`	`0x0700`
`LV_PROPERTY_SLIDER_START`	`0x0800`
`LV_PROPERTY_ANIMIMAGE_START`	`0x0900`
`LV_PROPERTY_ARC_START`	`0x0a00`
`LV_PROPERTY_BAR_START`	`0x0b00`
`LV_PROPERTY_SWITCH_START`	`0x0c00`
`LV_PROPERTY_CHECKBOX_START`	`0x0d00`
`LV_PROPERTY_LED_START`	`0x0e00`
`LV_PROPERTY_LINE_START`	`0x0f00`
`LV_PROPERTY_SCALE_START`	`0x1000`
`LV_PROPERTY_SPINBOX_START`	`0x1100`
`LV_PROPERTY_SPINNER_START`	`0x1200`
`LV_PROPERTY_TABLE_START`	`0x1300`
`LV_PROPERTY_TABVIEW_START`	`0x1400`
`LV_PROPERTY_BUTTONMATRIX_START`	`0x1500`
`LV_PROPERTY_SPAN_START`	`0x1600`
`LV_PROPERTY_MENU_START`	`0x1700`
`LV_PROPERTY_CHART_START`	`0x1800`
`LV_PROPERTY_ID_BUILTIN_LAST`	`0xffff`
`LV_PROPERTY_ID_ANY`	`0x7ffffffe`

Structs

struct

_lv_property_name_t

Member	Type	Description
`name`	`const char *`
`id`	`lv_prop_id_t`

struct

lv_property_t

Member	Type	Description
`id`	`lv_prop_id_t`
`num`	`int32_t`	Signed integer number (enums or "normal" numbers)
`num_u`	`uint32_t`	Unsigned integer number (opacity, Booleans) <br/>
`enable`	`bool`	Booleans
`ptr`	`const void *`	Constant pointers (font, cone text, etc.)
`color`	`lv_color_t`	Colors
`precise`	`lv_value_precise_t`	float or int for precise value
`point`	`lv_point_t`	Point, contains two int32_t
`style`	`lv_style_value_t`	Note that place struct member `style` at first place is intended. `style` shares same memory with `num`, `ptr`, `color`. So we set the style value directly without using `prop.style.num`. E.g. static const `lv_property_t` obj_pos_x = { .id = LV_PROPERTY_STYLE_X, .num = 123, .selector = LV_STATE_PRESSED, } instead of: static const `lv_property_t` obj_pos_x = { .id = LV_PROPERTY_STYLE_X, .style.num = 123, // note this line. .selector = LV_STATE_PRESSED, } Make sure it's the first element in struct.
`selector`	`uint32_t`	Style selector, lv_part_t \| lv_state_t
`arg1`	`union lv_property_t`
`arg2`	`union lv_property_t`
``	`union lv_property_t`

Used by 2 functions

lv_obj_set_property — param value
lv_obj_set_properties — param value

struct

lv_property_ops_t

Member	Type	Description
`id`	`lv_prop_id_t`
`setter`	`void *`	Callback used to set property.
`getter`	`void *`	Callback used to get property.

Macros

core/lv_obj_property.h:27macro

LV_PROPERTY_TYPE_INVALID

#define LV_PROPERTY_TYPE_INVALID 0   /*Use default 0 as invalid to detect program outliers*/

core/lv_obj_property.h:28macro

LV_PROPERTY_TYPE_INT

#define LV_PROPERTY_TYPE_INT 1   /*int32_t type*/

core/lv_obj_property.h:29macro

LV_PROPERTY_TYPE_PRECISE

#define LV_PROPERTY_TYPE_PRECISE 2   /*lv_value_precise_t, int32_t or float depending on LV_USE_FLOAT*/

core/lv_obj_property.h:30macro

LV_PROPERTY_TYPE_COLOR

#define LV_PROPERTY_TYPE_COLOR 3   /*ARGB8888 type*/

core/lv_obj_property.h:31macro

LV_PROPERTY_TYPE_POINT

#define LV_PROPERTY_TYPE_POINT 4   /*lv_point_t */

core/lv_obj_property.h:32macro

LV_PROPERTY_TYPE_POINTER

#define LV_PROPERTY_TYPE_POINTER 5   /*void * pointer*/

core/lv_obj_property.h:33macro

LV_PROPERTY_TYPE_IMGSRC

#define LV_PROPERTY_TYPE_IMGSRC 6   /*Special pointer for image*/

core/lv_obj_property.h:34macro

LV_PROPERTY_TYPE_TEXT

#define LV_PROPERTY_TYPE_TEXT 7   /*Special pointer of char* */

core/lv_obj_property.h:35macro

LV_PROPERTY_TYPE_OBJ

#define LV_PROPERTY_TYPE_OBJ 8   /*Special pointer of lv_obj_t* */

core/lv_obj_property.h:36macro

LV_PROPERTY_TYPE_DISPLAY

#define LV_PROPERTY_TYPE_DISPLAY 9   /*Special pointer of lv_display_t* */

core/lv_obj_property.h:37macro

LV_PROPERTY_TYPE_FONT

#define LV_PROPERTY_TYPE_FONT 10  /*Special pointer of lv_font_t* */

core/lv_obj_property.h:38macro

LV_PROPERTY_TYPE_BOOL

#define LV_PROPERTY_TYPE_BOOL 11  /*int32_t type*/

core/lv_obj_property.h:40macro

LV_PROPERTY_TYPE_SHIFT

#define LV_PROPERTY_TYPE_SHIFT 28

core/lv_obj_property.h:41macro

LV_PROPERTY_TYPE2_SHIFT

#define LV_PROPERTY_TYPE2_SHIFT 24

core/lv_obj_property.h:48macro

LV_PROPERTY_ID

#define LV_PROPERTY_ID(clz, name, type, index) \
    LV_PROPERTY_## clz ##_##name = (LV_PROPERTY_## clz ##_START + ((int)index)) | ((type) << LV_PROPERTY_TYPE_SHIFT)

core/lv_obj_property.h:55macro

LV_PROPERTY_ID2

#define LV_PROPERTY_ID2(clz, name, type, type2, index) \
    LV_PROPERTY_ID(clz, name, type, index) | ((type2) << LV_PROPERTY_TYPE2_SHIFT)

core/lv_obj_property.h:57macro

LV_PROPERTY_ID_TYPE

#define LV_PROPERTY_ID_TYPE(id) \
    ((id) >> LV_PROPERTY_TYPE_SHIFT)

core/lv_obj_property.h:58macro

LV_PROPERTY_ID_TYPE2

#define LV_PROPERTY_ID_TYPE2(id) \
    ((id) >> LV_PROPERTY_TYPE_SHIFT)

core/lv_obj_property.h:59macro

LV_PROPERTY_ID_INDEX

#define LV_PROPERTY_ID_INDEX(id) \
    ((id) & 0xfffffff)

core/lv_obj_property.h:62macro

LV_OBJ_SET_PROPERTY_ARRAY

#define LV_OBJ_SET_PROPERTY_ARRAY(obj, array) \
    lv_obj_set_properties(obj, array, LV_ARRAYLEN(array))

core/lv_obj_property.h:67macro

LV_PROPERTY_CLASS_FIELDS

#define LV_PROPERTY_CLASS_FIELDS(widget, uppercase) \
    .prop_index_start = LV_PROPERTY_##uppercase##_START, \
        .prop_index_end = LV_PROPERTY_##uppercase##_END, \
        .properties = lv_##widget##_properties, \
        .properties_count = LV_ARRAYLEN(lv_##widget##_properties), \
        .property_names = lv_##widget##_property_names, \
        .names_count = LV_ARRAYLEN(lv_##widget##_property_names)

lv_obj_property.h

Functions

lv_obj_set_property

lv_obj_set_properties

Enums

_lv_prop_id_range_boundary_t

Structs

_lv_property_name_t

lv_property_t

lv_property_ops_t

Macros

LV_PROPERTY_TYPE_INVALID

LV_PROPERTY_TYPE_INT

LV_PROPERTY_TYPE_PRECISE

LV_PROPERTY_TYPE_COLOR

LV_PROPERTY_TYPE_POINT

LV_PROPERTY_TYPE_POINTER

LV_PROPERTY_TYPE_IMGSRC

LV_PROPERTY_TYPE_TEXT

LV_PROPERTY_TYPE_OBJ

LV_PROPERTY_TYPE_DISPLAY

LV_PROPERTY_TYPE_FONT

LV_PROPERTY_TYPE_BOOL

LV_PROPERTY_TYPE_SHIFT

LV_PROPERTY_TYPE2_SHIFT

LV_PROPERTY_ID

LV_PROPERTY_ID2

LV_PROPERTY_ID_TYPE

LV_PROPERTY_ID_TYPE2

LV_PROPERTY_ID_INDEX

LV_OBJ_SET_PROPERTY_ARRAY

LV_PROPERTY_CLASS_FIELDS

Dependencies

On this page