pub struct Keymap { /* private fields */ }Expand description
A collection of key bindings for the user’s application.
Implementations§
Source§impl Keymap
impl Keymap
Sourcepub fn new(bindings: Vec<KeyBinding>) -> Self
pub fn new(bindings: Vec<KeyBinding>) -> Self
Create a new keymap with the given bindings.
Sourcepub fn version(&self) -> KeymapVersion
pub fn version(&self) -> KeymapVersion
Get the current version of the keymap.
Sourcepub fn add_bindings<T: IntoIterator<Item = KeyBinding>>(&mut self, bindings: T)
pub fn add_bindings<T: IntoIterator<Item = KeyBinding>>(&mut self, bindings: T)
Add more bindings to the keymap.
Sourcepub fn bindings(
&self,
) -> impl DoubleEndedIterator<Item = &KeyBinding> + ExactSizeIterator
pub fn bindings( &self, ) -> impl DoubleEndedIterator<Item = &KeyBinding> + ExactSizeIterator
Iterate over all bindings, in the order they were added.
Sourcepub fn bindings_for_action<'a>(
&'a self,
action: &'a dyn Action,
) -> impl 'a + DoubleEndedIterator<Item = &'a KeyBinding>
pub fn bindings_for_action<'a>( &'a self, action: &'a dyn Action, ) -> impl 'a + DoubleEndedIterator<Item = &'a KeyBinding>
Iterate over all bindings for the given action, in the order they were added. For display, the last binding should take precedence.
Sourcepub fn all_bindings_for_input(&self, input: &[Keystroke]) -> Vec<KeyBinding>
pub fn all_bindings_for_input(&self, input: &[Keystroke]) -> Vec<KeyBinding>
Returns all bindings that might match the input without checking context. The bindings returned in precedence order (reverse of the order they were added to the keymap).
Sourcepub fn bindings_for_input(
&self,
input: &[impl AsKeystroke],
context_stack: &[KeyContext],
) -> (SmallVec<[KeyBinding; 1]>, bool)
pub fn bindings_for_input( &self, input: &[impl AsKeystroke], context_stack: &[KeyContext], ) -> (SmallVec<[KeyBinding; 1]>, bool)
Returns a list of bindings that match the given input, and a boolean indicating whether or not more bindings might match if the input was longer. Bindings are returned in precedence order (higher precedence first, reverse of the order they were added to the keymap).
Precedence is defined by the depth in the tree (matches on the Editor take precedence over matches on the Pane, then the Workspace, etc.). Bindings with no context are treated as the same as the deepest context.
In the case of multiple bindings at the same depth, the ones added to the keymap later take precedence. User bindings are added after built-in bindings so that they take precedence.
If a user has disabled a binding with "x": null it will not be returned. Disabled bindings
are evaluated with the same precedence rules so you can disable a rule in a given context
only.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Keymap
impl !RefUnwindSafe for Keymap
impl !Send for Keymap
impl !Sync for Keymap
impl Unpin for Keymap
impl !UnwindSafe for Keymap
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
Source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian().