Struct DockSkin 

pub struct DockSkin { /* private fields */ }

The gpui-component appearance for a DockArea, and the handle its settings are changed through.

Install it at construction, where the area’s own weak handle is available:

let skin = DockSkin::new(cx);
DockArea::new("main", None, window, cx).with_renderer(skin)

Keep the returned handle to change a setting later; it is an Rc, so a clone and the installed renderer are the same skin.

Implementations

impl DockSkin

pub fn dock_area( id: impl Into<SharedString>, version: Option<usize>, window: &mut Window, cx: &mut App, ) -> (Entity<DockArea>, Rc<Self>)

Build a DockArea wearing this appearance, together with the handle its settings are changed through.

The skin needs the area’s own weak handle, so it can only be built while the area is being constructed; this is that dance done once.

pub fn new(cx: &mut Context<'_, DockArea>) -> Rc<Self>

pub fn panel_style(&self) -> PanelStyle

Whether a single-panel tab group draws a plain title or a full tab bar.

pub fn set_panel_style(&self, style: PanelStyle, cx: &mut App)

pub fn is_toggle_button_visible(&self) -> bool

Whether tab bars offer the affordance that collapses a neighbouring dock.

pub fn set_toggle_button_visible(&self, visible: bool, cx: &mut App)

pub fn tiles_scrollbar_mode(&self) -> Option<ScrollbarMode>

When a tiles canvas shows its scrollbar. None follows the theme.

pub fn set_tiles_scrollbar_mode( &self, mode: Option<ScrollbarMode>, cx: &mut App, )

Trait Implementations

impl DockAreaRenderer for DockSkin

fn build_placeholder( &self, state: &PanelState, _: &mut Window, cx: &mut App, ) -> Option<Arc<dyn PanelView>>

The “unknown panel” message the old InvalidPanel drew.

It answers dump with the state it was handed, so a layout written by a build that knows the panel survives a load and save here.

fn frame(&self, _: &mut Window, _: &mut App) -> Stateful<Div>

The area’s outer frame, which base records its bounds on. Appearance only. The area is laid out as a row around whatever this returns, because that is what makes a dock a column beside the centre rather than a block above it, and a renderer cannot be expected to know it had a row to declare.

fn center_frame(&self, _: &mut Window, _: &mut App) -> Stateful<Div>

The column holding the center region and the bottom dock. Appearance only; see DockAreaRenderer::frame. The centre fills what the side docks leave and stacks with the bottom dock either way.

fn split_frame( &self, node: NodeId, _: Axis, _: &mut Window, cx: &mut App, ) -> Stateful<Div>

One split container’s frame, around base’s resizable group.

fn render_dock( &self, dock: &DockContext, content: AnyElement, window: &mut Window, cx: &mut App, ) -> AnyElement

One dock’s chrome around its content: the title strip, the collapse affordance, and the resize handle.

fn tab_group_renderer(&self) -> Rc<dyn TabGroupRenderer>

fn tiles_renderer(&self) -> Rc<dyn TilesRenderer>

fn render_split_handle( &self, handle: &ResizeHandleContext, window: &mut Window, cx: &mut App, ) -> Option<AnyElement>

The painted part of the divider between two slots of a split.