Skip to main content

KeyboardFocus

Struct KeyboardFocus 

Source
pub struct KeyboardFocus<T: Copy + Eq, S: Copy + Eq> { /* private fields */ }
Expand description

An allocation-free focus controller for one caller-selected modal scope.

The caller supplies a bounded, ordered slice of unique eligible target IDs on every operation. Disabled/hidden targets must be omitted. Changing scope or removing the current target clears focus before interpreting the command; activation never silently moves to another target. Use generation-qualified entity IDs, or clear/recreate the controller when a World is replaced.

This helper registers no systems and reads no keys. The application chooses Tab/Shift-Tab/arrow bindings and routes each accepted action exactly once. Equality is caller code. Validation costs O(n^2) comparisons, bounded by the configured target limit; navigation is O(n), storage is constant, no heap work.

Implementations§

Source§

impl<T: Copy + Eq, S: Copy + Eq> KeyboardFocus<T, S>

Source

pub const fn new(max_targets: usize) -> Self

Creates an empty controller with an explicit eligible-target cap.

Source

pub const fn focused(&self) -> Option<T>

Returns focused identity; call synchronize after changing eligibility.

Source

pub const fn scope(&self) -> Option<S>

Returns the last explicitly supplied modal scope.

Source

pub fn clear(&mut self)

Clears focus without changing the caller’s active scope.

Source

pub fn synchronize( &mut self, scope: S, eligible: &[T], ) -> Result<(), FocusError>

Reconciles scope and eligibility without choosing or activating a new target.

Source

pub fn set_focused( &mut self, scope: S, eligible: &[T], target: Option<T>, ) -> Result<(), FocusError>

Sets an eligible focus explicitly, for example after pointer selection. Invalid target/order/limits preserve both old scope and old focus.

Source

pub fn process( &mut self, scope: S, eligible: &[T], command: FocusCommand, ) -> Result<FocusOutcome<T>, FocusError>

Applies one caller-approved command after reconciling the active modal scope. Empty orders clear focus. Failed validation performs no mutation.

Trait Implementations§

Source§

impl<T: Debug + Copy + Eq, S: Debug + Copy + Eq> Debug for KeyboardFocus<T, S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T, S> Freeze for KeyboardFocus<T, S>
where Option<T>: Freeze, Option<S>: Freeze,

§

impl<T, S> RefUnwindSafe for KeyboardFocus<T, S>

§

impl<T, S> Send for KeyboardFocus<T, S>
where Option<T>: Send, Option<S>: Send,

§

impl<T, S> Sync for KeyboardFocus<T, S>
where Option<T>: Sync, Option<S>: Sync,

§

impl<T, S> Unpin for KeyboardFocus<T, S>
where Option<T>: Unpin, Option<S>: Unpin,

§

impl<T, S> UnsafeUnpin for KeyboardFocus<T, S>

§

impl<T, S> UnwindSafe for KeyboardFocus<T, S>

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> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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