Struct 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 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).

Struct TextWrapping Copy item path

Fields§

Implementations§

impl TextWrapping

pub fn from_wrap_mode_and_width(mode: TextWrapMode, max_width: f32) -> Self

pub fn no_max_width() -> Self

pub fn wrap_at_width(max_width: f32) -> Self

pub fn truncate_at_width(max_width: f32) -> Self

Trait Implementations§

impl Clone for TextWrapping

fn clone(&self) -> TextWrapping

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

impl Debug for TextWrapping

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

impl Default for TextWrapping

fn default() -> Self

impl<'de> Deserialize<'de> for TextWrapping

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Hash for TextWrapping

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

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

impl PartialEq for TextWrapping

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

fn ne(&self, other: &Rhs) -> bool

impl Serialize for TextWrapping

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl StructuralPartialEq for TextWrapping

Auto Trait Implementations§

impl Freeze for TextWrapping

impl RefUnwindSafe for TextWrapping

impl Send for TextWrapping

impl Sync for TextWrapping

impl Unpin for TextWrapping

impl UnwindSafe for TextWrapping

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

Struct TextWrapping

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

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

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

impl<T> ToOwned for T
where T: Clone,

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,