Struct Keymap 

pub struct Keymap { /* private fields */ }

Input policy for one editor, holding a pending word between keys, see the crate docs for the contract.

Implementations

impl Keymap

pub fn new() -> Self

A keymap with the built in catalog, suffix matching, and autocorrect.

pub fn reset(&mut self)

Forget the pending word and last character, call it whenever the caret moves outside the keymap.

pub fn set_suffix_matching(&mut self, on: bool)

Whether space converts the longest known suffix of the pending word, on by default.

pub fn set_autocorrect(&mut self, on: bool)

Whether two character sequences such as <= become symbols, on by default.

pub fn define_word( &mut self, word: &str, label: &str, commands: Vec<Command>, ) -> Result<(), InvalidWord>

Register or replace a word shortcut, which lists after the ones defined before it.

pub fn undefine_word(&mut self, word: &str)

Remove a word shortcut defined by the host, built in words stay.

pub fn entries(&self) -> Vec<KeymapEntry<'_>>

Every word, host words in definition order and then the catalog in its fixed order.

pub fn commands_for_word(&self, word: &str) -> Option<Vec<Command>>

The commands a word inserts, for a host rendered palette.

pub fn map_key(&mut self, input: &KeyInput, ctx: &InputContext) -> Vec<Command>

Translate a key event, the host runs every returned command once and in order.

pub fn map_text(&mut self, text: &str, ctx: &InputContext) -> Vec<Command>

Translate committed text as if each character were typed, newlines and tabs are not typed in math.

Trait Implementations

impl Clone for Keymap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keymap

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

Formats the value using the given formatter.

impl Default for Keymap

fn default() -> Self

Returns the “default value” for a type.