Struct DockTree 

pub struct DockTree { /* private fields */ }

A tree of splits and tab groups covering one workbench area.

Implementations

impl DockTree

pub fn empty() -> DockTree

A dock with nothing in it.

pub fn single(panel: impl Into<String>) -> DockTree

A dock holding a single panel.

pub fn is_empty(&self) -> bool

Whether the dock holds no panels at all.

pub fn panels(&self) -> Vec<String>

Every panel id in the tree, in traversal order.

pub fn contains(&self, panel: &str) -> bool

Whether panel is somewhere in the tree.

pub fn insert( &mut self, panel: impl Into<String>, target: Option<&str>, zone: DropZone, ) -> Option<SplitId>

Adds panel to the tree relative to target.

Center joins target’s tab group; the edge zones split it. A panel already in the tree is moved rather than duplicated, which is what makes this the single entry point for a drag-and-drop rearrange.

With no target — or a target that isn’t in the tree — the panel splits the root, or becomes the root if the dock is empty.

Returns the SplitId of the divider this created, so a caller building a default layout can set its ratio without having to guess at allocation order. None when the panel joined a tab group instead.

pub fn remove(&mut self, panel: &str) -> bool

Removes panel. An emptied tab group collapses, and its parent split is replaced by the surviving sibling so no blank area is left behind.

Returns whether the panel was there.

pub fn activate(&mut self, panel: &str) -> bool

Makes panel the visible tab of its group. No-op if it isn’t in the tree.

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

Sets a split’s ratio, clamped to 0.05..=0.95 so a divider dragged to the edge leaves the pane recoverable.

pub fn layout(&self, area: [f32; 4]) -> DockLayout

Places every group and divider inside area.

Trait Implementations

impl Clone for DockTree

fn clone(&self) -> DockTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockTree

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

Formats the value using the given formatter.

impl Default for DockTree

fn default() -> DockTree

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DockTree

fn deserialize<__D>( __deserializer: __D, ) -> Result<DockTree, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DockTree

fn eq(&self, other: &DockTree) -> 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 Serialize for DockTree

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DockTree