Enum Key

#[non_exhaustive]
pub enum Key {
    Backspace,
    Tab,
    Return,
    Escape,
    Backtab,
    Delete,
    Shift,
    Control,
    Alt,
    AltGr,
    CapsLock,
    ShiftR,
    ControlR,
    Meta,
    MetaR,
    Space,
    UpArrow,
    DownArrow,
    LeftArrow,
    RightArrow,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    Insert,
    Home,
    End,
    PageUp,
    PageDown,
    ScrollLock,
    Pause,
    SysReq,
    Stop,
    Menu,
}

The Key enum is used to map a specific key by name e.g. Key::Control to an internal used unicode representation. The enum is convertible to std::char and slint::SharedString. Use this with slint::platform::WindowEvent to supply key events to Slint’s platform abstraction.

Example

Send an tab key press event to a window

use slint::platform::{WindowEvent, Key};
fn send_tab_pressed(window: &slint::Window) {
    window.dispatch_event(WindowEvent::KeyPressed { text: Key::Tab.into() });
}

Variants (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.

Backspace

Tab

Return

Escape

Backtab

Delete

Shift

Control

Alt

AltGr

CapsLock

ShiftR

ControlR

Meta

MetaR

Space

UpArrow

DownArrow

LeftArrow

RightArrow

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

Insert

Home

End

PageUp

PageDown

ScrollLock

Pause

SysReq

Stop

Menu

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

Formats the value using the given formatter.

impl From<Key> for SharedString

fn from(k: Key) -> Self

Converts to this type from the input type.

impl From<Key> for char

fn from(k: Key) -> Self

Converts to this type from the input type.

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 Copy for Key

impl StructuralPartialEq for Key