Text

Struct Text 

Source
pub struct Text { /* private fields */ }
Expand description

Displays the given text with optional font, size and hinting.

See the hello-world example for how to use it in practice.

§Theming

You can style the text with the following properties:

  • color - The color of the text.
  • color_invert - The color to use when the invert_color property is set to true in the theme Globals.

The WidgetId is equal to maycoon-widgets:Text.

Implementations§

Source§

impl Text

Source

pub fn new(text: impl Into<MaybeSignal<String>>) -> Self

Create a new text widget with the given text.

Source

pub fn with_wrap(self, linebreaks: impl Into<MaybeSignal<bool>>) -> Self

Set whether to wrap the text.

Source

pub fn with_hinting(self, hinting: impl Into<MaybeSignal<bool>>) -> Self

Set the hinting of the text.

Hinting adjusts the display of an outline font so that it lines up with a rasterized grid. At low screen resolutions and font size, hinting can produce clearer text.

Source

pub fn with_font(self, font: impl Into<MaybeSignal<Option<String>>>) -> Self

Set the font of the text.

Source

pub fn with_font_size(self, size: impl Into<MaybeSignal<f32>>) -> Self

Set the font size of the text.

Source

pub fn with_line_gap(self, gap: impl Into<MaybeSignal<f32>>) -> Self

Set the line gap of the text.

The line gap is the space between lines of text. Defaults to 7.5.

Trait Implementations§

Source§

impl Widget for Text

Source§

fn render( &mut self, scene: &mut dyn Scene, theme: &mut dyn Theme, layout_node: &LayoutNode, info: &AppInfo, _: AppContext, )

Render the widget to the canvas.
Source§

fn layout_style(&self) -> StyleNode

Return the layout style node for layout computation.
Source§

fn update(&mut self, layout: &LayoutNode, _: AppContext, _: &AppInfo) -> Update

Update the widget state with given info and layout. Returns if the app should be updated.
Source§

fn widget_id(&self) -> WidgetId

Return the widget id.
Source§

impl WidgetLayoutExt for Text

Source§

fn set_layout_style( &mut self, layout_style: impl Into<MaybeSignal<LayoutStyle>>, )

Sets the layout style of the widget.
Source§

fn with_layout_style( self, layout_style: impl Into<MaybeSignal<LayoutStyle>>, ) -> Self
where Self: Sized,

Sets the layout style of the widget and returns self.

Auto Trait Implementations§

§

impl Freeze for Text

§

impl !RefUnwindSafe for Text

§

impl !Send for Text

§

impl !Sync for Text

§

impl Unpin for Text

§

impl !UnwindSafe for Text

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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