Struct Stack

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

A container that displays children on top of each other.

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

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<'a, Message, Theme, Renderer> Stack<'a, Message, Theme, Renderer>

where Renderer: Renderer,

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

Creates an empty Stack.

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

Creates a Stack with the given capacity.

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

Creates a Stack with the given elements.

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

Creates a Stack from an already allocated Vec.

Keep in mind that the Stack will not inspect the Vec, which means it won’t automatically adapt to the sizing strategy of its contents.

If any of the children have a Length::Fill strategy, you will need to call Stack::width or Stack::height accordingly.

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

Sets the width of the Stack.

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

Sets the height of the Stack.

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

Adds an element to the Stack.

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

Adds an element to the Stack, if Some.

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

Extends the Stack with the given children.

Trait Implementations

impl<'a, Message, Renderer> Default for Stack<'a, Message, Renderer>

where Renderer: Renderer,

fn default() -> Stack<'a, Message, Renderer>

Returns the “default value” for a type.

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

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

fn from( stack: Stack<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Stack<'a, Message, Theme, Renderer>

where Renderer: Renderer,

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

Returns the state Tree of the children of the Widget.

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

Reconciliates 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 on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> Status

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.

fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, _id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.