Skip to main content

Text

Struct Text 

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

A line of text.

The text, elide and max_lines change the layout. Color, font, alignment, line height and decorations come from the nearest widget whose Style sets each, starting with the text’s own.

Implementations§

Source§

impl Text

Source

pub fn new(text: impl IntoProp<String>) -> Text

Text showing text: a string, or a closure that returns a String.

Source

pub fn rich(spans: impl IntoProp<Vec<Span>>) -> Text

Text made of styled spans: a Vec<Span>, or a closure that returns one. Each span takes what it doesn’t set from the text, and everything else a Text takes works the same.

Runs handler with a link span’s URL when a left click lands on the span’s glyphs. Over a link the cursor is the pointing hand and the click goes to nothing else, not even a button around the text; elsewhere the text lets the pointer through as before. In a selectable text, a press and release on one link that selected nothing opens it, and a drag selects. Tab stops on each link shown, in text order, and Enter or Space opens the one focused. A link under the pointer or the focus draws underlined, in link_hover_color if set. A handler that panics is logged and disabled, and its links are plain text.

The color a link is drawn in while the pointer is over it or the keyboard focus is on it: a color, None, or a closure returning either. Either way the link is underlined; with None, the default, it keeps its own color.

Source

pub fn selectable(self, selectable: impl IntoProp<bool>) -> Text

When on, the text takes the pointer with an I-beam: a press, a drag, a double click on a word, a triple click on a line and Shift+click select it, as in a text field, and a press takes the keyboard focus, so Ctrl+C copies the selection. Inside a Button, it takes the press, so the button doesn’t click. Tab doesn’t stop on it. Off by default.

Source

pub fn ellipsis(self, ellipsis: impl IntoProp<bool>) -> Text

When on, text that doesn’t fit ends in “…” instead of being cut off. Off by default. The same as elide with Elide::End or Elide::None; whichever is called last wins.

Source

pub fn elide(self, elide: impl IntoProp<Elide>) -> Text

Where text that doesn’t fit is cut, with “…” in its place: Elide::None by default. With max_lines above 1, the last line shown is cut.

Source

pub fn max_lines(self, max_lines: impl IntoProp<u32>) -> Text

Lets the text wrap onto at most this many lines, at word boundaries, or inside a word too long for a line. The default is 1, which never wraps. 0 counts as 1.

Source

pub fn style(self, style: impl IntoProp<Style>) -> Self

Sets the widget’s Style.

Source

pub fn visible(self, visible: impl IntoProp<bool>) -> Self

Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.

Source

pub fn geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is: after each layout that moves or resizes it, its laid-out rectangle in the window’s logical pixels, scrolled with any scroll view around it but not moved by a style’s translate, scale or rotate, is written to geometry. A hidden widget writes nothing. An effect that reads it may change the layout: the window is laid out again at once, until nothing moves.

Source

pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.

Trait Implementations§

Source§

impl Widget for Text

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Text

§

impl !Send for Text

§

impl !Sync for Text

§

impl !UnwindSafe for Text

§

impl Forget for Text

§

impl Freeze for Text

§

impl Move for Text

§

impl Unpin for Text

§

impl UnsafeUnpin 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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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