Struct TextLayoutOptions

pub struct TextLayoutOptions {
    pub font_size_px: PixelValue,
    pub line_height: Option<f32>,
    pub letter_spacing: Option<PixelValue>,
    pub word_spacing: Option<PixelValue>,
    pub tab_width: Option<f32>,
    pub max_horizontal_width: Option<f32>,
    pub leading: Option<f32>,
    pub holes: Vec<LayoutRect>,
}

Layout options that can impact the flow of word positions

Fields

font_size_px: PixelValue

Font size (in pixels) that this text has been laid out with

line_height: Option<f32>

Multiplier for the line height, default to 1.0

letter_spacing: Option<PixelValue>

Additional spacing between glyphs (in pixels)

word_spacing: Option<PixelValue>

Additional spacing between words (in pixels)

tab_width: Option<f32>

How many spaces should a tab character emulate (multiplying value, i.e. 4.0 = one tab = 4 spaces)?

max_horizontal_width: Option<f32>

Maximum width of the text (in pixels) - if the text is set to overflow:visible, set this to None.

leading: Option<f32>

How many pixels of leading does the first line have? Note that this added onto to the holes, so for effects like :first-letter, use a hole instead of a leading.

holes: Vec<LayoutRect>

This is more important for inline text layout where items can punch “holes” into the text flow, for example an image that floats to the right.

TODO: Currently unused!

Trait Implementations

impl Clone for TextLayoutOptions

fn clone(&self) -> TextLayoutOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextLayoutOptions

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

Formats the value using the given formatter.

impl Default for TextLayoutOptions

fn default() -> TextLayoutOptions

Returns the “default value” for a type.

impl PartialEq for TextLayoutOptions

fn eq(&self, other: &TextLayoutOptions) -> 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 PartialOrd for TextLayoutOptions

fn partial_cmp(&self, other: &TextLayoutOptions) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for TextLayoutOptions