Struct Tooltip

pub struct Tooltip<V> {Show 17 fields
    pub content: Pod<V>,
    pub text: SmolStr,
    pub delay: Option<f32>,
    pub padding: Option<Padding>,
    pub font_size: Option<f32>,
    pub font_family: Option<FontFamily>,
    pub font_weight: Option<FontWeight>,
    pub font_stretch: Option<FontStretch>,
    pub font_style: Option<FontStyle>,
    pub color: Option<Color>,
    pub align: Option<TextAlign>,
    pub line_height: Option<f32>,
    pub wrap: Option<TextWrap>,
    pub background: Option<Color>,
    pub border_radius: Option<BorderRadius>,
    pub border_width: Option<BorderWidth>,
    pub border_color: Option<Color>,
}

Expand description

A view that displays some text when the content is hovered.

Can be styled using the TooltipStyle.

Fields§

§content: Pod<V>

The content to display.

§text: SmolStr

The text to display.

§delay: Option<f32>

The delay before the tooltip is displayed.

§padding: Option<Padding>

The padding of the text.

§font_size: Option<f32>

The font size of the text.

§font_family: Option<FontFamily>

The font family of the text.

§font_weight: Option<FontWeight>

The font weight of the text.

§font_stretch: Option<FontStretch>

The font stretch of the text.

§font_style: Option<FontStyle>

The font style of the text.

§color: Option<Color>

The color of text.

§align: Option<TextAlign>

The horizontal alignment of the text.

§line_height: Option<f32>

The line height of the text.

§wrap: Option<TextWrap>

The text wrap of the text.

§background: Option<Color>

The background color of the text.

§border_radius: Option<BorderRadius>

The border radius of the text.

§border_width: Option<BorderWidth>

The border width of the text.

§border_color: Option<Color>

The border color of the text.

Implementations§

impl<V> Tooltip<V>

pub fn new(content: V, text: impl Into<SmolStr>) -> Tooltip<V>

Create a new tooltip view.

Trait Implementations§

impl<V> Rebuild for Tooltip<V>

fn rebuild(&self, cx: &mut RebuildCx<'_, '_>, old: &Tooltip<V>)

Rebuild the view.

impl<V> Stylable for Tooltip<V>

type Style = TooltipStyle

The style type.

fn style( &self, style: &<Tooltip<V> as Stylable>::Style, ) -> <Tooltip<V> as Stylable>::Style

Style the object. Read more

fn rebuild_style(&self, cx: &mut RebuildCx<'_, '_>, style: &mut Self::Style)
where Self::Style: Rebuild + 'static,

Rebuild the style of the object.

impl<T, V> View<T> for Tooltip<V>
where V: View<T>,

type State = (TooltipState, PodState<T, V>)

The state of the view, see top-level documentation for more information.

fn build( &mut self, cx: &mut BuildCx<'_, '_>, data: &mut T, ) -> <Tooltip<V> as View<T>>::State

Build the view state, see top-level documentation for more information.

fn rebuild( &mut self, _: &mut <Tooltip<V> as View<T>>::State, cx: &mut RebuildCx<'_, '_>, data: &mut T, old: &Tooltip<V>, )

Rebuild the view state, see top-level documentation for more information.

fn event( &mut self, _: &mut <Tooltip<V> as View<T>>::State, cx: &mut EventCx<'_, '_>, data: &mut T, event: &Event, ) -> bool

Handle an event, see top-level documentation for more information.

fn layout( &mut self, _: &mut <Tooltip<V> as View<T>>::State, cx: &mut LayoutCx<'_, '_>, data: &mut T, space: Space, ) -> Size

Layout the view, see top-level documentation for more information.

fn draw( &mut self, _: &mut <Tooltip<V> as View<T>>::State, cx: &mut DrawCx<'_, '_>, data: &mut T, )

Draw the view, see top-level documentation for more information.

Auto Trait Implementations§

impl<V> Freeze for Tooltip<V>
where V: Freeze,

impl<V> RefUnwindSafe for Tooltip<V>
where V: RefUnwindSafe,

impl<V> Send for Tooltip<V>
where V: Send,

impl<V> Sync for Tooltip<V>
where V: Sync,

impl<V> Unpin for Tooltip<V>
where V: Unpin,

impl<V> UnwindSafe for Tooltip<V>
where V: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, V> AnyView<T> for V
where V: View<T> + Any, <V as View<T>>::State: Any,

fn as_any(&self) -> &(dyn Any + 'static)

Get a reference to the underlying Any object.

fn dyn_build(&mut self, cx: &mut BuildCx<'_, '_>, data: &mut T) -> Box<dyn Any>

Build the view.

fn dyn_rebuild( &mut self, state: &mut Box<dyn Any>, cx: &mut RebuildCx<'_, '_>, data: &mut T, old: &dyn AnyView<T>, )

Rebuild the view.

fn dyn_event( &mut self, state: &mut Box<dyn Any>, cx: &mut EventCx<'_, '_>, data: &mut T, event: &Event, ) -> bool

Handle an event.

fn dyn_layout( &mut self, state: &mut Box<dyn Any>, cx: &mut LayoutCx<'_, '_>, data: &mut T, space: Space, ) -> Size

Calculate the layout.

fn dyn_draw( &mut self, state: &mut Box<dyn Any>, cx: &mut DrawCx<'_, '_>, data: &mut T, )

Draw the view.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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