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 theinvert_colorproperty is set totruein the theme Globals.
The WidgetId is equal to maycoon-widgets:Text.
Implementations§
Source§impl Text
impl Text
Sourcepub fn new(text: impl Into<MaybeSignal<String>>) -> Self
pub fn new(text: impl Into<MaybeSignal<String>>) -> Self
Create a new text widget with the given text.
Sourcepub fn with_wrap(self, linebreaks: impl Into<MaybeSignal<bool>>) -> Self
pub fn with_wrap(self, linebreaks: impl Into<MaybeSignal<bool>>) -> Self
Set whether to wrap the text.
Sourcepub fn with_hinting(self, hinting: impl Into<MaybeSignal<bool>>) -> Self
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.
Sourcepub fn with_font(self, font: impl Into<MaybeSignal<Option<String>>>) -> Self
pub fn with_font(self, font: impl Into<MaybeSignal<Option<String>>>) -> Self
Set the font of the text.
Sourcepub fn with_font_size(self, size: impl Into<MaybeSignal<f32>>) -> Self
pub fn with_font_size(self, size: impl Into<MaybeSignal<f32>>) -> Self
Set the font size of the text.
Sourcepub fn with_line_gap(self, gap: impl Into<MaybeSignal<f32>>) -> Self
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
impl Widget for Text
Source§fn render(
&mut self,
scene: &mut dyn Scene,
theme: &mut dyn Theme,
layout_node: &LayoutNode,
info: &AppInfo,
_: AppContext,
)
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
fn layout_style(&self) -> StyleNode
Return the layout style node for layout computation.
Source§fn update(&mut self, layout: &LayoutNode, _: AppContext, _: &AppInfo) -> Update
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§impl WidgetLayoutExt for Text
impl WidgetLayoutExt for Text
Source§fn set_layout_style(
&mut self,
layout_style: impl Into<MaybeSignal<LayoutStyle>>,
)
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>>,
) -> Selfwhere
Self: Sized,
fn with_layout_style(
self,
layout_style: impl Into<MaybeSignal<LayoutStyle>>,
) -> Selfwhere
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.