lv_bar.h

API reference for lv_bar.h

Summary

Functions

widgets/bar/lv_bar.h:79function

lv_bar_set_value

Set a new value on the bar

void lv_bar_set_value(lv_obj_t *obj, int32_t value, lv_anim_enable_t anim)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a bar object
`value`	`int32_t`	new value
`anim`	`lv_anim_enable_t`	LV_ANIM_ON: set the value with an animation; LV_ANIM_OFF: change the value immediately

widgets/bar/lv_bar.h:87function

lv_bar_set_start_value

Set a new start value on the bar

void lv_bar_set_start_value(lv_obj_t *obj, int32_t start_value, lv_anim_enable_t anim)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a bar object
`start_value`	`int32_t`	new start value
`anim`	`lv_anim_enable_t`	LV_ANIM_ON: set the value with an animation; LV_ANIM_OFF: change the value immediately

widgets/bar/lv_bar.h:96function

lv_bar_set_range

Set minimum and the maximum values of a bar

void lv_bar_set_range(lv_obj_t *obj, int32_t min, int32_t max)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the bar object
`min`	`int32_t`	minimum value
`max`	`int32_t`	maximum value

If min is greater than max, the drawing direction becomes to the opposite direction.

widgets/bar/lv_bar.h:103function

lv_bar_set_min_value

Set minimum value of a bar

void lv_bar_set_min_value(lv_obj_t *obj, int32_t min)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the bar object
`min`	`int32_t`	minimum value

widgets/bar/lv_bar.h:110function

lv_bar_set_max_value

Set maximum value of a bar

void lv_bar_set_max_value(lv_obj_t *obj, int32_t max)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the bar object
`max`	`int32_t`	maximum value

widgets/bar/lv_bar.h:117function

lv_bar_set_mode

Set the type of bar.

void lv_bar_set_mode(lv_obj_t *obj, lv_bar_mode_t mode)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to bar object
`mode`	`lv_bar_mode_t`	bar type from `lv_bar_mode_t`

widgets/bar/lv_bar.h:124function

lv_bar_set_orientation

Set the orientation of bar.

void lv_bar_set_orientation(lv_obj_t *obj, lv_bar_orientation_t orientation)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to bar object
`orientation`	`lv_bar_orientation_t`	bar orientation from `lv_bar_orientation_t`

Enums

widgets/bar/lv_bar.h:32enum

lv_bar_mode_t

Name
`LV_BAR_MODE_NORMAL`
`LV_BAR_MODE_SYMMETRICAL`
`LV_BAR_MODE_RANGE`

Used by 1 function

lv_bar_set_mode — param mode

widgets/bar/lv_bar.h:38enum

lv_bar_orientation_t

Name
`LV_BAR_ORIENTATION_AUTO`
`LV_BAR_ORIENTATION_HORIZONTAL`
`LV_BAR_ORIENTATION_VERTICAL`

Used by 1 function

lv_bar_set_orientation — param orientation

widgets/bar/lv_bar.h:47enum

_lv_property_bar_id_t

Name	Value
`LV_PROPERTY_BAR_VALUE`	`(LV_PROPERTY_BAR_START + ((int) 0 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_START_VALUE`	`(LV_PROPERTY_BAR_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_MIN_VALUE`	`(LV_PROPERTY_BAR_START + ((int) 2 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_MAX_VALUE`	`(LV_PROPERTY_BAR_START + ((int) 3 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_MODE`	`(LV_PROPERTY_BAR_START + ((int) 4 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_ORIENTATION`	`(LV_PROPERTY_BAR_START + ((int) 5 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_BAR_END`

Variables

widgets/bar/lv_bar.h:44variable

lv_bar_class

const lv_obj_class_t lv_bar_class

Dependencies

Indirect dependencies

lv_bar.h

On this page