Struct thyme::WidgetState

pub struct WidgetState {
    pub visible: bool,
    pub hovered: bool,
    pub pressed: bool,
    pub clicked: bool,
    pub moved: Point,
    pub mouse_button: Option<MouseButton>,
}

The current state of a widget on this frame, this is returned when you finish most widgets, such as with a call to WidgetBuilder.finish.

Example

fn create_button(ui: &mut Frame) {
    let result = ui.button("button", "Click me!");

    if result.clicked {
        println!("Button clicked!");
    }

    if result.hover {
        ui.tooltip("tooltip", "This is a clickable button");
    }
}

Fields

visible: bool

Whether this widget was drawn. In general, if a widget is not visible, any children were not created and closures, such as passed to WidgetBuilder.children were not executed.

hovered: bool

Whether the mouse is hovering over this widget on the current frame

pressed: bool

Whether the mouse is pressed on this widget on the current frame

clicked: bool

Whether the mouse clicked on this widget on the current frame. This field will only be true once per click.

moved: Point

How far the mouse has been dragged or scrolled on this widget, in logical pixels.

mouse_button: Option<MouseButton>

If the mouse was pressed or clicked, which mouse button was used.

Trait Implementations

impl Debug for WidgetState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.