Struct Tooltip 

pub struct Tooltip<'a, Message, Theme = Theme, Renderer = Renderer>
where
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

An element to display a widget over another.

Example

use iced::widget::{container, tooltip};

enum Message {
    // ...
}

fn view(_state: &State) -> Element<'_, Message> {
    tooltip(
        "Hover me to display the tooltip!",
        container("This is the tooltip contents!")
            .padding(10)
            .style(container::rounded_box),
        tooltip::Position::Bottom,
    ).into()
}

Implementations

impl<'a, Message, Theme, Renderer> Tooltip<'a, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

pub fn new( content: impl Into<Element<'a, Message, Theme, Renderer>>, tooltip: impl Into<Element<'a, Message, Theme, Renderer>>, position: Position, ) -> Self

Creates a new Tooltip.

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

Sets the gap between the content and its Tooltip.

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

Sets the padding of the Tooltip.

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

Sets the delay before the Tooltip is shown.

Set to Duration::ZERO to be shown immediately.

pub fn snap_within_viewport(self, snap: bool) -> Self

Sets whether the Tooltip is snapped within the viewport.

pub fn style(self, style: impl Fn(&Theme) -> Style + 'a) -> Self

where Theme::Class<'a>: From<StyleFn<'a, Theme>>,

Sets the style of the Tooltip.

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

Available on crate feature advanced only.

Sets the style class of the Tooltip.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<Tooltip<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn from( tooltip: Tooltip<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Tooltip<'_, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

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 state(&self) -> State

Returns the State of the Widget.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

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 draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, inherited_style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'b>, renderer: &Renderer, viewport: &Rectangle, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.