[−][src]Trait kas::text::format::FormattableText

pub trait FormattableText: Debug {
    pub fn as_str(&self) -> &str;

    pub fn font_tokens(
        &self, 
        dpp: f32, 
        pt_size: f32
    ) -> OwningVecIter<FontToken>ⓘ
Notable traits for OwningVecIter<T>
impl<T> Iterator for OwningVecIter<T> where
    T: Clone,     type Item = T;
;

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

    pub fn str_len(&self) -> usize { ... }
}

Text, optionally with formatting data

Any F: FormattableText automatically support FormattableTextDyn. Implement either this or FormattableTextDyn, not both.

This trait can only be written as intended using Generic Associated Types ("gat", unstable nightly feature), thus font_tokens has a different signature with/without feature gat and the associated type FontTokenIter is only present with feature gat.

Required methods

pub fn as_str(&self) -> &str[src]

Access whole text as contiguous str

pub fn font_tokens(&self, dpp: f32, pt_size: f32) -> OwningVecIter<FontToken>ⓘ

Notable traits for OwningVecIter<T>

impl<T> Iterator for OwningVecIter<T> where
    T: Clone,  type Item = T;
[src]

Construct an iterator over formatting items

It is expected that FontToken::start of yielded items is strictly increasing; if not, formatting may not be applied correctly.

The dpp and pt_size parameters are as in crate::Environment.

For plain text this iterator will be empty.

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

Get the sequence of effect tokens

This method has some limitations: (1) it may only return a reference to an existing sequence, (2) effect tokens cannot be generated dependent on input state, and (3) it does not incorporate colour information. For most uses it should still be sufficient, but for other cases it may be preferable not to use this method (use a dummy implementation returning &[] and use inherent methods on the text object via Text::text).

Loading content...

Provided methods

pub fn str_len(&self) -> usize[src]

Length of text

Default implementation uses FormattableText::as_str.

Loading content...

Implementations on Foreign Types

impl<'t> FormattableText for &'t str[src]

impl FormattableText for String[src]

Loading content...

Implementors

impl FormattableText for AccelString[src]

impl<'t> FormattableText for &'t (dyn FormattableTextDyn + 't)[src]

Loading content...