Enum egui_dock::dock_state::surface::Surface

pub enum Surface<Tab> {
    Empty,
    Main(Tree<Tab>),
    Window(Tree<Tab>, WindowState),
}

A Surface is the highest level component in a DockState. Surfaces represent an area in which nodes are placed. Typically, you’re only using one surface, which is the main surface. However, if you drag a tab out in a way which creates a window, you also create a new surface in which nodes can appear.

Variants

Empty

An empty surface, with nothing inside (practically, a null surface).

Main(Tree<Tab>)

The main surface of a DockState, only one should exist at surface index 0 at any one time.

Window(Tree<Tab>, WindowState)

A windowed surface with a state.

Implementations

impl<Tab> Surface<Tab>

pub const fn is_empty(&self) -> bool

Is this surface Empty (in practice null)?

pub fn node_tree_mut(&mut self) -> Option<&mut Tree<Tab>>

Get mutable access to the node tree of this surface.

pub fn node_tree(&self) -> Option<&Tree<Tab>>

Get access to the node tree of this surface.

Trait Implementations

impl<Tab: Clone> Clone for Surface<Tab>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Tab: Debug> Debug for Surface<Tab>

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

Formats the value using the given formatter.