Enum egui_dock::Node

pub enum Node<Tab> {
    Empty,
    Leaf {
        rect: Rect,
        viewport: Rect,
        tabs: Vec<Tab>,
        active: TabIndex,
    },
    Vertical {
        rect: Rect,
        fraction: f32,
    },
    Horizontal {
        rect: Rect,
        fraction: f32,
    },
}

Represents an abstract node of a Tree.

Variants

Empty

Empty node

Leaf

Fields

rect: Rect

The full rectangle - tab bar plus tab body

viewport: Rect

The tab body rectangle

tabs: Vec<Tab>

All the tabs in this node.

active: TabIndex

The opened tab.

Contains the actual tabs

Vertical

Fields

rect: Rect

The rectangle in which all children of this node are drawn.

fraction: f32

The fraction taken by the top child of this node.

Parent node in the vertical orientation

Horizontal

Fields

rect: Rect

The rectangle in which all children of this node are drawn.

fraction: f32

The fraction taken by the left child of this node.

Parent node in the horizontal orientation

Implementations

impl<Tab> Node<Tab>

pub fn leaf(tab: Tab) -> Self

Constructs a leaf node with a given tab.

pub const fn leaf_with(tabs: Vec<Tab>) -> Self

Constructs a leaf node with a given list of tabs.

pub fn set_rect(&mut self, new_rect: Rect)

Sets the area occupied by the node.

pub const fn is_empty(&self) -> bool

Returns true if the node is a Empty, false otherwise.

pub const fn is_leaf(&self) -> bool

Returns true if the node is a Leaf, false otherwise.

pub const fn is_horizontal(&self) -> bool

Returns true if the node is a Horizontal, false otherwise.

pub const fn is_vertical(&self) -> bool

Returns true if the node is a Vertical, false otherwise.

pub const fn is_parent(&self) -> bool

Returns true if the node is either Horizontal or Vertical, false otherwise.

pub fn split(&mut self, split: Split, fraction: f32) -> Self

Replaces the node with a Horizontal or Vertical one (depending on split) and assigns it an empty rect.

pub fn append_tab(&mut self, tab: Tab)

Adds a tab to the node.

Panics

Panics if the new capacity of tabs exceeds isize::MAX bytes.

pub fn insert_tab(&mut self, index: TabIndex, tab: Tab)

Adds a tab to the node.

Panics

Panics if the new capacity of tabs exceeds isize::MAX bytes. index > tabs_count()

pub fn remove_tab(&mut self, tab_index: TabIndex) -> Option<Tab>

Removes a tab at given index from the node. Returns the removed tab if the node is a Leaf, or None otherwise.

Panics

Panics if index is out of bounds.

pub fn tabs_count(&self) -> usize

Gets the number of tabs in the node.

Trait Implementations

impl<Tab: Clone> Clone for Node<Tab>

fn clone(&self) -> Node<Tab>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Tab: Debug> Debug for Node<Tab>

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

Formats the value using the given formatter.