Struct egui::text::LayoutJob[][src]

pub struct LayoutJob {
    pub text: String,
    pub sections: Vec<LayoutSection, Global>,
    pub wrap_width: f32,
    pub first_row_min_height: f32,
    pub break_on_newline: bool,
    pub halign: Align,
    pub justify: bool,
}
Expand description

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}, TextStyle};

let mut job = LayoutJob::default();
job.append(
    "Hello ",
    0.0,
    TextFormat {
        style: TextStyle::Body,
        color: Color32::WHITE,
        ..Default::default()
    },
);
job.append(
    "World!",
    0.0,
    TextFormat {
        style: TextStyle::Monospace,
        color: Color32::BLACK,
        ..Default::default()
    },
);

Fields

text: String

The complete text of this job, referenced by LayoutSection.

sections: Vec<LayoutSection, Global>

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

wrap_width: f32

Try to break text so that no row is wider than this. Set to f32::INFINITY to turn off wrapping. Note that \n always produces a new line.

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 false, all newlines 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 Self::wrap_width

Implementations

Break on \n and at the given wrap width.

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

Helper for adding a new section when building a LayoutJob.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Deserialize this value from the given Serde deserializer. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.