Struct Tooltip 

pub struct Tooltip<Msg> { /* private fields */ }

Wraps widgets and shows a short text next to them after the pointer rests on them for the theme’s motion.hover-delay.

The text is one row on the overlay surface, below the widgets by default. It flips to the other side when there is no room, and moves to another side when it would cover the pointer. It disappears as soon as the pointer leaves. With on_focus it also shows, at once, while keyboard focus is inside. The text fades in over motion.enter.

Style keys: tooltip (bg, fg, padding).

use qframe::prelude::*;
use qframe::widgets::Tooltip;

struct Toolbar;

impl App for Toolbar {
    type Msg = ();
    fn update(&mut self, (): ()) -> Command<()> {
        Command::none()
    }
    fn view(&self, ui: &mut View<'_, ()>) {
        ui.add_with(Tooltip::new("Restart every container"), |ui| {
            ui.add(Button::new("Restart").on_press(()));
        });
    }
}

let mut app = Harness::new(Toolbar, 40, 4);
app.hover(3, 0).advance(std::time::Duration::from_secs(1));
assert!(app.screen().contains("Restart every container"));

Implementations

impl<Msg: 'static> Tooltip<Msg>

pub fn new(text: impl Into<String>) -> Self

A tooltip saying text. Add the widgets it explains with View::add_with.

pub fn placement(self, placement: Placement) -> Self

The preferred side; Placement::Below by default.

pub fn on_focus(self, on_focus: bool) -> Self

Also shows the tooltip while keyboard focus is inside the wrapped widgets.

Trait Implementations

impl<Msg: 'static> Container<Msg> for Tooltip<Msg>

fn set_children(&mut self, children: Vec<Node<Msg>>)

Receives the children built for this widget.

impl<Msg: 'static> Widget<Msg> for Tooltip<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn paint_overlay(&self, cx: &mut PaintCx<'_>, anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.

fn event(&self, _cx: &mut EventCx<'_, Msg>, _event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.