Struct KeyBinding 

pub struct KeyBinding { /* private fields */ }

Implementations

impl KeyBinding

pub fn for_action(action: &dyn Action, cx: &App) -> Self

Returns the highest precedence keybinding for an action. This is the last binding added to the keymap. User bindings are added after built-in bindings so that they take precedence.

pub fn for_action_in(action: &dyn Action, focus: &FocusHandle, cx: &App) -> Self

Like for_action, but lets you specify the context from which keybindings are matched.

pub fn has_binding(&self, window: &Window) -> bool

pub fn set_vim_mode(cx: &mut App, enabled: bool)

pub fn new( action: &dyn Action, focus_handle: Option<FocusHandle>, cx: &App, ) -> Self

pub fn from_keystrokes( keystrokes: Rc<[KeybindingKeystroke]>, vim_mode: bool, ) -> Self

pub fn platform_style(self, platform_style: PlatformStyle) -> Self

Sets the PlatformStyle for this KeyBinding.

pub fn size(self, size: impl Into<AbsoluteLength>) -> Self

Sets the size for this KeyBinding.

pub fn disabled(self, disabled: bool) -> Self

Sets whether this keybinding is currently disabled. Disabled keybinds will be rendered in a dimmed state.

Trait Implementations

impl Clone for KeyBinding

fn clone(&self) -> KeyBinding

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for KeyBinding

fn scope() -> ComponentScope

Returns the scope of the component.

fn name() -> &'static str

The name of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

impl Debug for KeyBinding

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

Formats the value using the given formatter.

impl IntoElement for KeyBinding

type Element = Component<KeyBinding>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for KeyBinding

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.