Enum winit::keyboard::KeyCode

source ·
#[non_exhaustive]
pub enum KeyCode {
Show 194 variants Backquote, Backslash, BracketLeft, BracketRight, Comma, Digit0, Digit1, Digit2, Digit3, Digit4, Digit5, Digit6, Digit7, Digit8, Digit9, Equal, IntlBackslash, IntlRo, IntlYen, KeyA, KeyB, KeyC, KeyD, KeyE, KeyF, KeyG, KeyH, KeyI, KeyJ, KeyK, KeyL, KeyM, KeyN, KeyO, KeyP, KeyQ, KeyR, KeyS, KeyT, KeyU, KeyV, KeyW, KeyX, KeyY, KeyZ, Minus, Period, Quote, Semicolon, Slash, AltLeft, AltRight, Backspace, CapsLock, ContextMenu, ControlLeft, ControlRight, Enter, SuperLeft, SuperRight, ShiftLeft, ShiftRight, Space, Tab, Convert, KanaMode, Lang1, Lang2, Lang3, Lang4, Lang5, NonConvert, Delete, End, Help, Home, Insert, PageDown, PageUp, ArrowDown, ArrowLeft, ArrowRight, ArrowUp, NumLock, Numpad0, Numpad1, Numpad2, Numpad3, Numpad4, Numpad5, Numpad6, Numpad7, Numpad8, Numpad9, NumpadAdd, NumpadBackspace, NumpadClear, NumpadClearEntry, NumpadComma, NumpadDecimal, NumpadDivide, NumpadEnter, NumpadEqual, NumpadHash, NumpadMemoryAdd, NumpadMemoryClear, NumpadMemoryRecall, NumpadMemoryStore, NumpadMemorySubtract, NumpadMultiply, NumpadParenLeft, NumpadParenRight, NumpadStar, NumpadSubtract, Escape, Fn, FnLock, PrintScreen, ScrollLock, Pause, BrowserBack, BrowserFavorites, BrowserForward, BrowserHome, BrowserRefresh, BrowserSearch, BrowserStop, Eject, LaunchApp1, LaunchApp2, LaunchMail, MediaPlayPause, MediaSelect, MediaStop, MediaTrackNext, MediaTrackPrevious, Power, Sleep, AudioVolumeDown, AudioVolumeMute, AudioVolumeUp, WakeUp, Meta, Hyper, Turbo, Abort, Resume, Suspend, Again, Copy, Cut, Find, Open, Paste, Props, Select, Undo, Hiragana, Katakana, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24, F25, F26, F27, F28, F29, F30, F31, F32, F33, F34, F35,
}
Expand description

Code representing the location of a physical key

This mostly conforms to the UI Events Specification’s KeyboardEvent.code with a few exceptions:

  • The keys that the specification calls “MetaLeft” and “MetaRight” are named “SuperLeft” and “SuperRight” here.
  • The key that the specification calls “Super” is reported as Unidentified here.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Backquote

` on a US keyboard. This is also called a backtick or grave. This is the 半角/全角/漢字 (hankaku/zenkaku/kanji) key on Japanese keyboards

§

Backslash

Used for both the US \ (on the 101-key layout) and also for the key located between the and Enter keys on row C of the 102-, 104- and 106-key layouts. Labeled # on a UK (102) keyboard.

§

BracketLeft

[ on a US keyboard.

§

BracketRight

] on a US keyboard.

§

Comma

, on a US keyboard.

§

Digit0

0 on a US keyboard.

§

Digit1

1 on a US keyboard.

§

Digit2

2 on a US keyboard.

§

Digit3

3 on a US keyboard.

§

Digit4

4 on a US keyboard.

§

Digit5

5 on a US keyboard.

§

Digit6

6 on a US keyboard.

§

Digit7

7 on a US keyboard.

§

Digit8

8 on a US keyboard.

§

Digit9

9 on a US keyboard.

§

Equal

= on a US keyboard.

§

IntlBackslash

Located between the left Shift and Z keys. Labeled \ on a UK keyboard.

§

IntlRo

Located between the / and right Shift keys. Labeled \ (ro) on a Japanese keyboard.

§

IntlYen

Located between the = and Backspace keys. Labeled ¥ (yen) on a Japanese keyboard. \ on a Russian keyboard.

§

KeyA

a on a US keyboard. Labeled q on an AZERTY (e.g., French) keyboard.

§

KeyB

b on a US keyboard.

§

KeyC

c on a US keyboard.

§

KeyD

d on a US keyboard.

§

KeyE

e on a US keyboard.

§

KeyF

f on a US keyboard.

§

KeyG

g on a US keyboard.

§

KeyH

h on a US keyboard.

§

KeyI

i on a US keyboard.

§

KeyJ

j on a US keyboard.

§

KeyK

k on a US keyboard.

§

KeyL

l on a US keyboard.

§

KeyM

m on a US keyboard.

§

KeyN

n on a US keyboard.

§

KeyO

o on a US keyboard.

§

KeyP

p on a US keyboard.

§

KeyQ

q on a US keyboard. Labeled a on an AZERTY (e.g., French) keyboard.

§

KeyR

r on a US keyboard.

§

KeyS

s on a US keyboard.

§

KeyT

t on a US keyboard.

§

KeyU

u on a US keyboard.

§

KeyV

v on a US keyboard.

§

KeyW

w on a US keyboard. Labeled z on an AZERTY (e.g., French) keyboard.

§

KeyX

x on a US keyboard.

§

KeyY

y on a US keyboard. Labeled z on a QWERTZ (e.g., German) keyboard.

§

KeyZ

z on a US keyboard. Labeled w on an AZERTY (e.g., French) keyboard, and y on a QWERTZ (e.g., German) keyboard.

§

Minus

- on a US keyboard.

§

Period

. on a US keyboard.

§

Quote

on a US keyboard.

§

Semicolon

; on a US keyboard.

§

Slash

/ on a US keyboard.

§

AltLeft

Alt, Option, or .

§

AltRight

Alt, Option, or . This is labeled AltGr on many keyboard layouts.

§

Backspace

Backspace or . Labeled Delete on Apple keyboards.

§

CapsLock

CapsLock or

§

ContextMenu

The application context menu key, which is typically found between the right Super key and the right Control key.

§

ControlLeft

Control or

§

ControlRight

Control or

§

Enter

Enter or . Labeled Return on Apple keyboards.

§

SuperLeft

The Windows, , Command, or other OS symbol key.

§

SuperRight

The Windows, , Command, or other OS symbol key.

§

ShiftLeft

Shift or

§

ShiftRight

Shift or

§

Space

  (space)

§

Tab

Tab or

§

Convert

Japanese: (henkan)

§

KanaMode

Japanese: カタカナ/ひらがな/ローマ字 (katakana/hiragana/romaji)

§

Lang1

Korean: HangulMode 한/영 (han/yeong)

Japanese (Mac keyboard): (kana)

§

Lang2

Korean: Hanja (hanja)

Japanese (Mac keyboard): (eisu)

§

Lang3

Japanese (word-processing keyboard): Katakana

§

Lang4

Japanese (word-processing keyboard): Hiragana

§

Lang5

Japanese (word-processing keyboard): Zenkaku/Hankaku

§

NonConvert

Japanese: 無変換 (muhenkan)

§

Delete

. The forward delete key. Note that on Apple keyboards, the key labelled Delete on the main part of the keyboard is encoded as Backspace.

§

End

Page Down, End, or

§

Help

Help. Not present on standard PC keyboards.

§

Home

Home or

§

Insert

Insert or Ins. Not present on Apple keyboards.

§

PageDown

Page Down, PgDn, or

§

PageUp

Page Up, PgUp, or

§

ArrowDown

§

ArrowLeft

§

ArrowRight

§

ArrowUp

§

NumLock

On the Mac, this is used for the numpad Clear key.

§

Numpad0

0 Ins on a keyboard. 0 on a phone or remote control

§

Numpad1

1 End on a keyboard. 1 or 1 QZ on a phone or remote control

§

Numpad2

2 ↓ on a keyboard. 2 ABC on a phone or remote control

§

Numpad3

3 PgDn on a keyboard. 3 DEF on a phone or remote control

§

Numpad4

4 ← on a keyboard. 4 GHI on a phone or remote control

§

Numpad5

5 on a keyboard. 5 JKL on a phone or remote control

§

Numpad6

6 → on a keyboard. 6 MNO on a phone or remote control

§

Numpad7

7 Home on a keyboard. 7 PQRS or 7 PRS on a phone or remote control

§

Numpad8

8 ↑ on a keyboard. 8 TUV on a phone or remote control

§

Numpad9

9 PgUp on a keyboard. 9 WXYZ or 9 WXY on a phone or remote control

§

NumpadAdd

+

§

NumpadBackspace

Found on the Microsoft Natural Keyboard.

§

NumpadClear

C or A (All Clear). Also for use with numpads that have a Clear key that is separate from the NumLock key. On the Mac, the numpad Clear key is encoded as NumLock.

§

NumpadClearEntry

C (Clear Entry)

§

NumpadComma

, (thousands separator). For locales where the thousands separator is a “.” (e.g., Brazil), this key may generate a ..

§

NumpadDecimal

. Del. For locales where the decimal separator is “,” (e.g., Brazil), this key may generate a ,.

§

NumpadDivide

/

§

NumpadEnter

§

NumpadEqual

=

§

NumpadHash

# on a phone or remote control device. This key is typically found below the 9 key and to the right of the 0 key.

§

NumpadMemoryAdd

M Add current entry to the value stored in memory.

§

NumpadMemoryClear

M Clear the value stored in memory.

§

NumpadMemoryRecall

M Replace the current entry with the value stored in memory.

§

NumpadMemoryStore

M Replace the value stored in memory with the current entry.

§

NumpadMemorySubtract

M Subtract current entry from the value stored in memory.

§

NumpadMultiply

on a keyboard. For use with numpads that provide mathematical operations (+, - and /).

Use NumpadStar for the * key on phones and remote controls.

§

NumpadParenLeft

( Found on the Microsoft Natural Keyboard.

§

NumpadParenRight

) Found on the Microsoft Natural Keyboard.

§

NumpadStar

* on a phone or remote control device.

This key is typically found below the 7 key and to the left of the 0 key.

Use “NumpadMultiply” for the * key on numeric keypads.

§

NumpadSubtract

-

§

Escape

Esc or

§

Fn

Fn This is typically a hardware key that does not generate a separate code.

§

FnLock

FLock or FnLock. Function Lock key. Found on the Microsoft Natural Keyboard.

§

PrintScreen

PrtScr SysRq or Print Screen

§

ScrollLock

Scroll Lock

§

Pause

Pause Break

§

BrowserBack

Some laptops place this key to the left of the key.

This also the “back” button (triangle) on Android.

§

BrowserFavorites

§

BrowserForward

Some laptops place this key to the right of the key.

§

BrowserHome

The “home” button on Android.

§

BrowserRefresh

§

BrowserSearch

§

BrowserStop

§

Eject

Eject or . This key is placed in the function section on some Apple keyboards.

§

LaunchApp1

Sometimes labelled My Computer on the keyboard

§

LaunchApp2

Sometimes labelled Calculator on the keyboard

§

LaunchMail

§

MediaPlayPause

§

MediaSelect

§

MediaStop

§

MediaTrackNext

§

MediaTrackPrevious

§

Power

This key is placed in the function section on some Apple keyboards, replacing the Eject key.

§

Sleep

§

AudioVolumeDown

§

AudioVolumeMute

§

AudioVolumeUp

§

WakeUp

§

Meta

§

Hyper

§

Turbo

§

Abort

§

Resume

§

Suspend

§

Again

Found on Sun’s USB keyboard.

§

Copy

Found on Sun’s USB keyboard.

§

Cut

Found on Sun’s USB keyboard.

§

Find

Found on Sun’s USB keyboard.

§

Open

Found on Sun’s USB keyboard.

§

Paste

Found on Sun’s USB keyboard.

§

Props

Found on Sun’s USB keyboard.

§

Select

Found on Sun’s USB keyboard.

§

Undo

Found on Sun’s USB keyboard.

§

Hiragana

Use for dedicated ひらがな key found on some Japanese word processing keyboards.

§

Katakana

Use for dedicated カタカナ key found on some Japanese word processing keyboards.

§

F1

General-purpose function key. Usually found at the top of the keyboard.

§

F2

General-purpose function key. Usually found at the top of the keyboard.

§

F3

General-purpose function key. Usually found at the top of the keyboard.

§

F4

General-purpose function key. Usually found at the top of the keyboard.

§

F5

General-purpose function key. Usually found at the top of the keyboard.

§

F6

General-purpose function key. Usually found at the top of the keyboard.

§

F7

General-purpose function key. Usually found at the top of the keyboard.

§

F8

General-purpose function key. Usually found at the top of the keyboard.

§

F9

General-purpose function key. Usually found at the top of the keyboard.

§

F10

General-purpose function key. Usually found at the top of the keyboard.

§

F11

General-purpose function key. Usually found at the top of the keyboard.

§

F12

General-purpose function key. Usually found at the top of the keyboard.

§

F13

General-purpose function key. Usually found at the top of the keyboard.

§

F14

General-purpose function key. Usually found at the top of the keyboard.

§

F15

General-purpose function key. Usually found at the top of the keyboard.

§

F16

General-purpose function key. Usually found at the top of the keyboard.

§

F17

General-purpose function key. Usually found at the top of the keyboard.

§

F18

General-purpose function key. Usually found at the top of the keyboard.

§

F19

General-purpose function key. Usually found at the top of the keyboard.

§

F20

General-purpose function key. Usually found at the top of the keyboard.

§

F21

General-purpose function key. Usually found at the top of the keyboard.

§

F22

General-purpose function key. Usually found at the top of the keyboard.

§

F23

General-purpose function key. Usually found at the top of the keyboard.

§

F24

General-purpose function key. Usually found at the top of the keyboard.

§

F25

General-purpose function key.

§

F26

General-purpose function key.

§

F27

General-purpose function key.

§

F28

General-purpose function key.

§

F29

General-purpose function key.

§

F30

General-purpose function key.

§

F31

General-purpose function key.

§

F32

General-purpose function key.

§

F33

General-purpose function key.

§

F34

General-purpose function key.

§

F35

General-purpose function key.

Trait Implementations§

source§

impl Clone for KeyCode

source§

fn clone(&self) -> KeyCode

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 KeyCode

source§

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

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

impl From<KeyCode> for PhysicalKey

source§

fn from(code: KeyCode) -> Self

Converts to this type from the input type.
source§

impl Hash for KeyCode

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 KeyCode

source§

fn cmp(&self, other: &KeyCode) -> 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<KeyCode> for PhysicalKey

source§

fn eq(&self, rhs: &KeyCode) -> 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 PartialEq<PhysicalKey> for KeyCode

source§

fn eq(&self, rhs: &PhysicalKey) -> 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 PartialEq for KeyCode

source§

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

source§

fn partial_cmp(&self, other: &KeyCode) -> 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 PhysicalKeyExtScancode for KeyCode

source§

fn from_scancode(scancode: u32) -> PhysicalKey

Constructs a PhysicalKey from a platform-specific physical key identifier. Read more
source§

fn to_scancode(self) -> Option<u32>

The raw value of the platform-specific physical key identifier. Read more
source§

impl Copy for KeyCode

source§

impl Eq for KeyCode

source§

impl StructuralEq for KeyCode

source§

impl StructuralPartialEq for KeyCode

Auto Trait Implementations§

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> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more