Struct Stack

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

W Stack layout.

Without direction this is a Z layering stack, with direction the traditional vertical and horizontal stack panels can be created, other custom layouts are also supported, diagonal stacks, partially layered stacks and more. See StackDirection for more details.

Z-Index

By default the widgets are rendered in their logical order, the last widget renders in front of the others, you can change this by setting the z_index property in the item widget.

Shorthand

The Stack! macro provides shorthand syntax:

• Stack!($children:expr) creates a Z stack.
• Stack!($direction:ident, $children:expr) create stack on the given direction. The first parameter is the name of one of the LayoutDirection associated functions.
• Stack!($direction:ident, $spacing:expr, $children:expr) create stack with the given direction, spacing between items and the items.
• Stack!($direction:expr, $children:expr) create stack on the given direction. The first parameter is an expression of type LayoutDirection. Note that to avoid conflict with the alternative ($direction:ident) you can use braces {my_direction}.
• Stack!($direction:expr, $spacing:expr, $children:expr) create stack with the given direction expression, spacing between items and the items.

stack_nodes

If you only want to create an overlaying effect composed of multiple nodes you can use the stack_nodes function.

Implementations

impl Stack

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Stack

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

c Stack items.

impl Stack

pub fn direction(&self, direction: impl IntoVar<StackDirection>)

c Stack direction.

impl Stack

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

c Space in-between items.

The spacing is added along non-zero axis for each item offset after the first, the spacing is scaled by the direction factor.

impl Stack

pub fn children_align(&self, align: impl IntoVar<Align>)

c Items alignment.

The items are aligned along axis that don’t change, as defined by the direction.

The default is FILL.

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 Stack

type Target = WidgetBase

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Stack

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

Mutably dereferences the value.