Skip to main content

KeyCode

Enum KeyCode 

Source
pub enum KeyCode {
Show 195 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, Unidentified,
}
Expand description

Type-safe physical key codes — a 1-to-1 mirror of winit::keyboard::KeyCode but living in khora-core so app code never has to depend on winit.

Variant names follow the W3C UI Events code attribute convention (KeyA, Digit1, ShiftLeft, …) — same as winit. The Unidentified catch-all is used by the platform adapter for keys that don’t have a recognised code.

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

§

Unidentified

Catch-all for keys whose physical code the adapter could not map to any of the variants above. The platform adapter logs a one-shot warning the first time it produces this value so the gap is visible.

Trait Implementations§

Source§

impl Clone for KeyCode

Source§

fn clone(&self) -> KeyCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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 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 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

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

impl PartialEq for KeyCode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl Copy for KeyCode

Source§

impl Eq 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> AppLifecycle for T
where T: ?Sized,

Source§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
Source§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
Source§

impl<T> AsAny for T
where T: Any,

Source§

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

Returns a reference to the inner value as &dyn Any.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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,

Source§

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>,

Source§

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>,

Source§

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.