Skip to main content

TextLayoutEngine

Struct TextLayoutEngine 

Source
pub struct TextLayoutEngine { /* private fields */ }
Expand description

Breaks TextRun sequences into LineBoxes that fit within a given width.

Uses real glyph-advance metrics from FontRegistry (rustybuzz + ttf-parser).

Implementations§

Source§

impl TextLayoutEngine

Source

pub fn new(fonts: &FontRegistry, style: &DocumentStyle) -> Self

Source

pub fn measure_text_mm( &self, fonts: &FontRegistry, text: &str, font_size: f64, bold: bool, italic: bool, ) -> f64

Measures the rendered width of text in mm using real glyph metrics.

Source

pub fn default_family_name(&self) -> &str

Returns the default font family name used for measurement.

Source

pub fn set_default_family(&mut self, name: impl Into<String>)

Overrides the default font family used for measurement.

Used by Paragraph to apply a per-paragraph font family. Always restore with the previous value after the layout call.

Source

pub fn line_height_mm(&self, fonts: &FontRegistry, font_size: f64) -> f64

Returns the line height in mm for font_size (pt).

Source

pub fn layout_runs( &self, fonts: &FontRegistry, runs: &[TextRun], max_width_mm: f64, alignment: TextAlign, font_size: f64, tab_stops: &[TabStop], ) -> LayoutResult

Lays out runs into LineBoxes fitting max_width_mm.

tab_stops controls how \t characters inside runs are handled. Pass an empty slice when no tab stops are defined.

Source

pub fn layout_plain( &self, fonts: &FontRegistry, text: &str, max_width_mm: f64, alignment: TextAlign, font_size: f64, style: AppliedStyle, ) -> LayoutResult

Convenience wrapper: lay out a plain string with a uniform style.

Source

pub fn layout_runs_with_mode( &self, fonts: &FontRegistry, runs: &[TextRun], max_width_mm: f64, alignment: TextAlign, font_size: f64, tab_stops: &[TabStop], mode: LineBreakingMode, ) -> LayoutResult

Layout with explicit line-breaking mode.

When mode is LineBreakingMode::KnuthPlass and the optimal_wrap feature is compiled, uses the Knuth-Plass algorithm for better paragraph colour (inter-word spacing consistency). Falls back to greedy otherwise.

Source

pub fn hyphenate_word(&self, word: &str) -> Vec<usize>

Returns hyphenation break points (byte indices) for a word.

Requires the hyphenation feature. Returns an empty Vec when the feature is disabled or the word has fewer than 5 characters.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.