Struct Rich 

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

A bunch of Rich text.

Implementations

impl<'a, Link, Message, Theme, Renderer> Rich<'a, Link, Message, Theme, Renderer>

where Link: Clone + 'static, Theme: Catalog, Renderer: Renderer, Renderer::Font: 'a,

pub fn new() -> Self

Creates a new empty Rich text.

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

Creates a new Rich text with the given text spans.

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

Sets the default size of the Rich text.

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

Sets the default [LineHeight] of the Rich text.

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

Sets the default font of the Rich text.

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

Sets the width of the Rich text boundaries.

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

Sets the height of the Rich text boundaries.

pub fn center(self) -> Self

Centers the Rich text, both horizontally and vertically.

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

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

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

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

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

Sets the [Wrapping] strategy of the Rich text.

pub fn ellipsis(self, ellipsis: Ellipsis) -> Self

Sets the [Ellipsis] strategy of the Rich text.

pub fn click_interval(self, click_interval: Duration) -> Self

The maximum delay required for two consecutive clicks to be interpreted as a double click (also applies to triple clicks).

Defaults to 300ms.

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

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

If the spans of the Rich text contain no links, you may need to call this method with on_link_click(never) in order for the compiler to infer the proper Link generic type.

pub fn on_link_hover( self, on_link_hovered: impl Fn(Link) -> Message + 'a, ) -> Self

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

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.

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.

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.

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

Sets the default style class of the Rich text.

Trait Implementations

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,

fn default() -> Self

Returns the “default value” for a type.

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,

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

Converts to this type from the input type.

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,

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

Creates a value from an iterator.

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

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( &mut 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: Cursor, viewport: &Rectangle, )

Draws the [Widget] using the associated Renderer.

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

Processes a runtime [Event].

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

Returns the current [mouse::Interaction] of 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 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.