Struct egui_dock::widgets::dock_area::DockArea

pub struct DockArea<'tree, Tab> { /* private fields */ }

Displays a DockState in egui.

Implementations

impl<'tree, Tab> DockArea<'tree, Tab>

pub fn show(self, ctx: &Context, tab_viewer: &mut impl TabViewer<Tab = Tab>)

Show the DockArea at the top level.

This is the same as doing:

CentralPanel::default()
    .frame(Frame::central_panel(&ctx.style()).inner_margin(0.))
    .show(ctx, |ui| {
        DockArea::new(&mut tree).show_inside(ui, &mut tab_viewer);
    });

So you can’t use the CentralPanel::show when using DockArea’s one.

See also show_inside.

pub fn show_inside( self, ui: &mut Ui, tab_viewer: &mut impl TabViewer<Tab = Tab> )

Shows the docking hierarchy inside a Ui.

See also show.

impl<'tree, Tab> DockArea<'tree, Tab>

pub fn new(tree: &'tree mut DockState<Tab>) -> DockArea<'tree, Tab>

Creates a new DockArea from the provided DockState.

pub fn id(self, id: Id) -> Self

Sets the DockArea ID. Useful if you have more than one DockArea.

pub fn style(self, style: Style) -> Self

Sets the look and feel of the DockArea.

pub fn show_add_popup(self, show_add_popup: bool) -> Self

Shows or hides the add button popup. By default it’s false.

pub fn show_add_buttons(self, show_add_buttons: bool) -> Self

Shows or hides the tab add buttons. By default it’s false.

pub fn show_close_buttons(self, show_close_buttons: bool) -> Self

Shows or hides the tab close buttons. By default it’s true.

pub fn tab_context_menus(self, tab_context_menus: bool) -> Self

Whether tabs show a context menu when right-clicked. By default it’s true.

pub fn draggable_tabs(self, draggable_tabs: bool) -> Self

Whether tabs can be dragged between nodes and reordered on the tab bar. By default it’s true.

pub fn show_tab_name_on_hover(self, show_tab_name_on_hover: bool) -> Self

Whether tabs show their name when hovered over them. By default it’s false.

pub fn allowed_splits(self, allowed_splits: AllowedSplits) -> Self

What directions can a node be split in: left-right, top-bottom, all, or none. By default it’s all.

pub fn window_bounds(self, bounds: Rect) -> Self

The bounds for any windows inside the DockArea. Defaults to the screen rect. By default it’s set to egui::Context::screen_rect.

pub fn show_window_close_buttons(self, show_window_close_buttons: bool) -> Self

Enables or disables the close button on windows. By default it’s true.

pub fn show_window_collapse_buttons( self, show_window_collapse_buttons: bool ) -> Self

Enables or disables the collapsing header on windows. By default it’s true.

Trait Implementations

impl<'tree, Tab> Debug for DockArea<'tree, Tab>

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

Formats the value using the given formatter.