lv_flex.h

API reference for lv_flex.h

Summary

Functions

Set how the item should flow

void lv_obj_set_flex_flow(lv_obj_t *obj, lv_flex_flow_t flow)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an object. The parent must have flex layout else nothing will happen.
`flow`	`lv_flex_flow_t`	an element of `lv_flex_flow_t`.

Set how to place (where to align) the items and tracks

void lv_obj_set_flex_align(lv_obj_t *obj, lv_flex_align_t main_place, lv_flex_align_t cross_place, lv_flex_align_t track_cross_place)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an object. The parent must have flex layout else nothing will happen.
`main_place`	`lv_flex_align_t`	where to place the items on main axis (in their track). Any value of `lv_flex_align_t`.
`cross_place`	`lv_flex_align_t`	where to place the item in their track on the cross axis. `LV_FLEX_ALIGN_START/END/CENTER`
`track_cross_place`	`lv_flex_align_t`	where to place the tracks in the cross direction. Any value of `lv_flex_align_t`.

Sets the width or height (on main axis) to grow the object in order fill the free space

void lv_obj_set_flex_grow(lv_obj_t *obj, uint8_t grow)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to an object. The parent must have flex layout else nothing will happen.
`grow`	`uint8_t`	a value to set how much free space to take proportionally to other growing items.

Used by 9 functions

Name	Value
`LV_FLEX_FLOW_ROW`	`0x00`
`LV_FLEX_FLOW_COLUMN`	`(1 << 0)`
`LV_FLEX_FLOW_ROW_WRAP`	`LV_FLEX_FLOW_ROW \| (1 << 2)`
`LV_FLEX_FLOW_ROW_REVERSE`	`LV_FLEX_FLOW_ROW \| (1 << 3)`
`LV_FLEX_FLOW_ROW_WRAP_REVERSE`	`LV_FLEX_FLOW_ROW \| (1 << 2) \| (1 << 3)`
`LV_FLEX_FLOW_COLUMN_WRAP`	`LV_FLEX_FLOW_COLUMN \| (1 << 2)`
`LV_FLEX_FLOW_COLUMN_REVERSE`	`LV_FLEX_FLOW_COLUMN \| (1 << 3)`
`LV_FLEX_FLOW_COLUMN_WRAP_REVERSE`	`LV_FLEX_FLOW_COLUMN \| (1 << 2) \| (1 << 3)`

Used by 3 functions

#define LV_FLEX_COLUMN (1 << 0)

#define LV_FLEX_WRAP (1 << 2)

#define LV_FLEX_REVERSE (1 << 3)

Indirect dependencies