Struct iced_native::widget::text::Text

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

A paragraph of text.

Example

Text::new("I <3 iced!")
    .size(40)
    .style(Color::from([0.0, 0.0, 1.0]));

Implementations

impl<'a, Renderer> Text<'a, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,

pub fn new(content: impl Into<Cow<'a, str>>) -> Self

Create a new fragment of Text with the given contents.

pub fn size(self, size: u16) -> Self

Sets the size of the Text.

pub fn font(self, font: impl Into<Renderer::Font>) -> Self

Sets the Font of the Text.

pub fn style(
    self,
    style: impl Into<<Renderer::Theme as StyleSheet>::Style>
) -> Self

Sets the style of the Text.

pub fn width(self, width: Length) -> Self

Sets the width of the Text boundaries.

pub fn height(self, height: Length) -> Self

Sets the height of the Text boundaries.

pub fn horizontal_alignment(self, alignment: Horizontal) -> Self

Sets the alignment::Horizontal of the Text.

pub fn vertical_alignment(self, alignment: Vertical) -> Self

Sets the alignment::Vertical of the Text.

Trait Implementations

impl<'a, Renderer> Clone for Text<'a, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Message, Renderer> From<Text<'a, Renderer>> for Element<'a, Message, Renderer>where
    Renderer: Renderer + 'a,
    Renderer::Theme: StyleSheet,

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

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Text<'a, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

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

Returns the layout::Node of the Widget.

fn draw(
    &self,
    _state: &Tree,
    renderer: &mut Renderer,
    theme: &Renderer::Theme,
    style: &Style,
    layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

fn operate(
    &self,
    _state: &mut Tree,
    _layout: Layout<'_>,
    _operation: &mut dyn Operation<Message>
)

Applies an Operation to the Widget.

fn on_event(
    &mut self,
    _state: &mut Tree,
    _event: Event,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    _state: &Tree,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _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
) -> Option<Element<'a, Message, Renderer>>

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