Struct Keybind

pub struct Keybind<'a, B: Bind> { /* private fields */ }

A keybind (hotkey) widget for egui.

Implementations

impl<'a, B: Bind> Keybind<'a, B>

pub fn new(bind: &'a mut B, id: impl Into<Id>) -> Self

Create a new Keybind for a given Bind.

Arguments

• bind - The bind to use for the Keybind.
• id - ID for the Keybind in egui’s memory.

pub fn with_text(self, text: &'a str) -> Self

Set the text of the Keybind. This will be displayed next to the keybind widget (and used for accessibility).

You can remove the text by setting it to an empty string. By default there is no text.

pub fn with_bind(self, bind: &'a mut B) -> Self

Set the bind of the Keybind.

By default this is the bind that was passed to new.

pub fn with_id(self, id: impl Into<Id>) -> Self

Set the ID of the Keybind in egui’s memory.

By default this is the ID that was passed in new.

pub fn with_reset_key(self, key: Option<Key>) -> Self

Set the key that resets the Keybind. If None, the Keybind will never reset to its’ previous value.

By default this is None.

pub fn with_reset(self, prev_bind: B) -> Self

Set the bind that the Keybind will reset to after the reset key gets pressed.

By default this is the same as the bind passed to new.

pub fn with_modifier_names(self, modifier_names: &'a ModifierNames<'a>) -> Self

Set the modifier names to use for the Keybind. By default this is ModifierNames::NAMES.

Trait Implementations

impl<B: Bind> Widget for Keybind<'_, B>

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.