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 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.
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
sourceimpl Clone for LayoutSettings
impl Clone for LayoutSettings
sourcefn clone(&self) -> LayoutSettings
fn clone(&self) -> LayoutSettings
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Default for LayoutSettings
impl Default for LayoutSettings
sourcefn default() -> LayoutSettings
fn default() -> LayoutSettings
Returns the “default value” for a type. Read more
sourceimpl PartialEq<LayoutSettings> for LayoutSettings
impl PartialEq<LayoutSettings> for LayoutSettings
sourcefn eq(&self, other: &LayoutSettings) -> bool
fn eq(&self, other: &LayoutSettings) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &LayoutSettings) -> bool
fn ne(&self, other: &LayoutSettings) -> bool
This method tests for !=
.
impl Copy for LayoutSettings
impl StructuralPartialEq for LayoutSettings
Auto Trait Implementations
impl RefUnwindSafe for LayoutSettings
impl Send for LayoutSettings
impl Sync for LayoutSettings
impl Unpin for LayoutSettings
impl UnwindSafe for LayoutSettings
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more