Skip to main content

DockState

Struct DockState 

Source
pub struct DockState { /* private fields */ }
Expand description

Host-owned visibility and focus lifecycle for one dockable panel.

This is intentionally not a panel manager: it does not own views, focus identifiers, key bindings, or application state. A host can pair it with a FocusRegistry and any panel content.

Implementations§

Source§

impl DockState

Source

pub const fn new() -> Self

A hidden, unfocused panel.

Source

pub const fn is_visible(self) -> bool

Whether the panel is logically open. A passive panel may still resolve to DockPlacement::Hidden below its breakpoint.

Source

pub const fn is_focused(self) -> bool

Whether the panel should own input focus.

Source

pub fn show_passive(&mut self)

Open the panel without taking focus from the main content.

Source

pub fn focus(&mut self)

Open and focus the panel.

Source

pub fn blur(&mut self)

Keep the panel open but return focus to the main content.

Source

pub fn hide(&mut self)

Close the panel and release its focus.

Source

pub fn toggle(&mut self)

Focus a hidden or passive panel; close a focused panel.

This supports the common single-shortcut lifecycle: background work can open passively, the first shortcut focuses it, and the next closes it.

Source

pub fn resolve(self, area: Rect, spec: DockSpec) -> DockLayout

Resolve the panel for area under spec.

Wide visible panels dock regardless of focus. Below the breakpoint, a passive panel stays logically open but is not painted; focusing it turns it into an overlay drawer, so input can never be captured by an invisible panel.

Trait Implementations§

Source§

impl Clone for DockState

Source§

fn clone(&self) -> DockState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DockState

Source§

impl Debug for DockState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DockState

Source§

fn default() -> DockState

Returns the “default value” for a type. Read more
Source§

impl Eq for DockState

Source§

impl PartialEq for DockState

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DockState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.