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, ) -> Tooltip<'a, Message, Theme, Renderer>

Creates a new Tooltip.

pub fn gap( self, gap: impl Into<Pixels>, ) -> Tooltip<'a, Message, Theme, Renderer>

Sets the gap between the content and its Tooltip.

pub fn padding( self, padding: impl Into<Pixels>, ) -> Tooltip<'a, Message, Theme, Renderer>

Sets the padding of the Tooltip.

pub fn snap_within_viewport( self, snap: bool, ) -> Tooltip<'a, Message, Theme, Renderer>

Sets whether the Tooltip is snapped within the viewport.

pub fn style( self, style: impl Fn(&Theme) -> Style + 'a, ) -> Tooltip<'a, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the style of the Tooltip.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Tooltip<'a, Message, Theme, Renderer>

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<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Tooltip<'a, Message, Theme, Renderer>

where Theme: Catalog, Renderer: Renderer,

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

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 diff(&mut self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

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

Returns the layout::Node of the Widget.

fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> Status

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<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

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

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, _id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.