Struct zng_wgt_ansi_text::AnsiText

source ·
pub struct AnsiText(/* private fields */);
Expand description

W Render text styled using ANSI escape sequences.

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

Implementations§

source§

impl AnsiText

P ANSI blink animation interval.

Set to ZERO to disable the blink animation.

Sets the BLINK_INTERVAL_VAR.

source§

impl AnsiText

source

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

P Widget function that converts TextFnArgs to widgets.

Sets the TEXT_FN_VAR.

source§

impl AnsiText

source

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

P Widget function that converts LineFnArgs to widgets.

Sets the LINE_FN_VAR.

source§

impl AnsiText

source

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.

source§

impl AnsiText

source

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

P Widget function that converts PanelFnArgs to widgets.

source§

impl AnsiText

source

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

P Maximum number of lines per page view.

Sets the LINES_PER_PAGE_VAR.

source§

impl AnsiText

source

pub fn widget_new() -> Self

Start building a new instance.

source

pub fn widget_type() -> WidgetType

Gets the widget type info.

source§

impl AnsiText

source

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

P ANSI text.

Methods from Deref<Target = FontMix<TextSpacingMix<ParagraphMix<LangMix<WidgetBase>>>>>§

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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§

source§

impl Deref for AnsiText

source§

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

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for AnsiText

source§

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

Mutably dereferences the value.

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

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>,

source§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T