App:Library:LVGL:docs:Layouts:Grid

提供: robot-jp wiki
2022年6月28日 (火) 12:20時点におけるTakashi (トーク | 投稿記録)による版
ナビゲーションに移動検索に移動

https://docs.lvgl.io/8.2/widgets/index.html

英文 自動翻訳

Grid

Overview

The Grid layout is a subset of CSS Flexbox.

It can arrange items into a 2D "table" that has rows or columns (tracks). The item can span through multiple columns or rows. The track's size can be set in pixel, to the largest item (LV_GRID_CONTENT) or in "Free unit" (FR) to distribute the free space proportionally.

To make an object a grid container call lv_obj_set_layout(obj, LV_LAYOUT_GRID).

Note that the grid layout feature of LVGL needs to be globally enabled with LV_USE_GRID in lv_conf.h.

Terms

  • tracks: the rows or columns
  • free unit (FR): if set on track's size is set in FR it will grow to fill the remaining space on the parent.
  • gap: the space between the rows and columns or the items on a track

Simple interface

With the following functions you can easily set a Grid layout on any parent.

Grid descriptors

First you need to describe the size of rows and columns. It can be done by declaring 2 arrays and the track sizes in them. The last element must be LV_GRID_TEMPLATE_LAST.

For example: 

static lv_coord_t column_dsc[] = {100, 400, LV_GRID_TEMPLATE_LAST};   /*2 columns with 100 and 400 ps width*/
static lv_coord_t row_dsc[] = {100, 100, 100, LV_GRID_TEMPLATE_LAST}; /*3 100 px tall rows*/

To set the descriptors on a parent use lv_obj_set_grid_dsc_array(obj, col_dsc, row_dsc).

Besides simple settings the size in pixel you can use two special values:

  • LV_GRID_CONTENT set the width to the largest children on this track
  • LV_GRID_FR(X) tell what portion of the remaining space should be used by this track. Larger value means larger space.

Grid items

By default, the children are not added to the grid. They need to be added manually to a cell.

To do this call lv_obj_set_grid_cell(child, column_align, column_pos, column_span, row_align, row_pos, row_span).

column_align and row_align determine how to align the children in its cell. The possible values are:

  • LV_GRID_ALIGN_START means left on a horizontally and top vertically. (default)
  • LV_GRID_ALIGN_END means right on a horizontally and bottom vertically
  • LV_GRID_ALIGN_CENTER simply center

colum_pos and row_pos means the zero based index of the cell into the item should be placed.

colum_span and row_span means how many tracks should the item involve from the start cell. Must be > 1.

Grid align

If there are some empty space the track can be aligned several ways:

  • LV_GRID_ALIGN_START means left on a horizontally and top vertically. (default)
  • LV_GRID_ALIGN_END means right on a horizontally and bottom vertically
  • LV_GRID_ALIGN_CENTER simply center
  • LV_GRID_ALIGN_SPACE_EVENLY items are distributed so that the spacing between any two items (and the space to the edges) is equal. Not applies to track_cross_place.
  • LV_GRID_ALIGN_SPACE_AROUND items are evenly distributed in the track with equal space around them. Note that visually the spaces aren’t equal, since all the items have equal space on both sides. The first item will have one unit of space against the container edge, but two units of space between the next item because that next item has its own spacing that applies. Not applies to track_cross_place.
  • LV_GRID_ALIGN_SPACE_BETWEEN items are evenly distributed in the track: first item is on the start line, last item on the end line. Not applies to track_cross_place.

To set the track's alignment use lv_obj_set_grid_align(obj, column_align, row_align).

Style interface

All the Grid related values are style properties under the hood and you can use them similarly to any other style properties. The following Grid related style properties exist:

  • GRID_COLUMN_DSC_ARRAY
  • GRID_ROW_DSC_ARRAY
  • GRID_COLUMN_ALIGN
  • GRID_ROW_ALIGN
  • GRID_CELL_X_ALIGN
  • GRID_CELL_COLUMN_POS
  • GRID_CELL_COLUMN_SPAN
  • GRID_CELL_Y_ALIGN
  • GRID_CELL_ROW_POS
  • GRID_CELL_ROW_SPAN

Internal padding

To modify the minimum space Grid inserts between objects, the following properties can be set on the Grid container style:

  • pad_row Sets the padding between the rows.
  • pad_column Sets the padding between the columns.

Other features

RTL

If the base direction of the container is set to LV_BASE_DIR_RTL, the meaning of LV_GRID_ALIGN_START and LV_GRID_ALIGN_END is swapped. I.e. START will mean right-most.

The columns will be placed from right to left.

Example

A simple grid

https://docs.lvgl.io/8.2/layouts/grid.html#a-simple-grid

Demonstrate cell placement and span

https://docs.lvgl.io/8.2/layouts/grid.html#demonstrate-cell-placement-and-span

Demonstrate grid's "free unit"

https://docs.lvgl.io/8.2/layouts/grid.html#demonstrate-grid-s-free-unit

Demonstrate track placement

https://docs.lvgl.io/8.2/layouts/grid.html#demonstrate-track-placement

Demonstrate column and row gap

https://docs.lvgl.io/8.2/layouts/grid.html#demonstrate-column-and-row-gap

Demonstrate RTL direction on grid

https://docs.lvgl.io/8.2/layouts/grid.html#demonstrate-rtl-direction-on-grid

API

Enums

enum lv_grid_align_t[1]
Values:
enume[2]rator LV_GRID_ALIGN_START[3]
enumerator LV_GRID_A[4]LIGN_CENTER[5]
enumerator LV_GRID_AL[6]IGN_END[7]
enumerator LV_GRID[8]_ALIGN_STRETCH[9]
enumerator LV_GRID_ALI[10]GN_SPACE_EVENLY[11]
enumerator LV_GRID_ALIGN_SP[12]ACE_AROUND[13]
enumerator LV_GRID_ALIGN_SP[14]ACE_BETWEEN[15]

Functions

LV_EXPORT_CONST[16]_INT(LV_GRID_CONTENT)[17]
LV_EXPORT_CONST_INT(LV_GRI[18]D_TEMPLATE_LAST)[19]
void lv_grid_init(void)[20]

[21]

void lv_obj_s[22]et_grid_dsc_array(lv_obj_t *obj, const lv_coord_t col_dsc[], const lv_coord_t row_dsc[])[23]
void lv_obj_set_grid_align(lv_obj_t *obj, lv_grid_align_t column_align, lv_grid_align_t row[24]_align)[25]
void lv_obj_set_grid_cell(lv_obj_t *obj, lv_grid_align_t column_align, uint8_t col_pos, [26]uint8_t col_span, lv_grid_align_t row_align, uint8_t row_pos, uint8_t row_span)[27]
Set the cell of an object. The object's parent needs to have grid layout, else nothing will happen
Parameters
  • obj -- pointer to an object
  • column_align -[28]- the vertical alignment in the cell. LV_GRID_START/END/CENTER/STRETCH
  • col_pos -- column ID
  • col_span -- number of columns to take (>= 1)
  • row_align -- the horizontal alignment in the cell. LV_GRID_START/END/CENTER/STRETCH
  • row_pos -- row ID
  • row_span -- number of rows to take (>= 1)
static inline lv_coord_t lv_grid_fr(uint8_t x)[29]
Just a wrapper to LV_GRID_FR for bindings.[30]
void lv_style_set_grid_row_dsc_array(lv_style_t *style, const lv_coord_t value[])[31]
void lv_style_set_grid_column_dsc_array(lv_style_t *style, const lv_coo[32]rd_t value[])[33]
void lv_style_set_grid_row_align(lv_style_t *style, lv_grid_align_t value)[34][35]
void lv_style_set_grid_column_align(lv_style_t *style, lv_grid_a[36]lign_t value)[37]
void lv_style_set_grid_cell_column_pos(lv_style_t *style, lv_coord_[38]t value)[39]
void lv_style_set_grid_cell_column_span(lv_style_t *style, lv_coo[40]rd_t value)[41]
void lv_style_set_grid_cell_row_pos(lv_style_t *style, lv_coord_t [42]value)[43]
void lv_style_set_grid_cell_row_span(lv_style_t *style, lv_coo[44]rd_t value)[45]
void lv_style_set_grid_cell_x_align(lv_style_t *style, lv_coord[46]_t value)[47]
void lv_style_set_grid_cell_y_align(lv_style_t *style, lv_coor[48]d_t value)[49]
void lv_obj_set_style_grid_row_dsc_array(lv_obj_t *obj, const [50]lv_coord_t value[], lv_style_selector_t selector)[51]
void lv_obj_set_style_grid_column_dsc_array(lv_obj_t *obj, const lv_coord_t value[], lv_style_selecto[52]r_t selector)[53]
void lv_obj_set_style_grid_row_align(lv_obj_t *obj, lv_grid_align_t value, lv_style_selector_t selector)[54][55]
void lv_obj_set_style_grid_column_align(lv_obj_t *obj, lv_grid_align_t value, lv_style_selecto[56]r_t selector)[57]
void lv_obj_set_style_grid_cell_column_pos(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t s[58]elector)[59]
void lv_obj_set_style_grid_cell_column_span(lv_obj_t *obj, lv_coord_t value, lv_style_selector_[60]t selector)[61]
void lv_obj_set_style_grid_cell_row_pos(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t sel[62]ector)[63]
void lv_obj_set_style_grid_cell_row_span(lv_obj_t *obj, lv_coord_t value, lv_style_selector_[64]t selector)[65]
void lv_obj_set_style_grid_cell_x_align(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t [66]selector)[67]
void lv_obj_set_style_grid_cell_y_align(lv_obj_t *obj, lv_coord_t value, lv_style_selector_t[68] selector)[69]
static inline const lv_coord_t *lv_obj_get_style_grid_row_dsc_array(const lv_obj_t *obj, uin[70]t32_t part)[71]
static inline const lv_coord_t *lv_obj_get_style_grid_column_dsc_array(const lv_obj_t *obj, u[72]int32_t part)[73]
static inline lv_grid_align_t lv_obj_get_style_grid_row_align(const lv_obj_t *obj, uint32_t part[74])[75]
static inline lv_grid_align_t lv_obj_get_style_grid_column_align(const lv_obj_t *obj, u[76]int32_t part)[77]
static inline lv_coord_t lv_obj_get_style_grid_cell_column_pos(const lv_obj_t *obj, uint32[78]_t part)[79]
static inline lv_coord_t lv_obj_get_style_grid_cell_column_span(const lv_obj_t *obj, uin[80]t32_t part)[81]
static inline lv_coord_t lv_obj_get_style_grid_cell_row_pos(const lv_obj_t *obj, uint32_t[82] part)[83]
static inline lv_coord_t lv_obj_get_style_grid_cell_row_span(const lv_obj_t *obj, uin[84]t32_t part)[85]
static inline lv_coord_t lv_obj_get_style_grid_cell_x_align(const lv_obj_t *obj, uint3[86]2_t part)[87]
static inline lv_coord_t lv_obj_get_style_grid_cell_y_align(const lv_obj_t *obj, uint[88]32_t part)[89]

Variables

uint32_t LV_LAYOUT_GRID[90]
lv_style_prop[91]_t LV_STYLE_GRID_COLUMN_DS[92]C_ARRAY[93]
lv_style_prop_t LV_STYLE_GRID_COLUMN[94]_ALIGN[95]
lv_style_prop_t LV_STYLE_GRID_RO[96]W_DSC_ARRAY[97]
lv_style_prop_t LV_STYLE_GRID_ROW[98]_ALIGN[99]
lv_style_prop_t LV_STYLE_GRID[100]_CELL_COLUMN_POS[101]
lv_style_prop_t LV_STYLE_GRID_CELL_[102]COLUMN_SPAN[103]
lv_style_prop_t LV_STYLE_GRID_CELL_X[104]_ALIGN[105]
lv_style_prop_t LV_STYLE_GRID_CE[106]LL_ROW_POS[107]
lv_style_prop_t LV_STYLE_GRID_CE[108]LL_ROW_SPAN[109]
lv_style_prop_t LV_STYLE_GRID_CEL[110]L_Y_ALIGN







戻る : Previous
「https://robot-jp.com/wiki/index.php?title=App:Library:LVGL:docs:Layouts:Grid&oldid=3538」から取得