Struct RadioState 

pub struct RadioState<T = usize>
where
    T: PartialEq + Clone + Default,
{
    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 core: ChoiceCore<T>,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

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

core: ChoiceCore<T>

Core

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse helper read+write

non_exhaustive: NonExhaustive

Implementations

impl<T> RadioState<T>

where T: PartialEq + Clone + Default,

pub fn new() -> Self

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

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn set_default_value(&mut self, default_value: Option<T>)

Set a default-value other than T::default()

The starting value will still be T::default() after this. You must call clear() to use this default.

This default will be overridden by a default set on the widget.

pub fn default_value(&self) -> &Option<T>

A default value.

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

Set the given value.

If the value doesn’t exist in the list or the list is empty the value will still be set, but selected will be None. The list will be empty before the first render, but the first thing render will do is set the list of values. This will adjust the selected index if possible. It’s still ok to set a value here that can not be represented. As long as there is no user interaction, the same value will be returned by value().

pub fn value(&self) -> T

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

pub fn selected(&self) -> Option<usize>

Returns the selected index or None if the value is not in the list or the list is empty.

You can still get the value set with set_value() though.

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

Select the value at index. This will set the value to the given index in the value-list. If the index is out of bounds or the value-list is empty it will set selected to None and leave the value as is. The list is empty before the first render so this may not work as expected.

The selected index is a best effort artefact, the main thing is the value itself.

Use of set_value() is preferred.

pub fn clear(&mut self) -> bool

Set the default value or T::default()

pub fn next(&mut self) -> bool

Select the next item.

pub fn prev(&mut self) -> bool

Select the previous item.

Trait Implementations

impl<T> Clone for RadioState<T>

where T: PartialEq + Clone + Default,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RadioState<T>

where T: PartialEq + Clone + Default + Debug,

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

Formats the value using the given formatter.

impl<T> Default for RadioState<T>

where T: PartialEq + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> HandleEvent<Event, MouseOnly, RadioOutcome> for RadioState<T>

where T: PartialEq + Clone + Default,

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

Handle an event.

impl<T> HandleEvent<Event, Regular, RadioOutcome> for RadioState<T>

where T: PartialEq + Clone + Default,

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

Handle an event.

impl<T> HasFocus for RadioState<T>

where T: PartialEq + Clone + Default,

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

Build the focus-structure for the container.

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

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

where T: PartialEq + Clone + Default,

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

Relocate the areas in this widgets state.

fn relocate_hidden(&mut self)

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