Struct VerticalLayout 

pub struct VerticalLayout { /* private fields */ }

A Layout node that arranges it’s children vertically.

This layout’s main axis is the y-axis, and it’s cross axis is the x-axis.

Example

use cascada::{solve_layout, AxisAlignment, EmptyLayout, IntrinsicSize, Padding, Size, VerticalLayout};

let child = EmptyLayout::new()
    .intrinsic_size(IntrinsicSize::fixed(12.0,50.0));


let mut layout = VerticalLayout::new()
    .spacing(12)
    .padding(Padding::all(24.0))
    .add_children([child.clone(),child])
    .main_axis_alignment(AxisAlignment::Center);

solve_layout(&mut layout, Size::unit(500.0));

Algorithm

• BoxSizing::Shrink: The minimum width is set to the sum of the minimum widths of all the children + spacing + horizontal padding.
• BoxSizing::Fixed: The minimum width is set to the fixed width regardless of all other properties.

If the intrinsic height is BoxSizing::Shrink then the final height will be the sum of the all child node heights + vertical padding + spacing.

Implementations

impl VerticalLayout

pub fn new() -> Self

Creates a new VerticalLayout.

pub fn set_id(self, id: GlobalId) -> Self

pub fn with_label(self, label: &str) -> Self

pub fn add_child(self, child: impl Layout + 'static) -> Self

Appends a Layout node to the list of children.

Example

use cascada::{EmptyLayout,VerticalLayout};

VerticalLayout::new()
    .add_child(EmptyLayout::default())
    .add_child(VerticalLayout::default());

pub fn add_children<I>(self, children: I) -> Self

where I: IntoIterator<Item: Layout + 'static>,

Add multiple child nodes to the list of children.

Example

use cascada::{VerticalLayout,EmptyLayout};

VerticalLayout::new()
    .add_children([
        EmptyLayout::new(),
        EmptyLayout::new(),
        EmptyLayout::new(),
    ]);

pub fn add_boxed_children<I>(self, children: I) -> Self

where I: IntoIterator<Item = Box<dyn Layout + 'static>>,

pub fn main_axis_alignment(self, main_axis_alignment: AxisAlignment) -> Self

Set the main axis alignment

pub fn cross_axis_alignment(self, cross_axis_alignment: AxisAlignment) -> Self

Set the cross axis alignment.

pub fn padding(self, padding: Padding) -> Self

Set this layout’s Padding.

pub fn spacing(self, spacing: u32) -> Self

Set this layout’s spacing.

pub fn main_axis_overflow(&self) -> bool

Returns true if a VerticalLayout’s children are overflowing its main-axis (y-axis).

pub fn cross_axis_overflow(&self) -> bool

Returns true if a VerticalLayout’s children are overflowing its cross-axis (x-axis).

pub fn max_width(self, width: f32) -> Self

Sets the maximum width of the layout node.

pub fn maximum_height(self, height: f32) -> Self

Sets the maximum height of the layout node.

pub fn min_width(self, width: f32) -> Self

Sets the minimum width of the layout node.

pub fn min_height(self, height: f32) -> Self

Sets the minimum height of the layout node.

pub fn intrinsic_size(self, intrinsic_size: IntrinsicSize) -> Self

Sets the intrinsic size of the layout node.

Trait Implementations

impl Debug for VerticalLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VerticalLayout

fn default() -> VerticalLayout

Returns the “default value” for a type.

impl<I> From<I> for VerticalLayout

where I: IntoIterator<Item: Layout + 'static>,

fn from(iter: I) -> Self

Converts to this type from the input type.

impl Layout for VerticalLayout

fn label(&self) -> String

fn id(&self) -> GlobalId

Get the id of the Layout

fn position(&self) -> Position

Returns the Position of the Layout

fn set_position(&mut self, position: Position)

fn set_x(&mut self, x: f32)

fn set_y(&mut self, y: f32)

fn size(&self) -> Size

Returns the Size of the Layout

fn children(&self) -> &[Box<dyn Layout>]

fn constraints(&self) -> BoxConstraints

Returns the BoxConstraints of the Layout.

fn get_intrinsic_size(&self) -> IntrinsicSize

Returns the IntrinsicSize of the Layout

fn set_max_height(&mut self, height: f32)

fn set_max_width(&mut self, width: f32)

fn set_min_height(&mut self, height: f32)

fn set_min_width(&mut self, width: f32)

fn collect_errors(&mut self) -> Vec<LayoutError>

Collect all the errors from the node tree.

fn iter(&self) -> LayoutIter<'_>

Returns an iterator over the layout tree.

fn solve_min_constraints(&mut self) -> (f32, f32)

Solve the minimum constraints of each Layout node recursively

fn solve_max_constraints(&mut self)

Solve the max constraints for the children and pass them down the tree

fn update_size(&mut self)

Update the size of every LayoutNode based on it’s size and constraints.

fn position_children(&mut self)

Position the layout nodes after size calculations.

fn bounds(&self) -> Bounds

Returns the Bounds of the Layout

fn get(&self, id: GlobalId) -> Option<&dyn Layout>

Searches for a Layout node with a matching GlobalId.

fn as_layout_node(&self) -> LayoutNode