Struct KeybindingRecorder 

pub struct KeybindingRecorder { /* private fields */ }

A field that records one keystroke.

Whether recording is in flight is transient view state, so this is a view rather than a builder. The binding itself is not: the recorder reports the keystroke that was pressed and renders whatever the caller says is bound, so a host that refuses a binding keeps showing the one that still holds.

Implementations

impl KeybindingRecorder

pub fn new( ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn label(self, label: impl Into<SharedString>) -> Self

What the binding is for, for a reader that has only the tree.

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

pub fn binding(self, binding: impl Into<SharedString>) -> Self

The binding the caller says is current, in GPUI’s syntax.

pub fn set_binding( &mut self, binding: Option<SharedString>, cx: &mut Context<'_, Self>, )

pub fn conflict(self, reason: Option<impl Into<SharedString>>) -> Self

The conflict the host found, in its own words.

The recorder has no keymap and never decides that two bindings clash.

pub fn set_conflict( &mut self, reason: Option<SharedString>, cx: &mut Context<'_, Self>, )

pub fn allow_escape(self, allow: bool) -> Self

Lets escape be captured as a binding rather than ending recording.

A caller that turns this on owes the typist another way out, because the usual one is now a keystroke the recorder eats.

pub fn is_recording(&self) -> bool

pub fn current_binding(&self) -> Option<&SharedString>

pub fn start(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Begins recording and takes the keyboard.

pub fn cancel(&mut self, cx: &mut Context<'_, Self>)

Ends recording without capturing anything.

Trait Implementations

impl Debug for KeybindingRecorder

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

Formats the value using the given formatter.

impl Disableable for KeybindingRecorder

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

Refuses the recorder. A refused recorder installs no handler at all.

impl EventEmitter<KeybindingRecorderEvent> for KeybindingRecorder

impl Focusable for KeybindingRecorder

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for KeybindingRecorder

fn render( &mut self, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl Sizable for KeybindingRecorder

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self