Skip to main content

Rich

Struct Rich 

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

A bunch of Rich text.

Implementations§

Source§

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

Source

pub fn new() -> Self

Creates a new empty Rich text.

Source

pub fn with_spans(spans: impl AsRef<[Span<'a, Link>]> + '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<Font>) -> Self

Sets the default font of the Rich text.

Source

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

Sets the default font of the Rich text, if Some.

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.

Source

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

Sets the Ellipsis strategy of the Rich text.

Source

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.

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.

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> Default for Rich<'a, Link, Message, Theme>
where Link: Clone + 'a, Theme: Catalog,

Source§

fn default() -> Self

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

impl<'a, Link, Message, Theme> FromIterator<Span<'a, Link>> for Rich<'a, Link, Message, Theme>
where Link: Clone + 'a, Theme: Catalog,

Source§

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

Creates a value from an iterator. Read more
Source§

impl<Link, Message, Theme> Meta for Rich<'_, Link, Message, Theme>
where Link: Clone + 'static, Theme: Catalog,

Source§

fn is_void(&self) -> bool

Returns whether the Widget is Void.
Source§

impl<Link, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Rich<'_, Link, Message, Theme>
where Link: Clone + 'static, Theme: Catalog, Renderer: Renderer<Paragraph = Paragraph>,

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)

Lays out 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, 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
Source§

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

Reconciles the Widget with the provided Tree.
Source§

fn operate( &mut self, _tree: &mut Tree, _layout: Layout, _viewport: &Rectangle, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.
Source§

fn overlay<'a>( &'a mut self, _tree: &'a mut Tree, _layout: Layout, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, _window: Size, ) -> Vec<Element<'a, Message, Theme, Renderer>>

Returns the overlays of the Widget.
Source§

fn _map<F, B>(self, f: F) -> Map<Self, F, Message>
where Self: Sized, F: Fn(Message) -> B,

Applies a transformation to the produced message of this Widget, returning a Map. Read more
Source§

fn _boxed<'a>(self) -> Element<'a, Message, Theme, Renderer>
where Self: Sized + 'a,

Boxes this Widget, turning it into a generic Element.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<'a, Link, Message, Theme> Freeze for Rich<'a, Link, Message, Theme>
where Box<dyn AsRef<[Span<'a, Link>]> + 'a>: Freeze, <Theme as Catalog>::Class<'a>: Freeze, Option<Box<dyn Fn(Link) -> Message + 'a>>: Freeze, Option<Box<dyn Fn() -> Message + 'a>>: Freeze,

§

impl<'a, Link, Message, Theme> Unpin for Rich<'a, Link, Message, Theme>
where Box<dyn AsRef<[Span<'a, Link>]> + 'a>: Unpin, <Theme as Catalog>::Class<'a>: Unpin, Option<Box<dyn Fn(Link) -> Message + 'a>>: Unpin, Option<Box<dyn Fn() -> Message + 'a>>: Unpin,

§

impl<'a, Link, Message, Theme> UnsafeUnpin for Rich<'a, Link, Message, Theme>
where Box<dyn AsRef<[Span<'a, Link>]> + 'a>: UnsafeUnpin, <Theme as Catalog>::Class<'a>: UnsafeUnpin, Option<Box<dyn Fn(Link) -> Message + 'a>>: UnsafeUnpin, Option<Box<dyn Fn() -> Message + 'a>>: UnsafeUnpin,

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for T
where T: Widget<Message, Theme, Renderer>,

Source§

fn map<F, B>(self, f: F) -> Map<Self, F, Message>
where Self: Sized, F: Fn(Message) -> B,

Applies a transformation to the produced message of this Widget. Read more
Source§

fn boxed<'a>(self) -> Element<'a, Message, Theme, Renderer>
where Self: Sized + 'a,

Boxes this Widget, turning it into a generic Element.
Source§

fn explain( self, color: impl Into<Color>, ) -> impl Widget<Message, Theme, Renderer>
where Self: Sized, Renderer: Renderer,

Marks this Widget as to-be-explained. Read more