Struct Keycaps 

pub struct Keycaps {
    pub language: KeycapLanguage,
    pub family: KeyboardFamily,
}

The legends of one keyboard: its layout’s language and whether it is an Apple keyboard.

Fields

language: KeycapLanguage

family: KeyboardFamily

Implementations

impl Keycaps

pub const US: Keycaps

US English legends on a PC keyboard: the default.

pub fn from_xkb(layout: &str, variant: &str) -> Keycaps

The legends of XKB layout layout with variant variant (empty for the base layout). Mac variants (mac, de_mac, mac_nodeadkeys, …) describe Apple keyboards.

pub fn on_family(self, family: KeyboardFamily) -> Keycaps

The same layout on a keyboard of family. An Apple keyboard stays Apple: its keycaps carry symbols whatever the layout says.

pub fn modifier(self, modifier: KeyboardModifier) -> &'static str

What is printed on modifier.

pub fn native_symbol(self, name: &str, text: &str) -> String

Format native keysym metadata without composing text or applying Ctrl transformations. Shared by static previews and the focused-seat map.

pub fn key(self, name: &str) -> String

What is printed on the key with canonical name name (pageup, escape, f4, k): a single character upper-cased (unless its capital is more than one letter, like ß), a function key as F4, and a name this table does not know as given.

pub fn chord<'a>( self, modifiers: impl IntoIterator<Item = &'a str>, key: &str, ) -> String

A canonical chord (["Super", "Shift"], "s") as the keyboard spells it. PC legends are joined with +; Apple symbols are written together, as Apple does (⌘⇧S). Modifiers are always listed in the same order, Super first, whatever order they were given in.

pub fn token(self, token: &str) -> String

One token of a free-text chord (Super, Ctrl, pageup, K) as the keyboard spells it: a canonical modifier gets its legend, anything else is a key.

Trait Implementations

impl Clone for Keycaps

fn clone(&self) -> Keycaps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keycaps

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

Formats the value using the given formatter.

impl Default for Keycaps

fn default() -> Keycaps

Returns the “default value” for a type.

impl PartialEq for Keycaps

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

impl Eq for Keycaps

impl StructuralPartialEq for Keycaps