Struct iced_core::widget::text::Text

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

A paragraph of text.

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 horizontal_alignment(self, alignment: Horizontal) -> Self

Sets the alignment::Horizontal of the Text.

source

pub fn vertical_alignment(self, alignment: 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 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 color(self, color: impl Into<Color>) -> Self
where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the Color of the Text.

source

pub fn color_maybe(self, color: Option<impl Into<Color>>) -> Self
where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the Color of the Text, if Some.

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,

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 + 'a,

source§

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

Converts to this type from the input type.
source§

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

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(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget. 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 size_hint(&self) -> Size<Length>

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

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

Returns the state Tree of the children of the Widget.
source§

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

Reconciliates the Widget with the provided Tree.
source§

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

Applies an Operation to the Widget.
source§

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

Processes a runtime Event. Read more
source§

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

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

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.

Auto Trait Implementations§

§

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<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar> ) -> T

Converts self into C, using the provided parameters.
source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoAngle<U> for T
where U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar> ) -> T

Converts self into C, using the provided parameters.
source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more