Enum DockItem 

pub enum DockItem {
    Split {
        axis: Axis,
        size: Option<Pixels>,
        items: Vec<DockItem>,
        sizes: Vec<Option<Pixels>>,
        view: Entity<StackPanel>,
    },
    Tabs {
        size: Option<Pixels>,
        items: Vec<Arc<dyn PanelView>>,
        active_ix: usize,
        view: Entity<TabPanel>,
    },
    Panel {
        size: Option<Pixels>,
        view: Arc<dyn PanelView>,
    },
    Tiles {
        size: Option<Pixels>,
        items: Vec<TileItem>,
        view: Entity<Tiles>,
    },
}

DockItem is a tree structure that represents the layout of the dock.

Variants

Split

Split layout

Fields

axis: Axis

size: Option<Pixels>

Self size, only used for build split panels

items: Vec<DockItem>

sizes: Vec<Option<Pixels>>

Items sizes

view: Entity<StackPanel>

Tabs

Tab layout

Fields

size: Option<Pixels>

Self size, only used for build split panels

items: Vec<Arc<dyn PanelView>>

active_ix: usize

view: Entity<TabPanel>

Panel

Panel layout

Fields

size: Option<Pixels>

Self size, only used for build split panels

view: Arc<dyn PanelView>

Tiles

Tiles layout

Fields

size: Option<Pixels>

Self size, only used for build split panels

items: Vec<TileItem>

view: Entity<Tiles>

Implementations

impl DockItem

pub fn size(self, new_size: impl Into<Pixels>) -> Self

Set size for the DockItem.

pub fn active_index(self, new_active_ix: usize) -> Self

Set active index for the DockItem, only valid for DockItem::Tabs.

pub fn split( axis: Axis, items: Vec<DockItem>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem::Split with given split layout.

pub fn v_split( items: Vec<DockItem>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem with vertical split layout.

pub fn h_split( items: Vec<DockItem>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem with horizontal split layout.

pub fn split_with_sizes( axis: Axis, items: Vec<DockItem>, sizes: Vec<Option<Pixels>>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem with split layout, each item of panel have specified size.

Please note that the items and sizes must have the same length. Set None in sizes to make the index of panel have auto size.

pub fn panel(panel: Arc<dyn PanelView>) -> Self

Create DockItem with panel layout

pub fn tiles( items: Vec<DockItem>, metas: Vec<impl Into<TileMeta> + Copy>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem with tiles layout

This items and metas should have the same length.

pub fn tabs( items: Vec<Arc<dyn PanelView>>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

Create DockItem with tabs layout, items are displayed as tabs.

The active_ix is the index of the active tab, if None the first tab is active.

pub fn tab<P: Panel>( item: Entity<P>, dock_area: &WeakEntity<DockArea>, window: &mut Window, cx: &mut App, ) -> Self

pub fn view(&self) -> Arc<dyn PanelView>

Returns the views of the dock item.

pub fn find_panel( &self, panel: Arc<dyn PanelView>, ) -> Option<Arc<dyn PanelView>>

Find existing panel in the dock item.

pub fn add_panel( &mut self, panel: Arc<dyn PanelView>, dock_area: &WeakEntity<DockArea>, bounds: Option<Bounds<Pixels>>, window: &mut Window, cx: &mut App, )

Add a panel to the dock item.

pub fn remove_panel( &self, panel: Arc<dyn PanelView>, window: &mut Window, cx: &mut App, )

Remove a panel from the dock item.

pub fn set_collapsed(&self, collapsed: bool, window: &mut Window, cx: &mut App)

Trait Implementations

impl Clone for DockItem

fn clone(&self) -> DockItem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DockItem

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

Formats the value using the given formatter.