Struct fontdue::layout::LayoutSettings

pub struct LayoutSettings {
    pub x: f32,
    pub y: f32,
    pub max_width: Option<f32>,
    pub max_height: Option<f32>,
    pub horizontal_align: HorizontalAlign,
    pub vertical_align: VerticalAlign,
    pub line_height: f32,
    pub wrap_style: WrapStyle,
    pub wrap_hard_breaks: bool,
}

Settings to configure how text layout is constrained. Text layout is considered best effort and layout may violate the constraints defined here if they prevent text from being laid out.

Fields

x: f32

The leftmost boundary of the text region.

y: f32

The topmost boundary of the text region.

max_width: Option<f32>

An optional rightmost boundary on the text region. A line of text that exceeds the max_width is wrapped to the line below. If the width of a glyph is larger than the max_width, the glyph will overflow past the max_width. The application is responsible for handling the overflow.

max_height: Option<f32>

An optional bottom boundary on the text region. This is used for positioning the vertical_align option. Text that exceeds the defined max_height will overflow past it. The application is responsible for handling the overflow.

horizontal_align: HorizontalAlign

The default is Left. This option does nothing if the max_width isn’t set.

vertical_align: VerticalAlign

The default is Top. This option does nothing if the max_height isn’t set.

line_height: f32

The height of each line as a multiplier of the default.

wrap_style: WrapStyle

The default is Word. Wrap style is a hint for how strings of text should be wrapped to the next line. Line wrapping can happen when the max width/height is reached.

wrap_hard_breaks: bool

The default is true. This option enables hard breaks, like new line characters, to prematurely wrap lines. If false, hard breaks will not prematurely create a new line.

Trait Implementations

impl Clone for LayoutSettings

fn clone(&self) -> LayoutSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for LayoutSettings

fn default() -> LayoutSettings

Returns the “default value” for a type.

impl PartialEq<LayoutSettings> for LayoutSettings

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

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

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

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

impl Copy for LayoutSettings

impl StructuralPartialEq for LayoutSettings