Struct DockState 

pub struct DockState { /* private fields */ }

the layout of a dock area: kept by the app and passed to dock_begin / dock_next / dock_end. save() / load() turn it into a few lines of text: dock 1, then side S SIZE COLLAPSED, group S TAG SIZE ACTIVE PANEL..., float SLOT X Y W H HOME HOMETAG ACTIVE PANEL..., hidden PANEL S TAG POS X Y W H HOME HOMETAG (unknown lines are skipped).

Implementations

impl DockState

pub fn new() -> DockState

the empty layout: every panel goes to its DockPanel place in the first frame

pub fn reset(&mut self)

forget the layout: every panel goes to its DockPanel place in the next frame

pub fn show(&mut self, id: u32)

show a hidden panel where it was, as the shown tab of its group

pub fn hide(&mut self, id: u32)

hide a panel (show brings it back to the same place)

pub fn toggle(&mut self, id: u32)

show a hidden panel, hide a visible one

pub fn focus(&mut self, id: u32)

show the panel as the shown tab (a collapsed side expands) and give its tab strip the keyboard focus in the next pass (a floating window comes to the front)

pub fn activate(&mut self, id: u32)

make the panel the shown tab of its group (a collapsed side expands)

pub fn float(&mut self, id: u32, rect: Option<[i32; 4]>) -> bool

float the panel in a tool window: rect = x, y (DIP from the main window’s client origin), client width, height; None: cascaded from the top left -> false when every floating window of the area is in use

pub fn dock_to(&mut self, id: u32, side: u8)

dock the panel to a side, as a new group at its end

pub fn collapse(&mut self, side: u8, on: bool)

collapse a side to a rail of icon buttons, or expand it

pub fn collapsed(&self, side: u8) -> bool

the side is collapsed

pub fn size(&self, side: u8) -> i32

the width (left / right) or the height (bottom) of a side in DIP

pub fn set_size(&mut self, side: u8, dip: i32)

set the width / height of a side (DIP)

pub fn groups(&self, side: u8) -> Vec<Vec<u32>>

the tab groups of a side from start to end, each with its panels in tab order

pub fn floats(&self) -> Vec<Vec<u32>>

the panels of every floating window

pub fn hidden_panels(&self) -> Vec<u32>

the hidden panels

pub fn side(&self, id: u32) -> Option<u8>

where the panel is: DOCK_LEFT / DOCK_RIGHT / DOCK_BOTTOM / DOCK_FLOAT (None: hidden or unknown)

pub fn visible(&self, id: u32) -> bool

docked or floating (not hidden)

pub fn front(&self, id: u32) -> bool

the shown tab of its group (also on a collapsed side)

pub fn shown(&self, id: u32) -> bool

its content is on the screen: the front tab, on a side that is not collapsed (or floating)

pub fn save(&self) -> String

the layout as text (see DockState)

pub fn load(text: &str) -> Option<DockState>

a layout saved with save -> None when the text is no dock layout (version 1)

Trait Implementations

impl Clone for DockState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockState

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

Formats the value using the given formatter.

impl Default for DockState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DockState

impl PartialEq for DockState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DockState