Struct epaint::text::LayoutJob

pub struct LayoutJob {
    pub text: String,
    pub sections: Vec<LayoutSection>,
    pub wrap: TextWrapping,
    pub first_row_min_height: f32,
    pub break_on_newline: bool,
    pub halign: Align,
    pub justify: bool,
}

Describes the task of laying out text.

This supports mixing different fonts, color and formats (underline etc).

Pass this to crate::Fonts::layout_job or crate::text::layout.

Example:

use epaint::{Color32, text::{LayoutJob, TextFormat}, FontFamily, FontId};

let mut job = LayoutJob::default();
job.append(
    "Hello ",
    0.0,
    TextFormat {
        font_id: FontId::new(14.0, FontFamily::Proportional),
        color: Color32::WHITE,
        ..Default::default()
    },
);
job.append(
    "World!",
    0.0,
    TextFormat {
        font_id: FontId::new(14.0, FontFamily::Monospace),
        color: Color32::BLACK,
        ..Default::default()
    },
);

As you can see, constructing a LayoutJob is currently a lot of work. It would be nice to have a helper macro for it!

Fields

text: String

The complete text of this job, referenced by LayoutSection.

sections: Vec<LayoutSection>

The different section, which can have different fonts, colors, etc.

wrap: TextWrapping

Controls the text wrapping and elision.

first_row_min_height: f32

The first row must be at least this high. This is in case we lay out text that is the continuation of some earlier text (sharing the same row), in which case this will be the height of the earlier text. In other cases, set this to 0.0.

break_on_newline: bool

If true, all \n characters will result in a new paragraph, starting on a new row.

If false, all \n characters will be ignored and show up as the replacement character.

Default: true.

halign: Align

How to horizontally align the text (Align::LEFT, Align::Center, Align::RIGHT).

justify: bool

Justify text so that word-wrapped rows fill the whole TextWrapping::max_width.

Implementations

impl LayoutJob

pub fn simple( text: String, font_id: FontId, color: Color32, wrap_width: f32 ) -> Self

Break on \n and at the given wrap width.

pub fn simple_singleline(text: String, font_id: FontId, color: Color32) -> Self

Does not break on \n, but shows the replacement character instead.

pub fn single_section(text: String, format: TextFormat) -> Self

pub fn is_empty(&self) -> bool

pub fn append(&mut self, text: &str, leading_space: f32, format: TextFormat)

Helper for adding a new section when building a LayoutJob.

pub fn font_height(&self, fonts: &Fonts) -> f32

The height of the tallest font used in the job.

Trait Implementations

impl Clone for LayoutJob

fn clone(&self) -> LayoutJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutJob

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

Formats the value using the given formatter.

impl Default for LayoutJob

fn default() -> Self

Returns the “default value” for a type.

impl Hash for LayoutJob

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LayoutJob

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