Struct TextWrapMix

pub struct TextWrapMix<P>(/* private fields */);

m Text wrap, hyphenation.

All properties in this mixin affects Text! nodes inside the widget where they are set.

Implementations

impl TextWrapMix<()>

pub fn context_vars_set(set: &mut ContextValueSet)

Insert context variables used by properties in this mix-in.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn txt_wrap(&self, enabled: impl IntoVar<bool>)

P Enables or disables text wrap.

If enabled, line-breaks and hyphens are automatically inserted to flow the text to fill the available width. Wrap can be configured using the line_break, word_break and hyphens properties.

Sets the TEXT_WRAP_VAR.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn word_break(&self, mode: impl IntoVar<WordBreak>)

P Configure line breaks inside words during text wrap.

This value is only considered if it is impossible to fit a full word to a line.

Hyphens can be inserted in word breaks using the hyphens configuration.

Sets the WORD_BREAK_VAR.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn line_break(&self, mode: impl IntoVar<LineBreak>)

P Configuration of text wrapping for Chinese, Japanese, or Korean text.

Sets the LINE_BREAK_VAR.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn hyphens(&self, hyphens: impl IntoVar<Hyphens>)

P Configure hyphenation.

Note that for automatic hyphenation to work the lang must also be set and the HYPHENATION service must support it.

The auto hyphenation char can be defined using hyphen_char.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn hyphen_char(&self, hyphen: impl IntoVar<Txt>)

P The char or small string that is rendered when text is auto-hyphenated.

Note that hyphenation is enabled by the hyphens property.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn txt_overflow(&self, overflow: impl IntoVar<TextOverflow>)

P Defines if text overflow is truncated, with optional suffix append.

When enabled overflow is truncated by character or by the wrap rules if txt_wrap is enabled (it is by default).

Overflow is always ignored when the text is editable.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn is_overflown(&self, state: impl IntoVar<bool>)

P Gets if the text is overflown.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn is_line_overflown(&self, state: impl IntoVar<bool>)

P Gets if the text has an entire line overflown.

This is true when the text has multiple lines, either due to line-break or wrap, and at least one line overflows the allowed height, partially or fully.

impl<P: WidgetImpl> TextWrapMix<P>

pub fn get_overflow(&self, txt: impl IntoVar<Txt>)

P Gets the overflow text, that is a clone of the text starting from the first overflow character.

Note that overflow is tracked even if txt_overflow is set to TextOverflow::Ignore.

Trait Implementations

impl<P> Deref for TextWrapMix<P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P> DerefMut for TextWrapMix<P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.