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(&self) -> Option<&Tree<Tab>>

Get access to the node tree of this surface.

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

Get mutable access to the node tree of this surface.

pub fn iter_nodes(&self) -> impl Iterator<Item = &Node<Tab>>

Returns an Iterator of nodes in this surface’s tree.

If the surface is Empty, then the returned Iterator will be empty.

pub fn iter_nodes_mut(&mut self) -> impl Iterator<Item = &mut Node<Tab>>

Returns a mutable Iterator of nodes in this surface’s tree.

If the surface is Empty, then the returned Iterator will be empty.

pub fn iter_all_tabs(&self) -> impl Iterator<Item = (NodeIndex, &Tab)>

Returns an Iterator of all tabs in this surface’s tree, and indices of containing nodes.

pub fn iter_all_tabs_mut( &mut self ) -> impl Iterator<Item = (NodeIndex, &mut Tab)>

Returns a mutable Iterator of all tabs in this surface’s tree, and indices of containing nodes.

pub fn filter_map_tabs<F, NewTab>(&self, function: F) -> Surface<NewTab>

where F: Clone + FnMut(&Tab) -> Option<NewTab>,

Returns a new Surface while mapping and filtering the tab type. Any remaining empty Nodes and are removed, and if this Surface remains empty, it’ll change to Surface::Empty.

pub fn map_tabs<F, NewTab>(&self, function: F) -> Surface<NewTab>

where F: Clone + FnMut(&Tab) -> NewTab,

Returns a new Surface while mapping the tab type.

pub fn filter_tabs<F>(&self, predicate: F) -> Surface<Tab>

where F: Clone + FnMut(&Tab) -> bool, Tab: Clone,

Returns a new Surface while filtering the tab type. Any remaining empty Nodes and are removed, and if this Surface remains empty, it’ll change to Surface::Empty.

pub fn retain_tabs<F>(&mut self, predicate: F)

where F: Clone + FnMut(&mut Tab) -> bool,

Removes all tabs for which predicate returns false. Any remaining empty Nodes and are also removed, and if this Surface remains empty, it’ll change to Surface::Empty.

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.