Struct Layout 

pub struct Layout { /* private fields */ }

An immutable, validated layout ready for resolution.

Implementations

impl Layout

pub fn tree(&self) -> &LayoutTree

Borrow the underlying tree for read-only traversal.

pub fn window_size(&self) -> usize

How many panels the active window shows at once.

pub fn resolve( &self, width: f32, height: f32, ) -> Result<ResolvedLayout, PaneError>

Compile, compute, and resolve the layout at the given viewport size.

pub fn build_row( f: impl FnOnce(&mut ContainerCtx<'_>), ) -> Result<Self, PaneError>

Build a row layout from a closure.

pub fn build_col( f: impl FnOnce(&mut ContainerCtx<'_>), ) -> Result<Self, PaneError>

Build a column layout from a closure.

pub fn build_row_gap( gap: f32, f: impl FnOnce(&mut ContainerCtx<'_>), ) -> Result<Self, PaneError>

Build a row layout with gap from a closure.

pub fn build_col_gap( gap: f32, f: impl FnOnce(&mut ContainerCtx<'_>), ) -> Result<Self, PaneError>

Build a column layout with gap from a closure.

pub fn row( kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Result<Self, PaneError>

Equal-grow panels in a row, zero gap.

pub fn col( kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Result<Self, PaneError>

Equal-grow panels in a column, zero gap.

pub fn row_with( panels: impl IntoIterator<Item = (impl Into<Arc<str>>, Constraints)>, ) -> Result<Self, PaneError>

Panels in a row with explicit constraints per panel.

pub fn col_with( panels: impl IntoIterator<Item = (impl Into<Arc<str>>, Constraints)>, ) -> Result<Self, PaneError>

Panels in a column with explicit constraints per panel.

pub fn presets() -> &'static [PresetInfo]

Return metadata for all built-in presets, sorted alphabetically by name.

pub fn master_stack( kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> MasterStack

Create a MasterStack builder.

pub fn centered_master( kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> CenteredMaster

Create a CenteredMaster builder.

pub fn monocle(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Monocle

Create a Monocle builder.

pub fn scrollable( kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Scrollable

Create a Scrollable builder.

pub fn dwindle(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Dwindle

Create a Dwindle builder.

pub fn spiral(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Spiral

Create a Spiral builder.

pub fn columns( count: usize, kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Columns

Create a Columns builder.

pub fn deck(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Deck

Create a Deck builder.

pub fn tabbed(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Tabbed

Create a Tabbed builder.

pub fn stacked(kinds: impl IntoIterator<Item = impl Into<Arc<str>>>) -> Stacked

Create a Stacked builder.

pub fn sidebar( sidebar_kind: impl Into<Arc<str>>, content_kind: impl Into<Arc<str>>, ) -> Sidebar

Create a Sidebar builder.

pub fn holy_grail( header: impl Into<Arc<str>>, footer: impl Into<Arc<str>>, left: impl Into<Arc<str>>, main: impl Into<Arc<str>>, right: impl Into<Arc<str>>, ) -> HolyGrail

Create a HolyGrail builder.

pub fn dashboard( cards: impl IntoIterator<Item = (impl Into<Arc<str>>, usize)>, ) -> Dashboard

Create a Dashboard builder.

pub fn split(first: impl Into<Arc<str>>, second: impl Into<Arc<str>>) -> Split

Create a Split builder.

pub fn grid( cols: usize, kinds: impl IntoIterator<Item = impl Into<Arc<str>>>, ) -> Grid

Create a Grid builder.

impl Layout

pub fn compile(&self) -> Result<CompileResult, PaneError>

Compile the layout tree into a Taffy tree ready for layout computation.

Trait Implementations

impl Debug for Layout

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

Formats the value using the given formatter.

impl From<Layout> for LayoutRuntime

fn from(layout: Layout) -> Self

Converts to this type from the input type.

impl From<Layout> for LayoutTree

fn from(layout: Layout) -> Self

Converts to this type from the input type.

impl TryFrom<CenteredMaster> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: CenteredMaster) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Columns> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Columns) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Dashboard> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Dashboard) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Deck> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Deck) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Dwindle> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Dwindle) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Grid> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Grid) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HolyGrail> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: HolyGrail) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<MasterStack> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: MasterStack) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Monocle> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Monocle) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Scrollable> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Scrollable) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Sidebar> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Sidebar) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Spiral> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Spiral) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Split> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Split) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Stacked> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Stacked) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Tabbed> for Layout

type Error = PaneError

The type returned in the event of a conversion error.

fn try_from(preset: Tabbed) -> Result<Self, Self::Error>

Performs the conversion.