Struct DockWidget 

pub struct DockWidget { /* private fields */ }

App-facing declaration of a dock widget: identity, chrome metadata, and a lazy content factory. Collect these on DockingLayout::dock.

Implementations

impl DockWidget

pub fn new<W: Widget + 'static>( id: DockWidgetId, title: impl Into<LocalizedString>, factory: impl Fn(DockWidgetId) -> W + 'static, ) -> Self

Declare a dock widget. factory builds its content the first time the dock appears (and after it is closed and re-opened).

pub fn icon(self, f: impl Fn() -> IconWidget + 'static) -> Self

Set the dock’s tab / rail icon.

pub fn header_actions( self, f: impl Fn(DockWidgetId) -> Vec<ToolbarItem> + 'static, ) -> Self

Attach a factory for the dock’s inline header actions — a flat list of ToolbarActions shown before the ⋮ options button, the VS Code “view actions” pattern (“New File”, “Collapse All”, …). Built on demand each time the dock is placed into a header. The framework hosts them in a Toolbar, so the actions gain overflow (when the header is tight, the lowest-priority actions collapse into a ⌄ menu) and the correct axis for free — a horizontal row on leading / trailing sides, a vertical column on the rotated top / bottom strip. The actions appear in any header the dock has: the multi-pane Accordion header always, and the sole-pane (bare) header when show_header(true) is set.

Each item is a ToolbarItem — a collapsible ToolbarAction via ToolbarItem::action, or a pinned arbitrary widget (a SplitButton, a search field, …) via ToolbarItem::custom.

DockWidget::new(id, lit!("Explorer"), build).header_actions(|_| vec![
    ToolbarItem::action(ToolbarAction::new(lit!("New File"), new_icon).on_activate(..)),
    ToolbarItem::custom(CreateSplitButton::new(..)),
])

pub fn show_header(self, show: bool) -> Self

Give a sole-pane (bare) dock its own header bar (title + actions + ⋮ options). Default false. The multi-pane Accordion header is always present regardless; this only governs the bare case. Turn it on to get a discoverable options button (and inline header_actions) on a dock that is the only one on its side.

pub fn default_location(self, loc: DockOpenLocation) -> Self

The location used when the dock is opened via toggle / reveal without an explicit target.