Skip to main content

Keybindings

Struct Keybindings 

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

A registry of keyboard shortcuts mapped to actions for different widgets.

Keybindings manages the association between key combinations and their corresponding actions, scoped by widget ID. It supports:

  • Single key bindings via bind
  • Multiple keys for the same action via bind_many
  • Catch-all handlers via bind_any

§Example

ⓘ
let mut kb = Keybindings::new();
kb.bind(WidgetId("list"), 'j', "Down", |world| { /* move down */ });
kb.bind_many(WidgetId("list"), keys![KeyCode::Up, 'k'], "Up", |world| { /* move up */ });

Implementations§

Source§

impl Keybindings

Source

pub fn new() -> Self

Source

pub fn bind( &mut self, id: WidgetId, key: impl Into<KeyBinding>, name: &'static str, action: impl Fn(&mut World) + Send + Sync + 'static, )

Source

pub fn bind_many( &mut self, id: WidgetId, keys: impl Into<Keys>, name: &'static str, action: impl Fn(&mut World) + Send + Sync + Clone + 'static, )

Binds multiple keys to the same action.

Source

pub fn bind_any( &mut self, id: WidgetId, handler: impl Fn(&mut World, &KeyBinding) + Send + Sync + 'static, )

Binds a handler that fires for any key press on the given widget when no specific binding matches.

Source

pub fn handle( &self, key: &KeyBinding, world: &mut World, ids: &[WidgetId], ) -> bool

Source

pub fn unbind(&mut self, id: WidgetId)

Removes all keybindings for the given context.

Source

pub fn display_for(&self, ids: &[WidgetId]) -> Vec<DisplayInfo>

Returns keybindings grouped by name for the given widget IDs. Keys with the same name and widget ID are grouped together.

Source

pub fn display_all(&self) -> Vec<DisplayInfo>

Returns all keybindings grouped by name. Keys with the same name and widget ID are grouped together.

Trait Implementations§

Source§

impl Default for Keybindings

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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, 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.