Rich

Struct Rich 

Source
pub struct Rich<'a, Link, Message, Theme = Theme, Renderer = Renderer>
where Link: Clone + 'static, Theme: Catalog, Renderer: Renderer,
{ /* private fields */ }
Expand description

A bunch of Rich text.

Implementations§

Source§

impl<'a, Link, Message, Theme, Renderer> Rich<'a, Link, Message, Theme, Renderer>
where Link: Clone + 'static, Theme: Catalog, Renderer: Renderer, Renderer::Font: 'a,

Source

pub fn new() -> Self

Creates a new empty Rich text.

Source

pub fn with_spans( spans: impl AsRef<[Span<'a, Link, Renderer::Font>]> + 'a, ) -> Self

Creates a new Rich text with the given text spans.

Source

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

Sets the default size of the Rich text.

Source

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

Sets the default [LineHeight] of the Rich text.

Source

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

Sets the default font of the Rich text.

Source

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

Sets the width of the Rich text boundaries.

Source

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

Sets the height of the Rich text boundaries.

Source

pub fn center(self) -> Self

Centers the Rich text, both horizontally and vertically.

Source

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

Sets the [alignment::Horizontal] of the Rich text.

Source

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

Sets the [alignment::Vertical] of the Rich text.

Source

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

Sets the [Wrapping] strategy of the Rich text.

Sets the message that will be produced when a link of the Rich text is clicked.

Sets the message that will be produced when a link of the Rich text is hovered.

Source

pub fn on_hover_lost(self, on_hover_lost: Message) -> Self
where Message: Clone + 'a,

Sets the message that will be produced when a link of the Rich text is no longer hovered.

Source

pub fn on_hover_lost_with( self, on_hover_lost: impl Fn() -> Message + 'a, ) -> Self

Sets the message that will be produced when a link of the Rich text is no longer hovered.

Source

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

Sets the default style of the Rich text.

Source

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

Sets the default style class of the Rich text.

Trait Implementations§

Source§

impl<'a, Link, Message, Theme, Renderer> Default for Rich<'a, Link, Message, Theme, Renderer>
where Link: Clone + 'a, Theme: Catalog, Renderer: Renderer<Paragraph = Paragraph, Font = Font>, Renderer::Font: 'a,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<'a, Link, Message, Theme, Renderer> FromIterator<Span<'a, Link, <Renderer as Renderer>::Font>> for Rich<'a, Link, Message, Theme, Renderer>
where Link: Clone + 'a, Theme: Catalog, Renderer: Renderer<Paragraph = Paragraph, Font = Font>, Renderer::Font: 'a,

Source§

fn from_iter<T: IntoIterator<Item = Span<'a, Link, Renderer::Font>>>( spans: T, ) -> Self

Creates a value from an iterator. Read more
Source§

impl<Link, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Rich<'_, Link, Message, Theme, Renderer>
where Link: Clone + 'static, 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 draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &Style, layout: Layout<'_>, _cursor: Cursor, viewport: &Rectangle, )

Draws the [Widget] using the associated Renderer.
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 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 operate( &mut self, _tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

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

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, Link, Message, Theme, Renderer> Freeze for Rich<'a, Link, Message, Theme, Renderer>
where <Theme as Catalog>::Class<'a>: Freeze, <Renderer as Renderer>::Font: Freeze,

§

impl<'a, Link, Message, Theme = Theme, Renderer = ()> !RefUnwindSafe for Rich<'a, Link, Message, Theme, Renderer>

§

impl<'a, Link, Message, Theme = Theme, Renderer = ()> !Send for Rich<'a, Link, Message, Theme, Renderer>

§

impl<'a, Link, Message, Theme = Theme, Renderer = ()> !Sync for Rich<'a, Link, Message, Theme, Renderer>

§

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

§

impl<'a, Link, Message, Theme = Theme, Renderer = ()> !UnwindSafe for Rich<'a, Link, Message, Theme, Renderer>

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.