Struct KeyGestureFormatInfo 

pub struct KeyGestureFormatInfo { /* private fields */ }

Provides platform specific formatting information for the KeyGesture class.

A format info without platform key overrides is the invariant one: keys are formatted with their plain names.

Implementations

impl KeyGestureFormatInfo

pub fn new( platform_key_overrides: Option<HashMap<Key, String>>, meta: &str, ctrl: &str, alt: &str, shift: &str, ) -> Self

Creates a format info.

platform_key_overrides holds the platform specific key names; meta, ctrl, alt and shift are the names of the modifier keys.

pub fn invariant() -> Rc<KeyGestureFormatInfo>

The invariant format info, used as formatting fallback.

pub fn meta(&self) -> &str

The string used to represent Meta on the platform.

pub fn ctrl(&self) -> &str

The string used to represent Ctrl on the platform.

pub fn alt(&self) -> &str

The string used to represent Alt on the platform.

pub fn shift(&self) -> &str

The string used to represent Shift on the platform.

pub fn get_instance( format_provider: Option<Rc<KeyGestureFormatInfo>>, ) -> Rc<KeyGestureFormatInfo>

Returns format_provider if given, otherwise the format info registered with the locator, otherwise the invariant one.

pub fn format_key(&self, key: Key) -> String

Checks the platform overrides and the common overrides, in that order, and returns the name of the key in the appropriate style, or the key’s plain name if there is none.

Trait Implementations

impl Clone for KeyGestureFormatInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyGestureFormatInfo

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

Formats the value using the given formatter.

impl Default for KeyGestureFormatInfo

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for KeyGestureFormatInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyGestureFormatInfo