Struct fontdue::layout::LayoutSettings
source · 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,
}
Expand description
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§
source§impl Clone for LayoutSettings
impl Clone for LayoutSettings
source§fn clone(&self) -> LayoutSettings
fn clone(&self) -> LayoutSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for LayoutSettings
impl Default for LayoutSettings
source§fn default() -> LayoutSettings
fn default() -> LayoutSettings
source§impl PartialEq for LayoutSettings
impl PartialEq for LayoutSettings
source§fn eq(&self, other: &LayoutSettings) -> bool
fn eq(&self, other: &LayoutSettings) -> bool
self
and other
values to be equal, and is used
by ==
.