Struct Text

pub struct Text<S> {
    pub text: S,
    /* private fields */
}

A string that can render over multiple lines.

If you need to render a single line of text or you don’t want the text to wrap, use the Widget implementation on str.

Fields

text: S

The text to render.

If this is changed, the updated text is not guaranteed to be rendered. If the text is changed, force_recompute should be called.

Implementations

impl<S: AsRef<str>> Text<S>

pub fn new(text: S) -> Self

Creates a new Text

pub fn force_recompute(&mut self)

The computed lines are cached between renders, and are only recomputed if the layout changes. This will force a recomputation even if the layout is the same. This is useful if you need to change the text.

Trait Implementations

impl<S: AsRef<str>> AsRef<str> for Text<S>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: Clone> Clone for Text<S>

fn clone(&self) -> Text<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Text<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: AsRef<str>> From<S> for Text<S>

fn from(text: S) -> Self

Converts to this type from the input type.

impl<S: PartialEq> PartialEq for Text<S>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: AsRef<str>> Widget for Text<S>

fn render<B: Backend>( &mut self, layout: &mut Layout, backend: &mut B, ) -> Result<()>

Renders the Text moving to the next line after its done. This can trigger a recomputation. In case the text cannot be fully rendered, layout.render_region is used to determine the lines which are rendered.

fn height(&mut self, layout: &mut Layout) -> u16

Calculates the height the text will take. This can trigger a recomputation.

fn cursor_pos(&mut self, layout: Layout) -> (u16, u16)

Returns the location of the first character

fn handle_key(&mut self, _: KeyEvent) -> bool

This widget does not handle any events

impl<S: Eq> Eq for Text<S>