Skip to main content

PaneKeyboardController

Struct PaneKeyboardController 

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

A reusable terminal pane keyboard host: translates keys to commands, resolves them against a live tree, applies structural operations, and tracks focus + maximize state. Hosts own the PaneTree; this owns the focus state and a monotonic operation counter.

Implementations§

Source§

impl PaneKeyboardController

Source

pub fn new(active: Option<PaneId>) -> Self

Create a controller focused on active (or unfocused if None).

Source

pub fn take_announcement(&mut self) -> Option<PaneAnnouncement>

Take the pending accessibility announcement (for a status line / screen reader), coalesced and de-duplicated. Call once per render.

Source

pub fn pending_announcement(&self) -> Option<&PaneAnnouncement>

Peek the pending accessibility announcement without consuming it.

Source

pub const fn with_acceleration( self, acceleration: PaneCommandAcceleration, ) -> Self

Override the resize acceleration policy.

Source

pub const fn with_preferences( self, preferences: PaneAccessibilityPreferences, ) -> Self

Set the accessibility preferences (reduced-motion / high-contrast / large-target) at construction time (bd-21pbi.5).

Source

pub const fn set_preferences( &mut self, preferences: PaneAccessibilityPreferences, )

Update the accessibility preferences at runtime (e.g. when the user toggles a mode). Never affects focus/command semantics — only the presentation helpers below.

Source

pub const fn preferences(&self) -> PaneAccessibilityPreferences

The active accessibility preferences.

Source

pub fn affordance_motion(&self) -> PaneAffordanceMotion

The affordance micro-animation policy implied by the current preferences (motion is stepped under reduced-motion).

Source

pub fn focus_ring(&self, theme: &ResolvedTheme) -> PaneFocusRing

Build a focus ring for the active pane from theme, honoring the high-contrast preference. The ring color is contrast-clamped against the pane surface (AAA when high-contrast is on, AA otherwise).

Source

pub const fn focus(&self) -> PaneFocusContext

The current focus context (active + maximized pane).

Source

pub const fn active(&self) -> Option<PaneId>

The currently active (focused) pane.

Source

pub const fn maximized(&self) -> Option<PaneId>

The currently maximized pane, if any.

Source

pub const fn set_active(&mut self, active: Option<PaneId>)

Set the active pane (e.g. when a pointer click changes focus).

Source

pub fn handle_key( &mut self, key: &KeyEvent, tree: &mut PaneTree, layout: &PaneLayout, ) -> PaneKeyOutcome

Translate, resolve, and apply one key event. Structural commands mutate tree; focus/maximize commands update internal state. The layout must be the solved layout of tree (used for spatial focus + move).

Trait Implementations§

Source§

impl Clone for PaneKeyboardController

Source§

fn clone(&self) -> PaneKeyboardController

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 Debug for PaneKeyboardController

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more