Struct DockLayout 

pub struct DockLayout { /* private fields */ }

Everything gpui_base::dock exports, so a consumer never has to depend on the foundation crate directly to write a skin or read a container’s state. Kept in step with base’s own list by every_base_dock_export_is_reachable_from_here.

Two names are handled elsewhere and one is deliberately absent: base’s Panel and PanelView arrive as BasePanel and BasePanelView because this module’s Panel/PanelView are the presentation halves that extend them, and base’s Dock — a plain state struct holding one dock’s open, collapsible, size and resizing flags — is not re-exported at all, because the name meant a panel container in every released version of this crate and handing it back with a different meaning is worse than dropping it. A skin reads a dock through DockContext. Describes a layout without constructing any entity.

Building a layout used to require window and cx because every node was an entity. Now a layout is data, and DockArea reconciles it into entities when it is installed.

Misuse — a panel added to a split, a child container added to a tab group, an active index on anything but a tab group — trips a debug_assert! and is otherwise ignored, matching how the old DockItem::active_index guarded itself. A type-state builder would reject the same mistakes at compile time, but it needs four marker types and leaks into every consumer signature; the runtime assertion is proportionate for a builder whose misuse shows up on the first debug run.

Implementations

impl DockLayout

pub fn h_split() -> DockLayout

A split whose children sit side by side.

pub fn v_split() -> DockLayout

A split whose children stack.

pub fn tabs() -> DockLayout

A tab group: panels stacked one at a time, selected from a tab bar.

pub fn tiles() -> DockLayout

A tiles canvas: panels placed at free coordinates, each dragged and resized on its own.

pub fn child(self, child: DockLayout, size: Option<Pixels>) -> DockLayout

Add a child container to a split. size is the child’s slot along the split’s axis; None leaves it unconstrained.

pub fn panel<P>(self, panel: Entity<P>) -> DockLayout

where P: Panel,

Add a panel to a tab group.

pub fn panel_view(self, panel: Arc<dyn PanelView>, cx: &App) -> DockLayout

Add an already-wrapped panel handle to a tab group.

The companion to Self::panel, for a layer that hands base its own concrete handle — see PanelView::as_any — rather than a bare entity. cx is here because the id has to come from PanelView::panel_id: unlike Self::panel, there is no entity in hand to take it from.

pub fn tile<P>(self, panel: Entity<P>, bounds: Bounds<Pixels>) -> DockLayout

where P: Panel,

Place a panel on a tiles canvas.

pub fn tile_view( self, panel: Arc<dyn PanelView>, bounds: Bounds<Pixels>, cx: &App, ) -> DockLayout

Place an already-wrapped panel handle on a tiles canvas. The companion to Self::tile, for the same reason Self::panel_view is the companion to Self::panel.

pub fn active_index(self, ix: usize) -> DockLayout

Which tab is displayed. Out-of-range values are clamped by normalize once the layout is installed.