Struct TextBoxStyle

#[non_exhaustive]
pub struct TextBoxStyle {
    pub alignment: HorizontalAlignment,
    pub vertical_alignment: VerticalAlignment,
    pub height_mode: HeightMode,
    pub line_height: LineHeight,
    pub paragraph_spacing: u32,
    pub tab_size: TabSize,
    pub leading_spaces: bool,
    pub trailing_spaces: bool,
}

Styling options of a TextBox.

TextBoxStyle contains the font, foreground and background PixelColor, line spacing, HeightMode, HorizontalAlignment and VerticalAlignment information necessary to draw a TextBox.

To construct a new TextBoxStyle object, use the TextBoxStyle::default method or the TextBoxStyleBuilder object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

alignment: HorizontalAlignment

Horizontal text alignment.

vertical_alignment: VerticalAlignment

Vertical text alignment.

height_mode: HeightMode

The height behaviour.

line_height: LineHeight

Line height.

paragraph_spacing: u32

Paragraph spacing.

tab_size: TabSize

Desired column width for tabs

leading_spaces: bool

True to render leading spaces

trailing_spaces: bool

True to render trailing spaces

Implementations

impl TextBoxStyle

pub const fn default() -> Self

Creates a new text box style object with default settings.

pub const fn with_alignment(alignment: HorizontalAlignment) -> TextBoxStyle

Creates a new text box style with the given alignment.

pub const fn with_vertical_alignment( alignment: VerticalAlignment, ) -> TextBoxStyle

Creates a new text box style with the given vertical alignment.

pub const fn with_height_mode(mode: HeightMode) -> TextBoxStyle

Creates a new text box style with the given height mode.

pub const fn with_line_height(line_height: LineHeight) -> TextBoxStyle

Creates a new text box style with the given line height.

pub const fn with_paragraph_spacing(spacing: u32) -> TextBoxStyle

Creates a new text box style with the given paragraph spacing.

pub const fn with_tab_size(tab_size: TabSize) -> TextBoxStyle

Creates a new text box style with the given tab size.

impl TextBoxStyle

pub fn measure_text_height<S>( &self, character_style: &S, text: &str, max_width: u32, ) -> u32

where S: TextRenderer,

Measures text height when rendered using a given width.

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

let character_style = MonoTextStyleBuilder::new()
    .font(&FONT_6X9)
    .text_color(BinaryColor::On)
    .build();
let style = TextBoxStyleBuilder::new().build();

let height = style.measure_text_height(
    &character_style,
    "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 * 9, height);

Trait Implementations

impl Clone for TextBoxStyle

fn clone(&self) -> TextBoxStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextBoxStyle

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

Formats the value using the given formatter.

impl From<&TextBoxStyle> for TextBoxStyleBuilder

fn from(style: &TextBoxStyle) -> Self

Converts to this type from the input type.

impl Hash for TextBoxStyle

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TextBoxStyle

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TextBoxStyle

impl Eq for TextBoxStyle

impl StructuralPartialEq for TextBoxStyle