Struct AnsiText

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

W Render text styled using ANSI escape sequences.

Supports color, weight, italic and more, see AnsiStyle for the full style supported.

Implementations

impl AnsiText

pub fn widget_new() -> AnsiText

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl AnsiText

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

P ANSI text.

impl AnsiText

pub fn blink_interval(&self, interval: impl IntoVar<Duration>)

P ANSI blink animation interval.

Set to ZERO to disable the blink animation.

Sets the BLINK_INTERVAL_VAR.

impl AnsiText

pub fn text_fn(&self, wgt_fn: impl IntoVar<WidgetFn<TextFnArgs>>)

P Widget function that converts TextFnArgs to widgets.

Sets the TEXT_FN_VAR.

impl AnsiText

pub fn line_fn(&self, wgt_fn: impl IntoVar<WidgetFn<LineFnArgs>>)

P Widget function that converts LineFnArgs to widgets.

Sets the LINE_FN_VAR.

impl AnsiText

pub fn page_fn(&self, wgt_fn: impl IntoVar<WidgetFn<PageFnArgs>>)

P Widget function that converts PageFnArgs to widgets.

A page is a stack of a maximum of lines_per_page, the text is split in pages mostly for performance reasons.

Sets the PAGE_FN_VAR.

impl AnsiText

pub fn panel_fn(&self, wgt_fn: impl IntoVar<WidgetFn<PanelFnArgs>>)

P Widget function that converts PanelFnArgs to widgets.

impl AnsiText

pub fn lines_per_page(&self, count: impl IntoVar<u32>)

P Maximum number of lines per page view.

Sets the LINES_PER_PAGE_VAR.

Methods from Deref<Target = FontMix<TextSpacingMix<ParagraphMix<LangMix<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 AnsiText

type Target = FontMix<TextSpacingMix<ParagraphMix<LangMix<WidgetBase>>>>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for AnsiText

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

Mutably dereferences the value.