Struct IconButton 

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

A button that is one icon: a space, the glyph and a space, three cells in every glyph mode.

It stands on the ground around it, with no raised surface, so a row of them reads as quiet marks rather than as buttons with labels. The pointer lightens all three cells, keyboard focus lightens them one step further, and a press flashes them one step more; there is no pillar, because three cells have no room for one before the glyph. Enter or Space while focused, or a click released over it, sends its message, like a Button.

Its meaning is only the glyph, so give it a tooltip: the words show below it after the pointer rests on it for the theme’s hover delay, and at once when it is reached with the keyboard.

Style keys: icon-button (fg, bg, bold) with states hover, focus, pressed and disabled; tooltip for its words.

use qframe::prelude::*;
use qframe::widgets::IconButton;

struct Header;

impl App for Header {
    type Msg = ();
    fn update(&mut self, (): ()) -> Command<()> {
        Command::none()
    }
    fn view(&self, ui: &mut View<'_, ()>) {
        ui.row(|ui| {
            ui.add(Text::new("Packages")).fill_width();
            ui.add(IconButton::new("settings").tooltip("Settings").on_press(()));
        })
        .fill_width();
    }
}

let app = Harness::new(Header, 20, 1);
let glyph = app.env().icons().glyph("settings").into_owned();
assert_eq!(app.find(&glyph), Some((18, 0)), "a space, the glyph and a space at the end");

Implementations

impl<Msg> IconButton<Msg>

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

A button showing the icon key of the icon set, such as "settings" or "close".

pub fn on_press(self, message: Msg) -> Self

The message sent when the button is pressed.

pub fn tooltip(self, text: impl Into<String>) -> Self

Words that say what the button does, shown below it after the hover delay and at once when it is reached with the keyboard.

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

Greys the button out; it cannot be focused or pressed.

Trait Implementations

impl<Msg: Clone + 'static> Widget<Msg> for IconButton<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 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.

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.