Struct tui::layout::Layout

pub struct Layout { /* fields omitted */ }

Implementations

impl Layout

pub fn constraints<C>(self, constraints: C) -> Layout where
    C: Into<Vec<Constraint>>, 

pub fn margin(self, margin: u16) -> Layout

pub fn horizontal_margin(self, horizontal: u16) -> Layout

pub fn vertical_margin(self, vertical: u16) -> Layout

pub fn direction(self, direction: Direction) -> Layout

pub fn split(&self, area: Rect) -> Vec<Rect>

Wrapper function around the cassowary-rs solver to be able to split a given area into smaller ones based on the preferred widths or heights and the direction.

Examples

let chunks = Layout::default()
    .direction(Direction::Vertical)
    .constraints([Constraint::Length(5), Constraint::Min(0)].as_ref())
    .split(Rect {
        x: 2,
        y: 2,
        width: 10,
        height: 10,
    });
assert_eq!(
    chunks,
    vec![
        Rect {
            x: 2,
            y: 2,
            width: 10,
            height: 5
        },
        Rect {
            x: 2,
            y: 7,
            width: 10,
            height: 5
        }
    ]
);

let chunks = Layout::default()
    .direction(Direction::Horizontal)
    .constraints([Constraint::Ratio(1, 3), Constraint::Ratio(2, 3)].as_ref())
    .split(Rect {
        x: 0,
        y: 0,
        width: 9,
        height: 2,
    });
assert_eq!(
    chunks,
    vec![
        Rect {
            x: 0,
            y: 0,
            width: 3,
            height: 2
        },
        Rect {
            x: 3,
            y: 0,
            width: 6,
            height: 2
        }
    ]
);

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Layout

Returns the “default value” for a type.

impl Eq for Layout

impl Hash for Layout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Layout> for Layout

fn eq(&self, other: &Layout) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Layout) -> bool

This method tests for !=.

impl StructuralEq for Layout

impl StructuralPartialEq for Layout