lv_bar.h

API reference for lv_bar.h

Summary

Functions

public/widgets/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

public/widgets/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

public/widgets/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.

public/widgets/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

public/widgets/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

public/widgets/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`

public/widgets/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`

public/widgets/lv_bar.h:135function

lv_bar_get_value

Get the value of a bar

int32_t lv_bar_get_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a bar object

Returns: int32_t — the value of the bar

public/widgets/lv_bar.h:142function

lv_bar_get_start_value

Get the start value of a bar

int32_t lv_bar_get_start_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a bar object

Returns: int32_t — the start value of the bar

public/widgets/lv_bar.h:149function

lv_bar_get_min_value

Get the minimum value of a bar

int32_t lv_bar_get_min_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a bar object

Returns: int32_t — the minimum value of the bar

public/widgets/lv_bar.h:156function

lv_bar_get_max_value

Get the maximum value of a bar

int32_t lv_bar_get_max_value(const lv_obj_t *obj)

Name	Type	Description
`obj`	`const lv_obj_t *`	pointer to a bar object

Returns: int32_t — the maximum value of the bar

public/widgets/lv_bar.h:163function

lv_bar_get_mode

Get the type of bar.

lv_bar_mode_t lv_bar_get_mode(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to bar object

Returns: lv_bar_mode_t — bar type from lv_bar_mode_t

public/widgets/lv_bar.h:170function

lv_bar_get_orientation

Get the orientation of bar.

lv_bar_orientation_t lv_bar_get_orientation(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to bar object

Returns: lv_bar_orientation_t — bar orientation from lv_bar_orientation_t

public/widgets/lv_bar.h:67function

lv_bar_create

Create a bar object

lv_obj_t * lv_bar_create(lv_obj_t *parent)

Name	Type	Description
`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 bar

public/widgets/lv_bar.h:177function

lv_bar_is_symmetrical

Give the bar is in symmetrical mode or not

bool lv_bar_is_symmetrical(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to bar object

Returns: bool — true: in symmetrical mode false : not in

public/widgets/lv_bar.h:186function

lv_bar_bind_value

Bind an integer or float Subject to a Bar's value.

lv_observer_t * lv_bar_bind_value(lv_obj_t *obj, lv_subject_t *subject)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to Bar
`subject`	`lv_subject_t *`	pointer to Subject

Returns: lv_observer_t * — pointer to newly-created Observer

Enums

public/widgets/lv_bar.h:31enum

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

public/widgets/lv_bar.h:37enum

lv_bar_orientation_t

Name
`LV_BAR_ORIENTATION_AUTO`
`LV_BAR_ORIENTATION_HORIZONTAL`
`LV_BAR_ORIENTATION_VERTICAL`