Struct embedded_text::style::TextBoxStyle

pub struct TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode,  {
    pub text_style: TextStyle<C, F>,
    pub alignment: A,
    pub vertical_alignment: V,
    pub height_mode: H,
    pub line_spacing: i32,
}

Styling options of a TextBox.

TextBoxStyle contains the Font, foreground and background PixelColor, line spacing, HeightMode, HorizontalTextAlignment and VerticalTextAlignment information necessary to draw a TextBox.

To construct a new TextBoxStyle object, use the new or from_text_style methods or the TextBoxStyleBuilder object.

Fields

text_style: TextStyle<C, F>

Style properties for text.

alignment: A

Horizontal text alignment.

vertical_alignment: V

Vertical text alignment.

height_mode: H

The height behaviour

line_spacing: i32

Desired space between lines, in pixels

Implementations

impl<C, F, A, V, H> TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

pub fn new(
    font: F,
    text_color: C,
    alignment: A,
    vertical_alignment: V,
    height_mode: H
) -> Self

Creates a TextBoxStyle object with transparent background.

pub fn from_text_style(
    text_style: TextStyle<C, F>,
    alignment: A,
    vertical_alignment: V,
    height_mode: H
) -> Self

Creates a TextBoxStyle object from the given text style and alignment.

#[must_use]pub fn measure_line<'a>(
    &self,
    parser: &mut Parser<'a>,
    carried_token: Option<Token<'a>>,
    max_line_width: u32
) -> (u32, u32, Option<Token<'a>>)

Measure the width and count spaces in a single line of text.

Returns (width, rendered space count, carried token)

Instead of peeking ahead when processing tokens, this function advances the parser before processing a token. If a token opens a new line, it will be returned as the carried token. If the carried token is None, the parser has finished processing the text.

#[must_use]pub fn measure_text_height(&self, text: &str, max_width: u32) -> u32

Measures text height when rendered using a given width.

Example: measure height of text when rendered using a 6x8 font and 72px width.

let style = TextBoxStyleBuilder::new(Font6x8)
    .text_color(BinaryColor::On)
    .build();

let height = style.measure_text_height(
    "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
    72,
);

// Expect 7 lines of text, wrapped in something like the following:

// |Lorem Ipsum |
// |is simply   |
// |dummy text  |
// |of the      |
// |printing and|
// |typesetting |
// |industry.   |

assert_eq!(7 * 8, height);

Trait Implementations

impl<C: Clone, F: Clone, A: Clone, V: Clone, H: Clone> Clone for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn clone(&self) -> TextBoxStyle<C, F, A, V, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Copy, F: Copy, A: Copy, V: Copy, H: Copy> Copy for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

impl<C: Debug, F: Debug, A: Debug, V: Debug, H: Debug> Debug for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

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

Formats the value using the given formatter.

impl<C: Default, F: Default, A: Default, V: Default, H: Default> Default for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn default() -> TextBoxStyle<C, F, A, V, H>

Returns the "default value" for a type.

impl<C: Eq, F: Eq, A: Eq, V: Eq, H: Eq> Eq for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

impl<C: Hash, F: Hash, A: Hash, V: Hash, H: Hash> Hash for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<C: Ord, F: Ord, A: Ord, V: Ord, H: Ord> Ord for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn cmp(&self, other: &TextBoxStyle<C, F, A, V, H>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<C: PartialEq, F: PartialEq, A: PartialEq, V: PartialEq, H: PartialEq> PartialEq<TextBoxStyle<C, F, A, V, H>> for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn eq(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

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

fn ne(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

This method tests for !=.

impl<C: PartialOrd, F: PartialOrd, A: PartialOrd, V: PartialOrd, H: PartialOrd> PartialOrd<TextBoxStyle<C, F, A, V, H>> for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

fn partial_cmp(&self, other: &TextBoxStyle<C, F, A, V, H>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TextBoxStyle<C, F, A, V, H>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C, F, A, V, H> StructuralEq for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode, 

impl<C, F, A, V, H> StructuralPartialEq for TextBoxStyle<C, F, A, V, H> where
    C: PixelColor,
    F: Font + Copy,
    A: HorizontalTextAlignment,
    V: VerticalTextAlignment,
    H: HeightMode,