Struct PaneTree 

pub struct PaneTree { /* private fields */ }

A tree of panes. Always contains at least one pane.

Implementations

impl PaneTree

pub fn new(root: PaneId) -> Self

pub fn root(&self) -> &Node

pub fn split( &mut self, target: PaneId, axis: SplitDirection, new_pane: PaneId, new_first: bool, ) -> Option<SplitId>

Split the leaf holding target, placing new_pane beside it. new_first puts the new pane left/top. Ratio starts at 0.5. Returns the id of the created split, or None if target is absent or new_pane is already present.

pub fn split_subtree( &mut self, target: PaneId, axis: SplitDirection, subtree: Node, new_first: bool, ) -> bool

Split the leaf holding target, placing an entire subtree beside it (used when a whole tab — possibly itself split — is dropped onto a pane). subtree’s SplitIds are renumbered into this tree so they can’t clash. false if target is absent or subtree shares a pane with this tree.

pub fn remove(&mut self, pane: PaneId) -> bool

Remove a pane, collapsing its parent split into the sibling subtree. Returns false if the pane is absent or is the last pane.

pub fn set_ratio(&mut self, split: SplitId, ratio: f32) -> bool

Set a divider’s ratio (clamped to 0.1..=0.9). false if split is absent.

pub fn ratio(&self, split: SplitId) -> Option<f32>

Current ratio of a split, if it exists.

pub fn nearest_split( &self, pane: PaneId, axis: SplitDirection, ) -> Option<SplitId>

The nearest ancestor split of pane whose divider runs along axis. Used to resize the split adjacent to the focused pane in a direction.

pub fn list_dividers(&self) -> Vec<(SplitId, SplitDirection)>

All dividers in layout order (depth first, parent before children).

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

All panes in layout order (left/top before right/bottom).

pub fn contains(&self, pane: PaneId) -> bool

Trait Implementations

impl Clone for PaneTree

fn clone(&self) -> PaneTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaneTree

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

Formats the value using the given formatter.

impl PartialEq for PaneTree

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PaneTree