Struct vizia::input::Keymap

source ·
pub struct Keymap<T>
where T: 'static + Clone + PartialEq + Send + Sync,
{ /* private fields */ }
Expand description

A keymap that associates key chords with actions.

This is useful if you have an application that lets the user configure their key chords. It allows you to check if a particular action is pressed rather than the actual keys. The relationship between a key chord and an action is a many-to-many relationship.

§Examples

First we need to create something that represents an action in our application. This is usually an enum.

#[derive(PartialEq, Copy, Clone)]
enum Action {
    One,
    Two,
    Three,
}

Now we can create a new keymap inside of our application and configure our key chords. We will bind Action::One to the key chord A, Action::Two to the key chord CTRL+B and Action::Three to the key chord CTRL+SHIFT+C. Every action has an associated callback function that gets triggered when the key chord is pressed.

let keymap = Keymap::from(vec![
    (KeyChord::new(Modifiers::empty(), Code::KeyA), KeymapEntry::new(Action::One, |_| println!("Action One"))),
    (KeyChord::new(Modifiers::CTRL, Code::KeyB), KeymapEntry::new(Action::Two, |_| println!("Action Two"))),
    (KeyChord::new(Modifiers::CTRL | Modifiers::SHIFT, Code::KeyC), KeymapEntry::new(Action::Three, |_| println!("Action Three"))),
]);

Implementations§

source§

impl<T> Keymap<T>
where T: 'static + Clone + PartialEq + Send + Sync,

source

pub fn new() -> Keymap<T>

Creates a new keymap.

§Examples
let keymap = Keymap::<Action>::new();
source

pub fn pressed_actions( &self, cx: &Context, code: Code ) -> impl Iterator<Item = &KeymapEntry<T>>

Returns an iterator over every pressed keymap entry.

§Examples
for entry in keymap.pressed_actions(cx, Code::KeyA) {
    println!("The action {:?} is being pressed!", entry.action());
};
source

pub fn export(&self) -> Vec<(&KeyChord, &KeymapEntry<T>)>

Exports all keymap entries and their associated key chords.

This is useful if you want to have a settings window and need to access every key chord and keymap entry of a keymap.

§Examples
let actions_chords = keymap.export();

for (chord, entry) in actions_chords {
    println!("The key chord {:?} triggers the action {:?}!", chord, entry.action());
}

Trait Implementations§

source§

impl<T> Default for Keymap<T>
where T: Default + 'static + Clone + PartialEq + Send + Sync,

source§

fn default() -> Keymap<T>

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

impl<T> From<Vec<(KeyChord, KeymapEntry<T>)>> for Keymap<T>
where T: 'static + Clone + PartialEq + Send + Sync,

source§

fn from(vec: Vec<(KeyChord, KeymapEntry<T>)>) -> Keymap<T>

Converts to this type from the input type.
source§

impl<T> Model for Keymap<T>
where T: 'static + Clone + PartialEq + Send + Sync,

source§

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Respond to events in order to mutate the model data. Read more
source§

fn build(self, cx: &mut Context)

Build the model data into the application tree. Read more
source§

fn name(&self) -> Option<&'static str>

Auto Trait Implementations§

§

impl<T> Freeze for Keymap<T>

§

impl<T> RefUnwindSafe for Keymap<T>
where T: RefUnwindSafe,

§

impl<T> Send for Keymap<T>

§

impl<T> Sync for Keymap<T>

§

impl<T> Unpin for Keymap<T>
where T: Unpin,

§

impl<T> UnwindSafe for Keymap<T>
where T: UnwindSafe,

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
§

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

§

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.
§

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.
§

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.
§

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.
§

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

§

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

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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