Enum egui::Key

source ·
pub enum Key {
Show 88 variants 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,
}
Expand description

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§

source§

impl Key

source

pub const ALL: &'static [Self] = _

All egui keys

source

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

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.

source

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

Emoji or name representing the key

source

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

Human-readable English name.

Trait Implementations§

source§

impl Clone for Key

source§

fn clone(&self) -> Key

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Key

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Key

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Key

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Key

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Key

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for Key

source§

impl Eq for Key

source§

impl StructuralEq for Key

source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,