Skip to main content

PaneCommand

Enum PaneCommand 

Source
pub enum PaneCommand {
    FocusNext,
    FocusPrevious,
    FocusDirectional(PaneCardinalDirection),
    FocusEdge(PaneCardinalDirection),
    ResizeStep {
        direction: PaneResizeDirection,
        units: u16,
    },
    Split(SplitAxis),
    Close,
    MovePane(PaneCardinalDirection),
    SwapPane(PaneFocusOrdinal),
    Maximize,
    Restore,
}
Expand description

The canonical, host-agnostic pane keyboard command vocabulary.

Hosts translate raw key events into these commands; resolve maps each to a deterministic outcome. Resize unit counts are supplied by the caller (computed via PaneCommandAcceleration) so the command itself stays a pure intent.

Variants§

§

FocusNext

Move focus to the next leaf in deterministic focus order (cyclic).

§

FocusPrevious

Move focus to the previous leaf in deterministic focus order (cyclic).

§

FocusDirectional(PaneCardinalDirection)

Move focus to the nearest leaf in a direction (spatial).

§

FocusEdge(PaneCardinalDirection)

Move focus to the extreme leaf in a direction (jump to edge).

§

ResizeStep

Grow (Increase) or shrink (Decrease) the active pane by units snap steps, resizing its enclosing split.

Fields

§direction: PaneResizeDirection

Increase grows the active pane; Decrease shrinks it.

§units: u16

Number of snap steps (one step = PANE_SNAP_DEFAULT_STEP_BPS).

§

Split(SplitAxis)

Split the active leaf along axis, adding a new sibling leaf.

§

Close

Close the active leaf, promoting its sibling.

§

MovePane(PaneCardinalDirection)

Move the active pane to dock against the nearest pane in a direction.

§

SwapPane(PaneFocusOrdinal)

Swap the active pane with its cyclic neighbour.

§

Maximize

Maximize the active pane (transient view state; no topology change).

§

Restore

Restore from a maximized state (transient view state).

Trait Implementations§

Source§

impl Clone for PaneCommand

Source§

fn clone(&self) -> PaneCommand

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 PaneCommand

Source§

impl Debug for PaneCommand

Source§

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

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

impl Eq for PaneCommand

Source§

impl PartialEq for PaneCommand

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PaneCommand

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.