Skip to main content

Grid

Struct Grid 

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

A container that distributes its contents on a responsive grid.

Implementations§

Source§

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

Source

pub fn new() -> Self

Creates an empty Grid.

Source

pub fn with_capacity(capacity: usize) -> Self

Creates a Grid with the given capacity.

Source

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

Creates a Grid with the given elements.

Source

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

Creates a Grid from an already allocated Vec.

Source

pub fn spacing(self, amount: impl Into<Pixels>) -> Self

Sets the spacing between cells in the Grid.

Source

pub fn width(self, width: impl Into<Pixels>) -> Self

Sets the width of the Grid in Pixels.

By default, a Grid will Fill its parent.

Source

pub fn height(self, height: impl Into<Sizing>) -> Self

Sets the height of the Grid.

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

Source

pub fn columns(self, column: usize) -> Self

Sets the amount of columns in the Grid.

Source

pub fn fluid(self, max_width: impl Into<Pixels>) -> Self

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

Source

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

Adds an Element to the Grid.

Source

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

Adds an element to the Grid, if Some.

Source

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

Extends the Grid with the given children.

Trait Implementations§

Source§

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

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

fn from_iter<T: IntoIterator<Item = Element<'a, Message, Theme, Renderer>>>( iter: T, ) -> Self

Creates a value from an iterator. Read more
Source§

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

Source§

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

Returns the state Tree of the children of the Widget.
Source§

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

Reconciles the Widget with the provided Tree.
Source§

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

Returns the Size of the Widget in lengths.
Source§

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

Returns the layout::Node of the Widget. Read more
Source§

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

Applies an Operation to the Widget.
Source§

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

Processes a runtime Event. Read more
Source§

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

Returns the current mouse::Interaction of the Widget. Read more
Source§

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.
Source§

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

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

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

Returns a Size hint for laying out the Widget. Read more
Source§

fn tag(&self) -> Tag

Returns the Tag of the Widget.
Source§

fn state(&self) -> State

Returns the State of the Widget.

Auto Trait Implementations§

§

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

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !RefUnwindSafe for Grid<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !Send for Grid<'a, Message, Theme, Renderer>

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !Sync for Grid<'a, Message, Theme, Renderer>

§

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

§

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

§

impl<'a, Message, Theme = Theme, Renderer = Renderer> !UnwindSafe for Grid<'a, Message, Theme, Renderer>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.