Enum Key

pub enum Key {
    ArrowDown,
    ArrowLeft,
    ArrowRight,
    ArrowUp,
    Escape,
    Tab,
    Backspace,
    Enter,
    Space,
    Insert,
    Delete,
    Home,
    End,
    PageUp,
    PageDown,
    Copy,
    Cut,
    Paste,
    Colon,
    Comma,
    Backslash,
    Slash,
    Pipe,
    Questionmark,
    OpenBracket,
    CloseBracket,
    Backtick,
    Minus,
    Period,
    Plus,
    Equals,
    Semicolon,
    Num0,
    Num1,
    Num2,
    Num3,
    Num4,
    Num5,
    Num6,
    Num7,
    Num8,
    Num9,
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
    I,
    J,
    K,
    L,
    M,
    N,
    O,
    P,
    Q,
    R,
    S,
    T,
    U,
    V,
    W,
    X,
    Y,
    Z,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
}

Re-export eframe types for consistency Keyboard keys.

egui usually uses logical keys, i.e. after applying any user keymap.

Variants

ArrowDown

ArrowLeft

ArrowRight

ArrowUp

Escape

Tab

Backspace

Enter

Space

Insert

Delete

Home

End

PageUp

PageDown

Copy

Cut

Paste

Colon

:

Comma

,

Backslash

‘\’

Slash

‘/’

Pipe

‘|’, a vertical bar

Questionmark

?

OpenBracket

CloseBracket

Backtick

‘`’, also known as “backquote” or “grave”

Minus

-

Period

.

Plus

+

Equals

=

Semicolon

;

Num0

Either from the main row or from the numpad.

Num1

Either from the main row or from the numpad.

Num2

Either from the main row or from the numpad.

Num3

Either from the main row or from the numpad.

Num4

Either from the main row or from the numpad.

Num5

Either from the main row or from the numpad.

Num6

Either from the main row or from the numpad.

Num7

Either from the main row or from the numpad.

Num8

Either from the main row or from the numpad.

Num9

Either from the main row or from the numpad.

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

Implementations

impl Key

pub const ALL: &'static [Key]

All egui keys

pub fn from_name(key: &str) -> Option<Key>

Converts "A" to Key::A, Space to Key::Space, etc.

Makes sense for logical keys.

This will parse the output of both Self::name and Self::symbol_or_name, but will also parse single characters, so that both "-" and "Minus" will return Key::Minus.

This should support both the names generated in a web browser, and by winit. Please test on both with eframe.

pub fn symbol_or_name(self) -> &'static str

Emoji or name representing the key

pub fn name(self) -> &'static str

Human-readable English name.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Hash for Key

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Key

fn eq(&self, other: &Key) -> 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 PartialOrd for Key

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key