Struct RadioState

pub struct RadioState<T = usize>
where
    T: PartialEq,
{
    pub area: Rect,
    pub inner: Rect,
    pub marker_area: Rect,
    pub continue_area: Rect,
    pub check_areas: Vec<Rect>,
    pub text_areas: Vec<Rect>,
    pub keys: Vec<T>,
    pub default_key: Option<T>,
    pub selected: usize,
    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.

marker_area: Rect

Area for the focus marker. read only. renewed for each render.

continue_area: Rect

Area for a continue marker. This is displayed if not all items can be displayed.

check_areas: Vec<Rect>

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

text_areas: Vec<Rect>

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

keys: Vec<T>

Keys. read only. renewed for each render.

default_key: Option<T>

Can return to default with a user interaction.

selected: usize

Selected state.

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse helper read+write

non_exhaustive: NonExhaustive

Implementations

impl<T> RadioState<T>

where T: PartialEq,

pub fn new() -> Self

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

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn selected(&self) -> usize

pub fn select(&mut self, select: usize) -> bool

pub fn set_default_value(&mut self) -> bool

Set the default value.

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

where T: PartialEq,

Select the given value.

pub fn value_ref(&self) -> &T

Get the selected value or None if no value is selected or there are no options.

pub fn next(&mut self) -> bool

pub fn prev(&mut self) -> bool

impl<T> RadioState<T>

where T: PartialEq + Clone,

pub fn value(&self) -> T

Get the selected value or None if no value is selected or there are no options.

Trait Implementations

impl<T> Clone for RadioState<T>

where T: Clone + PartialEq,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RadioState<T>

where T: PartialEq + Debug,

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

Formats the value using the given formatter.

impl<T: PartialEq> Default for RadioState<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialEq> HandleEvent<Event, MouseOnly, Outcome> for RadioState<T>

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

Handle an event.

impl<T: PartialEq> HandleEvent<Event, Regular, Outcome> for RadioState<T>

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

Handle an event.

impl<T: PartialEq> HasFocus for RadioState<T>

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

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

Build the focus-structure for the container.

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<T: PartialEq> RelocatableState for RadioState<T>

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

Relocate the areas in this widgets state.