Skip to main content

VStack

Struct VStack 

Source
pub struct VStack { /* private fields */ }
Expand description

A vertical arrangement of UI nodes with configurable spacing.

Nodes can be reordered and added/removed at any time.

Nodes always appear at their minimum size vertically, regardless of alignment. Horizontal alignment still applies.

Implementations§

Source§

impl VStack

Source

pub fn new() -> Self

Source

pub fn with_child(self, index: NodeIndex) -> Self

Add a new child to the stack.

Source

pub fn with_align(self, align: (Alignment, Alignment)) -> Self

Set the horizontal and vertical alignment.

A vertical alignment of Full will not function as expected, and will have the same appearance as Begin.

Source

pub fn with_spacing(self, spacing: f32) -> Self

Set the spacing between children. Defaults to 0.

No spacing appears before the first child or after the last child.

Source

pub fn set_spacing(&mut self, spacing: f32)

Set the spacing between children.

See with_spacing for details.

Source

pub fn add_child(&mut self, index: NodeIndex)

Add a child to the stack. The child will appear at the end.

Source

pub fn len(&self) -> usize

Returns the number of children in the stack.

Source

pub fn is_empty(&self) -> bool

Returns true if the stack is empty.

Equivalent to len() == 0.

Source

pub fn remove_child(&mut self, index: usize, tree: &mut UiTree) -> bool

Remove a child from the stack.

Returns true if the child was removed.

Source

pub fn set_child_position(&mut self, index: usize, position: usize) -> bool

Move a child to a new index.

Returns true if the child was moved.

Source

pub fn get_child_index(&self, index: usize) -> Option<NodeIndex>

Returns the tree index associated with a child at a given stack index.

Trait Implementations§

Source§

impl Default for VStack

Source§

fn default() -> Self

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

impl UiNode for VStack

Source§

fn get_align(&self) -> (Alignment, Alignment)

Get the alignment of the node.
Source§

fn get_align_mut(&mut self) -> (&mut Alignment, &mut Alignment)

Get a mutable reference to the alignment of the node.
Source§

fn calculate_min_size(&self, tree: &UiTree) -> (f32, f32)

Calculate the minimum size of the node. Read more
Source§

fn calculate_rects(&self, cache: &NodeCache, tree: &UiTree) -> Vec<Rect>

Recalculate the position and size of child nodes, in the same order and count as get_visible_children. Read more
Source§

fn get_children(&self) -> Vec<NodeIndex>

Get all children of the node, if applicable.
Source§

fn get_visible_children(&self) -> Vec<NodeIndex>

Get all visible children of the node, if applicable. Read more

Auto Trait Implementations§

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.