Struct DockArea 

pub struct DockArea { /* private fields */ }

The main area of the dock.

Implementations

impl DockArea

pub fn new( id: impl Into<SharedString>, version: Option<usize>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn bounds(&self) -> Bounds<Pixels>

Return the bounds of the dock area.

pub fn items(&self) -> &DockItem

Return the items of the dock area.

pub fn panel_style(self, style: PanelStyle) -> Self

Set the panel style of the dock area.

pub fn set_version( &mut self, version: usize, _: &mut Window, cx: &mut Context<'_, Self>, )

Set version of the dock area.

pub fn set_root( &mut self, item: DockItem, window: &mut Window, cx: &mut Context<'_, Self>, )

👎Deprecated: Use set_center instead

pub fn set_center( &mut self, item: DockItem, window: &mut Window, cx: &mut Context<'_, Self>, )

The the DockItem as the center of the dock area.

This is used to render at the Center of the DockArea.

pub fn set_left_dock( &mut self, panel: DockItem, size: Option<Pixels>, open: bool, window: &mut Window, cx: &mut Context<'_, Self>, )

pub fn set_bottom_dock( &mut self, panel: DockItem, size: Option<Pixels>, open: bool, window: &mut Window, cx: &mut Context<'_, Self>, )

pub fn set_right_dock( &mut self, panel: DockItem, size: Option<Pixels>, open: bool, window: &mut Window, cx: &mut Context<'_, Self>, )

pub fn set_locked(&mut self, locked: bool, _window: &mut Window, _cx: &mut App)

Set locked state of the dock area, if locked, the dock area cannot be split or move, but allows to resize panels.

pub fn is_locked(&self) -> bool

Determine if the dock area is locked.

pub fn has_dock(&self, placement: DockPlacement) -> bool

Determine if the dock area has a dock at the given placement.

pub fn is_dock_open(&self, placement: DockPlacement, cx: &App) -> bool

Determine if the dock at the given placement is open.

pub fn set_dock_collapsible( &mut self, collapsible_edges: Edges<bool>, window: &mut Window, cx: &mut Context<'_, Self>, )

Set the dock at the given placement to be open or closed.

Only the left, bottom, right dock can be toggled.

pub fn is_dock_collapsible(&self, placement: DockPlacement, cx: &App) -> bool

Determine if the dock at the given placement is collapsible.

pub fn toggle_dock( &self, placement: DockPlacement, window: &mut Window, cx: &mut Context<'_, Self>, )

Toggle the dock at the given placement.

pub fn set_toggle_button_visible( &mut self, visible: bool, _: &mut Context<'_, Self>, )

Set the visibility of the toggle button.

pub fn add_panel( &mut self, panel: Arc<dyn PanelView>, placement: DockPlacement, bounds: Option<Bounds<Pixels>>, window: &mut Window, cx: &mut Context<'_, Self>, )

Add a panel item to the dock area at the given placement.

pub fn remove_panel( &mut self, panel: Arc<dyn PanelView>, placement: DockPlacement, window: &mut Window, cx: &mut Context<'_, Self>, )

Remove panel from the DockArea at the given placement.

pub fn remove_panel_from_all_docks( &mut self, panel: Arc<dyn PanelView>, window: &mut Window, cx: &mut Context<'_, Self>, )

Remove a panel from all docks.

pub fn load( &mut self, state: DockAreaState, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Result<()>

Load the state of the DockArea from the DockAreaState.

See also [DockeArea::dump].

pub fn dump(&self, cx: &App) -> DockAreaState

Dump the dock panels layout to PanelState.

See also DockArea::load.

pub fn id(&self) -> SharedString

Returns the ID of the dock area.

pub fn set_zoomed_in<P: Panel>( &mut self, panel: Entity<P>, _: &mut Window, cx: &mut Context<'_, Self>, )

pub fn set_zoomed_out(&mut self, _: &mut Window, cx: &mut Context<'_, Self>)

pub fn update_toggle_button_tab_panels( &mut self, _: &mut Window, cx: &mut Context<'_, Self>, )

Trait Implementations

impl Render for DockArea

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl EventEmitter<DockEvent> for DockArea