Struct Stack 

pub struct Stack<W> { /* private fields */ }

A container that displays children on top of each other.

The first Widget dictates the intrinsic Size of a Stack and will be displayed as the base layer. Every consecutive Widget will be rendered on top; on its own layer.

You can use push_under to push a Widget under the current Stack without affecting its intrinsic Size.

Keep in mind that too much layering will normally produce bad UX as well as introduce certain rendering overhead. Use this widget sparingly!

Implementations

impl<W> Stack<W>

pub fn new() -> Stack<W>

Creates an empty Stack.

pub fn with_capacity(capacity: usize) -> Stack<W>

Creates a Stack with the given capacity.

pub fn with_children(children: impl IntoIterator<Item = W>) -> Stack<W>

where W: Meta,

Creates a Stack with the given widgets.

pub fn from_vec(children: Vec<W>) -> Stack<W>

Creates a Stack from an already allocated Vec.

pub fn width(self, width: impl Into<Length>) -> Stack<W>

Sets the width of the Stack.

pub fn height(self, height: impl Into<Length>) -> Stack<W>

Sets the height of the Stack.

pub fn push(self, child: impl Into<W>) -> Stack<W>

where W: Meta,

Adds a widget on top of the Stack.

pub fn push_under(self, child: impl Into<W>) -> Stack<W>

Adds a widget under the Stack.

pub fn extend(self, children: impl IntoIterator<Item = W>) -> Stack<W>

where W: Meta,

Extends the Stack with the given children.

pub fn clip(self, clip: bool) -> Stack<W>

Sets whether the Stack should clip overflowing content.

It has a slight performance overhead during presentation.

By default, it is set to false.

Trait Implementations

impl<W> Default for Stack<W>

fn default() -> Stack<W>

Returns the “default value” for a type.

impl<W> Meta for Stack<W>

fn is_void(&self) -> bool

Returns whether the Widget is Void.

impl<W, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Stack<W>

where W: Widget<Message, Theme, Renderer>, Renderer: Renderer,

fn diff(&mut 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(&mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits)

Lays out the Widget.

fn operate( &mut self, tree: &mut Tree, layout: Layout, viewport: &Rectangle, 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, 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, viewport: &Rectangle, translation: Vector, window: Size, ) -> Vec<Element<'b, Message, Theme, Renderer>>

Returns the overlays of the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn _map<F, B>(self, f: F) -> Map<Self, F, Message>

where Self: Sized, F: Fn(Message) -> B,

Applies a transformation to the produced message of this Widget, returning a Map.

fn _boxed<'a>(self) -> Element<'a, Message, Theme, Renderer>

where Self: Sized + 'a,

Boxes this Widget, turning it into a generic Element.