Enum SplitLayout 

pub enum SplitLayout {
    Pane(SplitPaneSpec),
    Branch {
        id: SharedString,
        axis: SplitAxis,
        ratio: f32,
        start: Box<SplitLayout>,
        end: Box<SplitLayout>,
    },
}

A tree of splits the caller owns.

Variants

Pane(SplitPaneSpec)

Branch

Fields

id: SharedString

axis: SplitAxis

ratio: f32

How much of the branch the first child takes, from 0 to 1.

start: Box<SplitLayout>

end: Box<SplitLayout>

Implementations

impl SplitLayout

pub fn pane(id: impl Into<SharedString>) -> Self

pub fn leaf(spec: SplitPaneSpec) -> Self

pub fn split( id: impl Into<SharedString>, axis: SplitAxis, ratio: f32, start: SplitLayout, end: SplitLayout, ) -> Self

pub fn horizontal( id: impl Into<SharedString>, ratio: f32, start: SplitLayout, end: SplitLayout, ) -> Self

pub fn vertical( id: impl Into<SharedString>, ratio: f32, start: SplitLayout, end: SplitLayout, ) -> Self

pub fn id(&self) -> &SharedString

pub fn is_pane(&self) -> bool

pub fn panes(&self) -> Vec<&SplitPaneSpec>

Every leaf, in the order it is drawn.

pub fn find(&self, id: &str) -> Option<&SplitLayout>

The subtree named id, wherever it sits.

pub fn min_extent(&self, axis: SplitAxis) -> f32

The smallest this subtree may be drawn at along axis, in pixels.

pub fn with_ratio(&self, split: &str, ratio: f32) -> Self

The same tree with one branch’s ratio replaced.

pub fn with_collapsed(&self, pane: &str, collapsed: bool) -> Self

The same tree with one leaf’s collapsed flag replaced.

pub fn applied(&self, change: &SplitChange) -> Self

The same tree with a reported change applied.

This is offered so a host that simply accepts every change has one call to make. A host that judges them applies the ones it accepts itself.

pub fn to_records(&self) -> Vec<SplitRecord>

The tree flattened into plain records, parents before children and the first child before the second.

pub fn from_records(records: &[SplitRecord]) -> Result<Self, SplitRecordError>

Rebuilds a tree the host wrote out with SplitLayout::to_records.

Trait Implementations

impl Clone for SplitLayout

fn clone(&self) -> SplitLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitLayout

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

Formats the value using the given formatter.

impl PartialEq for SplitLayout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SplitLayout