Struct rat_widget::button::ButtonState

pub struct ButtonState {
    pub focus: FocusFlag,
    pub area: Rect,
    pub inner_area: Rect,
    pub armed: bool,
    pub non_exhaustive: NonExhaustive,
}

State data & event-handling.

Fields

focus: FocusFlag

Current focus state.

area: Rect

Complete area

inner_area: Rect

Inner area.

armed: bool

Button has been clicked but not released yet.

non_exhaustive: NonExhaustive

Implementations

impl ButtonState

pub fn new() -> Self

pub fn set_focused(&mut self, focus: bool)

Renders the widget in focused style.

This flag is not used for event-handling.

pub fn is_focused(&mut self) -> bool

Renders the widget in focused style.

This flag is not used for event-handling.

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> ButtonState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ButtonState

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

Formats the value using the given formatter.

impl Default for ButtonState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, FocusKeys, ButtonOutcome> for ButtonState

fn handle(&mut self, event: &Event, _keymap: FocusKeys) -> ButtonOutcome

Handle an event.

impl HandleEvent<Event, MouseOnly, ButtonOutcome> for ButtonState

fn handle(&mut self, event: &Event, _keymap: MouseOnly) -> ButtonOutcome

Handle an event.

impl HasFocusFlag for ButtonState

fn focus(&self) -> &FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Access the area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed areas. This is the case if it is showing a popup, but there might be other causes.

fn navigable(&self) -> bool

If the widget is focusable, but doesn’t want to partake in keyboard navigation it returns false here.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.