Struct Grid

pub struct Grid(/* private fields */);

W Grid layout with cells of variable sizes.

Implementations

impl Grid

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Grid

pub fn cells(&self, cells: impl UiNodeList)

c Cell widget items.

Cells can select their own column, row, column-span and row-span using the properties in the Cell! widget. Note that you don’t need to use the cell widget, only the cell properties.

If the column or row index is set to usize::MAX the widget is positioned using the logical index i, the column i % columns and the row i / columns.

impl Grid

pub fn columns(&self, cells: impl UiNodeList)

c Column definitions.

You can define columns with any widget, but the Column! widget is recommended. The column widget width defines the width of the cells assigned to it, the Column::width property can be used to enforce a width, otherwise the column is sized by the widest cell.

The grid uses the WIDGET_SIZE value to select one of three layout modes for columns:

• Default, used for columns that do not set width or set it to Length::Default.
• Exact, used for columns that set the width to an unit that is exact or only depends on the grid context.
• Leftover, used for columns that set width to a lft value.

The column layout follows these steps:

1 - All Exact column widgets are layout, their final width defines the column width. 2 - All cell widgets with span 1 in Default columns are measured, the widest defines the fill width constrain, the columns are layout using this constrain, the final width defines the column width. 3 - All Leftover cells are layout with the leftover grid width divided among all columns in this mode.

So given the columns 200 | 1.lft() | 1.lft() and grid width of 1000 with spacing 5 the final widths are 200 | 395 | 395, for 200 + 5 + 395 + 5 + 395 = 1000.

Note that the column widget is not the parent of the cells that match it, the column widget is rendered under cell and row widgets. Properties like padding and align only affect the column visual, not the cells, similarly contextual properties like text_color don’t affect the cells.

impl Grid

pub fn rows(&self, cells: impl UiNodeList)

c Row definitions.

Same behavior as columns, but in the y dimension.

impl Grid

pub fn auto_grow_fn(&self, auto_grow: impl IntoVar<WidgetFn<AutoGrowFnArgs>>)

c Widget function used when new rows or columns are needed to cover a cell placement.

The function is used according to the auto_grow_mode. Note that imaginary rows or columns are used if the function is WidgetFn::nil.

impl Grid

pub fn auto_grow_mode(&self, mode: impl IntoVar<AutoGrowMode>)

c Defines the direction the grid auto-grows and the maximum inclusive index that can be covered by auto-generated columns or rows. If a cell is outside this index and is not covered by predefined columns or rows a new one is auto generated for it, but if the cell is also outside this max it is collapsed.

Is `AutoGrowMode::rows() by default.

impl Grid

pub fn spacing(&self, spacing: impl IntoVar<GridSpacing>)

c Space in-between cells.

Methods from Deref<Target = WidgetBase>

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> impl UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Box<dyn VarBoxed<bool>>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

pub fn id(&self, id: impl IntoValue<WidgetId>)

c Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl Deref for Grid

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Grid

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.