Struct egui::text::LayoutJob

source ·
pub struct LayoutJob {
    pub text: String,
    pub sections: Vec<LayoutSection, Global>,
    pub wrap: TextWrapping,
    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}, 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, Global>

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

§wrap: TextWrapping§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 TextWrapping::max_width

Implementations§

source§

impl LayoutJob

source

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

Break on \n and at the given wrap width.

source

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

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

source

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

source

pub fn is_empty(&self) -> bool

source

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

Helper for adding a new section when building a LayoutJob.

source

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

The height of the tallest used font in the job.

Trait Implementations§

source§

impl Clone for LayoutJob

source§

fn clone(&self) -> LayoutJob

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for LayoutJob

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for LayoutJob

source§

fn default() -> LayoutJob

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

impl From<LayoutJob> for WidgetText

source§

fn from(layout_job: LayoutJob) -> Self

Converts to this type from the input type.
source§

impl Hash for LayoutJob

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

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

impl PartialEq<LayoutJob> for LayoutJob

source§

fn eq(&self, other: &LayoutJob) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl StructuralPartialEq for LayoutJob

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

§

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 Twhere U: TryFrom<T>,

§

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.
source§

impl<T> SerializableAny for Twhere T: 'static + Any + Clone + Send + Sync,