Struct Text

pub struct Text<'a, Theme, Renderer>
where
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

Available on crate feature advanced only.

A bunch of text.

Example

use iced::widget::text;
use iced::color;

enum Message {
    // ...
}

fn view(state: &State) -> Element<'_, Message> {
    text("Hello, this is iced!")
        .size(20)
        .color(color!(0x0000ff))
        .into()
}

Implementations

impl<'a, Theme, Renderer> Text<'a, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

pub fn new(fragment: impl IntoFragment<'a>) -> Text<'a, Theme, Renderer>

Create a new fragment of Text with the given contents.

pub fn size(self, size: impl Into<Pixels>) -> Text<'a, Theme, Renderer>

Sets the size of the Text.

pub fn line_height( self, line_height: impl Into<LineHeight>, ) -> Text<'a, Theme, Renderer>

Sets the LineHeight of the Text.

pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> Text<'a, Theme, Renderer>

Sets the Font of the Text.

pub fn width(self, width: impl Into<Length>) -> Text<'a, Theme, Renderer>

Sets the width of the Text boundaries.

pub fn height(self, height: impl Into<Length>) -> Text<'a, Theme, Renderer>

Sets the height of the Text boundaries.

pub fn center(self) -> Text<'a, Theme, Renderer>

Centers the Text, both horizontally and vertically.

pub fn align_x( self, alignment: impl Into<Horizontal>, ) -> Text<'a, Theme, Renderer>

Sets the alignment::Horizontal of the Text.

pub fn align_y( self, alignment: impl Into<Vertical>, ) -> Text<'a, Theme, Renderer>

Sets the alignment::Vertical of the Text.

pub fn shaping(self, shaping: Shaping) -> Text<'a, Theme, Renderer>

Sets the Shaping strategy of the Text.

pub fn wrapping(self, wrapping: Wrapping) -> Text<'a, Theme, Renderer>

Sets the Wrapping strategy of the Text.

pub fn style( self, style: impl Fn(&Theme) -> Style + 'a, ) -> Text<'a, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the style of the Text.

pub fn color(self, color: impl Into<Color>) -> Text<'a, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the Color of the Text.

pub fn color_maybe( self, color: Option<impl Into<Color>>, ) -> Text<'a, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the Color of the Text, if Some.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Text<'a, Theme, Renderer>

Sets the style class of the Text.

Trait Implementations

impl<'a, Theme, Renderer> From<&'a str> for Text<'a, Theme, Renderer>

where Theme: Catalog + 'a, Renderer: Renderer,

fn from(content: &'a str) -> Text<'a, Theme, Renderer>

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> From<Text<'a, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn from( text: Text<'a, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Text<'_, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &Style, layout: Layout<'_>, _cursor_position: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn operate( &self, _state: &mut Tree, layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn update( &mut self, _state: &mut Tree, _event: Event, _layout: Layout<'_>, _cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, _shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.