Struct kas_core::text::AccelString

pub struct AccelString { /* private fields */ }

An accelerator key string

This is a label which supports highlighting of accelerator keys (elsewhere called “access keys” or “mnemonics”). This type represents both the displayed text (via FormattableText implementation) and the shortcut (via AccelString::keys).

Markup: && translates to &; &x for any x translates to x and identifies x as an “accelerator key”; this may be drawn underlined and may support keyboard access via e.g. Alt+X

Implementations

impl AccelString

pub fn keys(&self) -> &[VK]

Get the key bindings

Usually this list has length zero or one, but nothing prevents the use multiple mnemonic key bindings.

pub fn take_keys(self) -> VirtualKeyCodes

Take the key bindings, destroying self

pub fn text(&self) -> &str

Get the text

Trait Implementations

impl Clone for AccelString

fn clone(&self) -> AccelString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccelString

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

Formats the value using the given formatter.

impl Default for AccelString

fn default() -> AccelString

Returns the “default value” for a type.

impl FormattableText for AccelString

type FontTokenIter<'a> = Empty<FontToken>

fn as_str(&self) -> &str

Access whole text as contiguous str

fn font_tokens(&self, _: f32) -> Self::FontTokenIter<'_>

Construct an iterator over formatting items

fn effect_tokens(&self) -> &[Effect<()>]

Get the sequence of effect tokens

fn str_len(&self) -> usize

Length of text

impl<T: Into<AccelString> + Copy> From<&T> for AccelString

fn from(input: &T) -> Self

Converts to this type from the input type.

impl From<&str> for AccelString

fn from(input: &str) -> Self

Converts to this type from the input type.

impl From<String> for AccelString

fn from(input: String) -> Self

Converts to this type from the input type.

impl PartialEq<AccelString> for AccelString

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

This method tests for self and other values to be equal, and is used by ==.

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.

impl Eq for AccelString

impl StructuralEq for AccelString

impl StructuralPartialEq for AccelString