Text

Struct Text 

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

A bunch of text.

§Example

use iced_selection::text;

enum Message {
    // ...
}

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

Implementations§

Source§

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

Source

pub fn new(fragment: impl IntoFragment<'a>) -> Self

Create a new fragment of Text with the given contents.

Source

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the size of the Text.

Source

pub fn line_height(self, line_height: impl Into<LineHeight>) -> Self

Sets the [LineHeight] of the Text.

Source

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

Sets the [Font] of the Text.

Source

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

Sets the width of the Text boundaries.

Source

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

Sets the height of the Text boundaries.

Source

pub fn center(self) -> Self

Centers the Text, both horizontally and vertically.

Source

pub fn align_x(self, alignment: impl Into<Alignment>) -> Self

Sets the [alignment::Horizontal] of the Text.

Source

pub fn align_y(self, alignment: impl Into<Vertical>) -> Self

Sets the [alignment::Vertical] of the Text.

Source

pub fn shaping(self, shaping: Shaping) -> Self

Sets the [Shaping] strategy of the Text.

Source

pub fn wrapping(self, wrapping: Wrapping) -> Self

Sets the [Wrapping] strategy of the Text.

Source

pub fn style(self, style: impl Fn(&Theme) -> Style + 'a) -> Self
where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the Text.

Source

pub fn class(self, class: impl Into<Theme::Class<'a>>) -> Self

Sets the style class of the Text.

Trait Implementations§

Source§

impl<'a, Theme, Renderer> From<&'a str> for Text<'a, Theme, Renderer>
where Theme: Catalog + 'a, Renderer: Renderer<Paragraph = Paragraph, Font = Font> + 'a,

Source§

fn from(content: &'a str) -> Self

Converts to this type from the input type.
Source§

impl<'a, Message, Theme, Renderer> From<Text<'a, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
where Theme: Catalog + 'a, Renderer: Renderer<Paragraph = Paragraph, Font = Font> + 'a,

Source§

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

Converts to this type from the input type.
Source§

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Text<'_, Theme, Renderer>
where Theme: Catalog, Renderer: Renderer<Paragraph = Paragraph, Font = Font>,

Source§

fn tag(&self) -> Tag

Returns the Tag of the [Widget].
Source§

fn state(&self) -> State

Returns the State of the [Widget].
Source§

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

Returns the [Size] of the [Widget] in lengths.
Source§

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

Returns the [layout::Node] of the [Widget]. Read more
Source§

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

Processes a runtime [Event]. Read more
Source§

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.
Source§

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

Applies an [Operation] to the [Widget].
Source§

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

Returns the current [mouse::Interaction] of the [Widget]. Read more
§

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

Returns a [Size] hint for laying out the [Widget]. Read more
§

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 overlay<'a>( &'a mut self, _tree: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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

Auto Trait Implementations§

§

impl<'a, Theme, Renderer> Freeze for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Freeze, <Renderer as Renderer>::Font: Freeze,

§

impl<'a, Theme, Renderer> RefUnwindSafe for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: RefUnwindSafe, <Renderer as Renderer>::Font: RefUnwindSafe,

§

impl<'a, Theme, Renderer> Send for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Send, <Renderer as Renderer>::Font: Send,

§

impl<'a, Theme, Renderer> Sync for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Sync, <Renderer as Renderer>::Font: Sync,

§

impl<'a, Theme, Renderer> Unpin for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Unpin, <Renderer as Renderer>::Font: Unpin,

§

impl<'a, Theme, Renderer> UnwindSafe for Text<'a, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: UnwindSafe, <Renderer as Renderer>::Font: UnwindSafe,

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,