Tutorial Callback Custom Key Binds

Custom keymaps allow you to bind keyboard keys to a widget with a callback. Keep in mind that for this to work, a widget must already be selected; only then will it receive the keyboard event. If you want a keybind to work in all cases, regardless of selection, use Global key bind instead.

To bind a key, we will use the CallbackConfig again, and use its 'bind_key' method. The parameters are:

• The KeyCode we want to bind;
• Modifiers, which can be None, or a Vec of KeyModifiers (CTRL/SHIFT/ALT),
• The callback.

We can call this method as many times as we like to bind different keys.

Let's bind a couple of different keys to a callback closure to demonstrate simple keys and modified keys:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();

let my_callback = move |context: Context, keycode: KeyCode| {

    true
};

let mut new_callback_config = CallbackConfig::default();

// Bind a simple character
new_callback_config.bind_key(KeyCode::Char('a'), None, Box::new(my_callback));

// Bind a functional key like the Tab key
new_callback_config.bind_key(KeyCode::Tab, None, Box::new(my_callback));

// Bind a modified character
new_callback_config.bind_key(KeyCode::Char('a'), Some(vec!(KeyModifiers::CONTROL)),
                             Box::new(my_callback));

// Bind a double modifier
new_callback_config.bind_key(KeyCode::Char('a'),
                             Some(vec!(KeyModifiers::CONTROL, KeyModifiers::ALT)),
                             Box::new(my_callback));

scheduler.update_callback_config("my_checkbox", new_callback_config);

To do the same with a function:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();

fn my_callback(context: Context, keycode: KeyCode) -> bool {

    true
};

let mut new_callback_config = CallbackConfig::default();
new_callback_config.bind_key(KeyCode::Char('a'), None, Box::new(my_callback));
scheduler.update_callback_config("my_checkbox", new_callback_config);

Continue

The general tutorial continues with: Callback: Global key binds.