Struct Shortcut

pub struct Shortcut { /* private fields */ }

A keybind that can be set with either the keyboard or a mouse.

Implementations

impl Shortcut

pub const NONE: Self

No keybind.

pub fn new( keyboard: Option<KeyboardShortcut>, pointer: Option<PointerButton>, ) -> Self

Create a new Shortcut.

Arguments

• keyboard - The keyboard shortcut to set (KeyboardShortcut), or None.
• pointer - The pointer button to set (PointerButton), or None.

pub fn keyboard(&self) -> Option<KeyboardShortcut>

Keyboard shortcut, if any. This can be set along with the mouse shortcut.

pub const fn pointer(&self) -> Option<PointerButton>

Mouse button, if any. This can be set along with the keyboard shortcut.

Trait Implementations

impl Bind for Shortcut

fn set( &mut self, keyboard: Option<KeyboardShortcut>, pointer: Option<PointerButton>, )

Set the keybind with a given KeyboardShortcut and/or PointerButton.

fn format(&self, names: &ModifierNames<'_>, is_mac: bool) -> String

Format the current keybind as a String.

fn pressed(&self, input: &mut InputState) -> bool

Check if the keybind is pressed.

impl Clone for Shortcut

fn clone(&self) -> Shortcut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shortcut

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

Formats the value using the given formatter.

impl Default for Shortcut

fn default() -> Shortcut

Returns the “default value” for a type.

impl From<Shortcut> for Option<KeyboardShortcut>

fn from(value: Shortcut) -> Self

Converts to this type from the input type.

impl From<Shortcut> for Option<PointerButton>

fn from(value: Shortcut) -> Self

Converts to this type from the input type.

impl PartialEq for Shortcut

fn eq(&self, other: &Shortcut) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Shortcut

impl StructuralPartialEq for Shortcut