Struct Grid

pub struct Grid<'a, Message, Theme = Theme, Renderer = Renderer<Renderer, Renderer>> { /* private fields */ }

A container that distributes its contents on a responsive grid.

Implementations

impl<'a, Message, Theme, Renderer> Grid<'a, Message, Theme, Renderer>

where Renderer: Renderer,

pub fn new() -> Grid<'a, Message, Theme, Renderer>

Creates an empty Grid.

pub fn with_capacity(capacity: usize) -> Grid<'a, Message, Theme, Renderer>

Creates a Grid with the given capacity.

pub fn with_children( children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>, ) -> Grid<'a, Message, Theme, Renderer>

Creates a Grid with the given elements.

pub fn from_vec( children: Vec<Element<'a, Message, Theme, Renderer>>, ) -> Grid<'a, Message, Theme, Renderer>

Creates a Grid from an already allocated Vec.

pub fn spacing( self, amount: impl Into<Pixels>, ) -> Grid<'a, Message, Theme, Renderer>

Sets the spacing between cells in the Grid.

pub fn width( self, width: impl Into<Pixels>, ) -> Grid<'a, Message, Theme, Renderer>

Sets the width of the Grid in Pixels.

By default, a Grid will Fill its parent.

pub fn height( self, height: impl Into<Sizing>, ) -> Grid<'a, Message, Theme, Renderer>

Sets the height of the Grid.

By default, a Grid uses a cell aspect ratio of 1.0 (i.e. squares).

pub fn columns(self, column: usize) -> Grid<'a, Message, Theme, Renderer>

Sets the amount of columns in the Grid.

pub fn fluid( self, max_width: impl Into<Pixels>, ) -> Grid<'a, Message, Theme, Renderer>

Makes the amount of columns dynamic in the Grid, never exceeding the provided max_width.

pub fn push( self, child: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Grid<'a, Message, Theme, Renderer>

Adds an [Element] to the Grid.

pub fn push_maybe( self, child: Option<impl Into<Element<'a, Message, Theme, Renderer>>>, ) -> Grid<'a, Message, Theme, Renderer>

Adds an element to the Grid, if Some.

pub fn extend( self, children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>, ) -> Grid<'a, Message, Theme, Renderer>

Extends the Grid with the given children.

Trait Implementations

impl<Message, Renderer> Default for Grid<'_, Message, Renderer>

where Renderer: Renderer,

fn default() -> Grid<'_, Message, Renderer>

Returns the “default value” for a type.

impl<'a, Message, Theme, Renderer> From<Grid<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: Renderer + 'a,

fn from( row: Grid<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> FromIterator<Element<'a, Message, Theme, Renderer>> for Grid<'a, Message, Theme, Renderer>

where Renderer: Renderer,

fn from_iter<T>(iter: T) -> Grid<'a, Message, Theme, Renderer>

where T: IntoIterator<Item = Element<'a, Message, Theme, Renderer>>,

Creates a value from an iterator.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Grid<'_, Message, Theme, Renderer>

where Renderer: Renderer,

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.