Struct kas::text::AccelString

pub struct AccelString { /* fields omitted */ }

An accelerator key string

This is a label which supports highlighting of accelerator 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

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

pub fn clone(&self) -> AccelString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccelString

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

Formats the value using the given formatter.

impl Default for AccelString

pub fn default() -> AccelString

Returns the "default value" for a type.

impl FormattableText for AccelString

pub fn as_str(&self) -> &str

Access whole text as contiguous str

pub fn font_tokens(&self, _: f32, _: f32) -> OwningVecIter<FontToken>

Construct an iterator over formatting items

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

Get the sequence of effect tokens

pub fn str_len(&self) -> usize

Length of text

impl From<&'static str> for AccelString

pub fn from(input: &'static str) -> Self

Performs the conversion.

impl From<String> for AccelString

pub fn from(input: String) -> Self

Performs the conversion.

impl PartialEq<AccelString> for AccelString

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

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

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

This method tests for !=.

impl StructuralPartialEq for AccelString