Struct egui::text::TextWrapping

source ·
pub struct TextWrapping {
    pub max_width: f32,
    pub max_rows: usize,
    pub break_anywhere: bool,
    pub overflow_character: Option<char>,
}
Expand description

Controls the text wrapping and elision of a LayoutJob.

Fields§

§max_width: f32

Wrap text so that no row is wider than this.

If you would rather truncate text that doesn’t fit, set Self::max_rows to 1.

Set max_width to f32::INFINITY to turn off wrapping and elision.

Note that \n always produces a new row if LayoutJob::break_on_newline is true.

§max_rows: usize

Maximum amount of rows the text galley should have.

If this limit is reached, text will be truncated and and Self::overflow_character appended to the final row. You can detect this by checking Galley::elided.

If set to 0, no text will be outputted.

If set to 1, a single row will be outputted, eliding the text after Self::max_width is reached. When you set max_rows = 1, it is recommended you also set Self::break_anywhere to true.

Default value: usize::MAX.

§break_anywhere: bool

If true: Allow breaking between any characters. If false (default): prefer breaking between words, etc.

NOTE: Due to limitations in the current implementation, when truncating text using Self::max_rows the text may be truncated in the middle of a word even if Self::break_anywhere is false. Therefore it is recommended to set Self::break_anywhere to true whenever Self::max_rows is set to 1.

§overflow_character: Option<char>

Character to use to represent elided text.

The default is .

If not set, no character will be used (but the text will still be elided).

Implementations§

source§

impl TextWrapping

source

pub fn no_max_width() -> TextWrapping

A row can be as long as it need to be.

source

pub fn truncate_at_width(max_width: f32) -> TextWrapping

Elide text that doesn’t fit within the given width, replaced with .

Trait Implementations§

source§

impl Clone for TextWrapping

source§

fn clone(&self) -> TextWrapping

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 TextWrapping

source§

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

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

impl Default for TextWrapping

source§

fn default() -> TextWrapping

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

impl Hash for TextWrapping

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 for TextWrapping

source§

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

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> 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> ToOwned for T
where 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 T
where 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 T
where 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 T
where T: 'static + Any + Clone + for<'a> Send + Sync,