Struct DeskState 

pub struct DeskState { /* private fields */ }

the windows of an area: kept by the app and passed to desk_begin / desk_next / desk_end / desk_taskbar. Plain data: save() / load() turn it into a few lines of text (desk 1, then win KEY X Y W H STATE from the bottom of the z-order to the top – x, y from the area’s start corner, outer size, all DIP; STATE the DW_* bits – and active KEY; unknown lines are skipped). The reserved strip is no part of it.

Implementations

impl DeskState

pub fn new() -> DeskState

no windows: every window goes cascaded to the front in its first frame

pub fn reset(&mut self)

forget every window: each goes to its first place in the next frame

pub fn set_reserve(&mut self, insets: [i32; 4])

the strip the area keeps free for a taskbar inside it (DIP: start, top, end, bottom): maximised and snapped windows leave it out, the title bars stay above it; not saved

pub fn reserve(&self) -> [i32; 4]

the reserved strip (set_reserve)

pub fn contains(&self, key: u32) -> bool

the state knows the window

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

the windows from the bottom of the z-order to the top (minimised ones too)

pub fn active(&self) -> u32

the active window (0: none)

pub fn state(&self, key: u32) -> u32

DW_* bits of the window (0: a normal window, or an unknown one)

pub fn rect(&self, key: u32) -> Option<[i32; 4]>

the normal place of the window: x, y from the area’s start corner, outer width and height (DIP) – what it comes back to from maximised, snapped or minimised

pub fn set_rect(&mut self, key: u32, r: [i32; 4])

set the normal place of a window (DIP; see rect); a maximised or snapped one shows it once restored

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

bring the window to the front and make it active (a minimised one comes back)

pub fn minimize(&mut self, key: u32)

minimise the window (it keeps its place in the z-order; the topmost other one becomes active)

pub fn maximize(&mut self, key: u32)

maximise the window (and activate it)

pub fn restore(&mut self, key: u32)

a minimised window comes back (as it was: maximised stays maximised); else a maximised or snapped one goes back to its normal place; it becomes active

pub fn toggle_max(&mut self, key: u32)

maximise the window, or restore a maximised (or snapped) one

pub fn snap(&mut self, key: u32, half: u32)

snap the window to the start (DW_LEFT) or end (DW_RIGHT) half of the area, 0: back to its normal place

pub fn cycle(&mut self, forward: bool) -> Option<u32>

the next window (forward: the active one goes to the back and the one below it comes to the front; back: the one at the back comes to the front) among the windows that are not minimised -> the window now active

pub fn forget(&mut self, key: u32)

forget a window (a closed one: it comes back cascaded)

pub fn save(&self) -> String

the state as text (see DeskState)

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

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

Trait Implementations

impl Clone for DeskState

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 DeskState

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

Formats the value using the given formatter.

impl Default for DeskState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DeskState

impl PartialEq for DeskState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeskState