Struct CheckboxState 

pub struct CheckboxState {
    pub area: Rect,
    pub inner: Rect,
    pub check_area: Rect,
    pub text_area: Rect,
    pub behave_check: CheckboxCheck,
    pub checked: bool,
    pub default: bool,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State.

Fields

area: Rect

Complete area read only. renewed for each render.

inner: Rect

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

check_area: Rect

Area of the check mark. read only. renewed for each render.

text_area: Rect

Area for the text. read only. renewed for each render.

behave_check: CheckboxCheck

Behaviour for check. read only. renewed for each render.

checked: bool

Checked state. read+write

default: bool

Default state. read+write Maybe overriden by a default set for the widget.

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse helper read+write

non_exhaustive: NonExhaustive

Implementations

impl CheckboxState

pub fn new() -> Self

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

pub fn checked(&self) -> bool

Get the value.

pub fn set_checked(&mut self, checked: bool) -> bool

Set the value.

pub fn default_(&self) -> bool

Get the default value.

pub fn set_default(&mut self, default: bool) -> bool

Set the default value.

pub fn value(&self) -> bool

Get the checked value, disregarding of the default state.

pub fn set_value(&mut self, checked: bool) -> bool

Set checked value. Always sets default to false.

pub fn clear(&mut self)

Reset to default.

pub fn flip_checked(&mut self)

Flip the checkbox. If it was in default state it just switches off the default flag. Otherwise, it flips true/false.

Trait Implementations

impl Clone for CheckboxState

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 CheckboxState

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

Formats the value using the given formatter.

impl Default for CheckboxState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, CheckOutcome> for CheckboxState

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

Handle an event.

impl HandleEvent<Event, Regular, CheckOutcome> for CheckboxState

fn handle(&mut self, event: &Event, _qualifier: Regular) -> CheckOutcome

Handle an event.

impl HasFocus for CheckboxState

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

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the focus flag.

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.

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

Does this widget have the focus. Or, if the flag is used for a container, does any of widget inside the container have the focus.

fn lost_focus(&self) -> bool

This widget just lost the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn gained_focus(&self) -> bool

This widget just gained the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn has_mouse_focus(&self) -> bool

This flag is set by [Focus::handle], if a mouse-event matches one of the areas associated with a widget.

impl HasScreenCursor for CheckboxState

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

This returns the cursor position if

impl RelocatableState for CheckboxState

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).