Struct ButtonState 

pub struct ButtonState {
    pub area: Rect,
    pub inner: Rect,
    pub armed: bool,
    pub armed_delay: Option<Duration>,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event-handling.

Fields

area: Rect

Complete area read only. renewed for each render.

inner: Rect

Area inside the block. read only. renewed for each render.

armed: bool

Button has been clicked but not released yet. read only

armed_delay: Option<Duration>

Some terminals repaint too fast to see the click. This adds some delay when the button state goes from armed to clicked.

Default is 50ms. read+write

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse interaction. read only

non_exhaustive: NonExhaustive

Implementations

impl ButtonState

pub fn new() -> Self

pub fn named(name: &str) -> Self

pub fn clear_areas(&mut self)

👎Deprecated since 2.1.0: use relocate_hidden() to clear the areas.

impl ButtonState

pub fn pressed(&mut self, is_pressed: bool) -> ButtonOutcome

Simulates the button-press event.

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> Self

Returns a duplicate 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, KeyEvent, ButtonOutcome> for ButtonState

Check event-handling for this hot-key and do Regular key-events otherwise.

fn handle(&mut self, event: &Event, hotkey: KeyEvent) -> ButtonOutcome

Handle an event.

impl HandleEvent<Event, MouseOnly, ButtonOutcome> for ButtonState

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

Handle an event.

impl HandleEvent<Event, Regular, ButtonOutcome> for ButtonState

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

Handle an event.

impl HasFocus for ButtonState

fn build(&self, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget. This is called when the default navigation will be overridden by the builder.

fn id(&self) -> usize

Provide a unique id for the widget.

fn area_z(&self) -> u16

Z value for the area.

fn navigable(&self) -> Navigation

Declares how the widget interacts with focus.

fn is_focused(&self) -> bool

Focused?

fn lost_focus(&self) -> bool

Just lost focus.

fn gained_focus(&self) -> bool

Just gained focus.

impl HasScreenCursor for ButtonState

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl RelocatableState for ButtonState

fn relocate(&mut self, shift: (i16, i16), clip: Rect)

Relocate the areas in this widgets state.

fn relocate_popup(&mut self, shift: (i16, i16), clip: Rect)

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).