Struct ActionBindingCollection 

pub struct ActionBindingCollection { /* private fields */ }

A set of actions and the keystrokes that trigger each one, to be bound together in one key context.

Use it when one action has several keystrokes, or when a group of bindings shares a context. Build it with with, then turn it into KeyBindings with as_keybindings and pass them to App::bind_keys.

Examples

use gpui::{ActionBindingCollection, actions};

actions!(collection_docs, [Submit]);

let bindings = ActionBindingCollection::default()
    .with::<Submit>("enter")
    .with::<Submit>("ctrl-enter");

// One binding per keystroke, all in the `Form` context.
let bindings: Vec<_> = bindings.as_keybindings(Some("Form")).collect();
assert_eq!(bindings.len(), 2);

Implementations

impl ActionBindingCollection

pub fn with<A: Action + Default>( self, keystrokes: impl Into<SharedString>, ) -> Self

Adds keystrokes as a trigger for the action type A, and returns the collection.

The action is built with A::default() once per type, so A must be a type you can construct with Default, such as an action declared with actions!. Keystrokes aren’t parsed here. They are parsed by as_keybindings, which panics on an invalid one.

pub fn as_keybindings( &self, context: Option<&str>, ) -> impl Iterator<Item = KeyBinding>

Returns one KeyBinding for each action and keystroke in the collection, all in context.

Pass None for context to make the bindings apply everywhere. Elements that declare a matching key_context receive the actions. The order of the bindings is unspecified, because the collection is a hash map keyed by action type. Bindings for different actions on the same keystrokes therefore have no defined precedence.

Panics

Panics if a keystroke fails to parse, or if context is not a valid key context predicate.

Trait Implementations

impl Default for ActionBindingCollection

fn default() -> Self

Returns the “default value” for a type.