Struct Text

pub struct Text(/* private fields */);

W A configured text run.

Examples

let hello_txt = Text! {
    font_family = "Arial";
    font_size = 18;
    txt = "Hello!";
};

Shorthand

The Text! macro provides shorthand syntax that matches the formatx! input, but outputs a text widget:

let txt = Text!("Hello!");

let name = "World";
let fmt = Text!("Hello {}!", name);

let expr = Text!({
    let mut s = String::new();
    s.push('a');
    s
});

The code abode is equivalent to:

let txt = Text! {
    txt = formatx!("Hello!");
};

let name = "World";
let fmt = Text! {
    txt = formatx!("Hello {}!", name);
};

let expr = Text! {
    txt = {
        let mut s = String::new();
        s.push('a');
        s
    };
};

Implementations

impl Text

pub fn widget_new() -> Text

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl Text

pub fn context_vars_set(set: &mut ContextValueSet)

Context variables used by properties in text.

impl Text

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

c The text string.

Set to an empty string ("") by default.

impl Text

pub fn txt_parse<T>(&self, value: impl IntoVar<T>)

where T: TxtParseValue,

P Value that is parsed from the text and displayed as the text.

This is an alternative to txt that converts to and from T if it can be formatted to display text and can parse, with parse error that can display.

If the parse operation fails the value variable is not updated and the error display text is set in DATA.invalidate, you can use has_data_error and get_data_error_txt to display the error.

See also txt_parse_live for ways to control when the parse attempt happens.

Methods from Deref<Target = FontMix<TextFillMix<TextAlignMix<TextWrapMix<TextDecorationMix<TextSpacingMix<TextTransformMix<LangMix<FontFeaturesMix<TextEditMix<SelectionToolbarMix<TextInspectMix<WidgetBase>>>>>>>>>>>>>

pub fn font_family(&self, names: impl IntoVar<FontNames>)

P Font family name or list of names for texts in this widget or descendants.

All fonts in the list are resolved according to the font_style, font_weight and font_stretch config. During text shaping the first font on the list is preferred, but if the font does not cover a character or word, that character or word to the second font in the list and so on.

Sets the FONT_FAMILY_VAR.

pub fn font_size(&self, size: impl IntoVar<Length>)

P Sets the font size for the widget and descendants.

This property affects all texts inside the widget and the Length::Em unit.

Sets the FONT_SIZE_VAR context var and the LayoutMetrics::font_size.

pub fn font_weight(&self, weight: impl IntoVar<FontWeight>)

P Defines the thickness or boldness the preferred font should have.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_WEIGHT_VAR.

pub fn font_style(&self, style: impl IntoVar<FontStyle>)

P Defines the skew style of the font glyphs.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_STYLE_VAR.

pub fn font_stretch(&self, stretch: impl IntoVar<FontStretch>)

P Defines how condensed or expanded the preferred font should be.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_STRETCH_VAR.

pub fn font_synthesis(&self, enabled: impl IntoVar<FontSynthesis>)

P Configure if a synthetic font is generated for fonts that do not implement bold or oblique variants.

Not all fonts implement the requested font_weight and font_style, this config allows the renderer to try and generate the style and weight anyway, using transforms and the glyph outlines.

Sets the FONT_SYNTHESIS_VAR.

pub fn font_aa(&self, aa: impl IntoVar<FontAntiAliasing>)

P Configure the anti-aliasing used to render text glyphs inside the widget.

Uses the operating system configuration by default.

Sets the FONT_AA_VAR.

Trait Implementations

impl Deref for Text

type Target = FontMix<TextFillMix<TextAlignMix<TextWrapMix<TextDecorationMix<TextSpacingMix<TextTransformMix<LangMix<FontFeaturesMix<TextEditMix<SelectionToolbarMix<TextInspectMix<WidgetBase>>>>>>>>>>>>

The resulting type after dereferencing.

fn deref(&self) -> &<Text as Deref>::Target

Dereferences the value.

impl DerefMut for Text

fn deref_mut(&mut self) -> &mut <Text as Deref>::Target

Mutably dereferences the value.