lv_roller.h

API reference for lv_roller.h

Summary

Functions

Set the options on a roller

void lv_roller_set_options(lv_obj_t *obj, const char *options, lv_roller_mode_t mode)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to roller object
`options`	`const char *`	a string with '<br/> ' separated options. E.g. "One\nTwo\nThree"
`mode`	`lv_roller_mode_t`	`LV_ROLLER_MODE_NORMAL` or `LV_ROLLER_MODE_INFINITE`

Set the selected option

void lv_roller_set_selected(lv_obj_t *obj, uint32_t sel_opt, lv_anim_enable_t anim)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a roller object
`sel_opt`	`uint32_t`	index of the selected option (0 ... number of option - 1);
`anim`	`lv_anim_enable_t`	LV_ANIM_ON: set with animation; LV_ANIM_OFF set immediately

Sets the given string as the selection on the roller. Does not alter the current selection on failure.

bool lv_roller_set_selected_str(lv_obj_t *obj, const char *sel_opt, lv_anim_enable_t anim)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to roller object
`sel_opt`	`const char *`	pointer to the string you want to set as an option
`anim`	`lv_anim_enable_t`	LV_ANIM_ON: set with animation; LV_ANIM_OFF set immediately

Returns: bool — true if set successfully and false if the given string does not exist as an option in the roller

Set the height to show the given number of rows (options)

void lv_roller_set_visible_row_count(lv_obj_t *obj, uint32_t row_cnt)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a roller object
`row_cnt`	`uint32_t`	number of desired visible rows

Roller mode.

Name	Description
`LV_ROLLER_MODE_NORMAL`	Normal mode (roller ends at the end of the options).
`LV_ROLLER_MODE_INFINITE`	Infinite mode (roller can be scrolled forever).

Used by 1 function

Name	Value
`LV_PROPERTY_ROLLER_OPTIONS`	`(LV_PROPERTY_ROLLER_START + ((int) 0 )) \| (( 7 ) << 28 ) \| (( 1 ) << 24 )`
`LV_PROPERTY_ROLLER_SELECTED`	`(LV_PROPERTY_ROLLER_START + ((int) 1 )) \| (( 1 ) << 28 ) \| (( 1 ) << 24 )`
`LV_PROPERTY_ROLLER_VISIBLE_ROW_COUNT`	`(LV_PROPERTY_ROLLER_START + ((int) 2 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_ROLLER_END`

const lv_obj_class_t lv_roller_class

Indirect dependencies