Struct ChoiceState 

pub struct ChoiceState<T = usize>
where
    T: PartialEq + Clone + Default,
{

    pub area: Rect,
    pub nav_char: Vec<Vec<char>>,
    pub item_area: Rect,
    pub button_area: Rect,
    pub item_areas: Vec<Rect>,
    pub core: ChoiceCore<T>,
    pub popup: PopupCoreState,
    pub popup_scroll: ScrollState,
    pub behave_focus: Rc<Cell<ChoiceFocus>>,
    pub behave_select: ChoiceSelect,
    pub behave_close: ChoiceClose,
    pub focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State.

Fields

area: Rect

Total area. read only. renewed with each render.

nav_char: Vec<Vec<char>>

First char of each item for navigation. read only. renewed with each render.

item_area: Rect

Item area in the main widget. read only. renewed with each render.

button_area: Rect

Button area in the main widget. read only. renewed with each render.

item_areas: Vec<Rect>

Visible items in the popup. read only. renewed with each render.

core: ChoiceCore<T>

Core

popup: PopupCoreState

Popup state.

popup_scroll: ScrollState

Popup scroll state.

behave_focus: Rc<Cell<ChoiceFocus>>

Behaviour for opening the choice popup.

behave_select: ChoiceSelect

Behaviour for selecting from the choice popup. read only renewed with each render.

behave_close: ChoiceClose

Behaviour for closing the choice popup. read only renewed with each render.

focus: FocusFlag

Focus flag. read+write

mouse: MouseFlags

Mouse util.

non_exhaustive: NonExhaustive

Implementations

impl<T> ChoiceState<T>

where T: PartialEq + Clone + Default,

pub fn new() -> Self

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

pub fn is_popup_active(&self) -> bool

Popup is active?

pub fn flip_popup_active(&mut self)

Flip the popup state.

pub fn set_popup_active(&mut self, active: bool) -> bool

Show the popup.

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

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

pub fn clear(&mut self) -> bool

Select the default value or T::default.

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 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 is_empty(&self) -> bool

Any items?

pub fn len(&self) -> usize

Number of items.

pub fn clear_offset(&mut self)

Scroll offset for the item list.

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

Scroll offset for the item list.

pub fn offset(&self) -> usize

Scroll offset for the item list.

pub fn max_offset(&self) -> usize

Scroll offset for the item list.

pub fn page_len(&self) -> usize

Page length for the item list.

pub fn scroll_by(&self) -> usize

Scroll unit for the item list.

pub fn scroll_to_selected(&mut self) -> bool

Scroll the item list to the selected value.

impl<T> ChoiceState<T>

where T: PartialEq + Clone + Default,

pub fn select_by_char(&mut self, c: char) -> bool

Select by first character.

pub fn reverse_select_by_char(&mut self, c: char) -> bool

Select by first character. Reverse direction

pub fn move_to(&mut self, n: usize) -> ChoiceOutcome

Select at position

pub fn move_down(&mut self, n: usize) -> ChoiceOutcome

Select next entry.

pub fn move_up(&mut self, n: usize) -> ChoiceOutcome

Select prev entry.

Trait Implementations

impl<T> Clone for ChoiceState<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 ChoiceState<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 ChoiceState<T>

where T: PartialEq + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialEq + Clone + Default> HandleEvent<Event, MouseOnly, ChoiceOutcome> for ChoiceState<T>

fn handle(&mut self, event: &Event, _qualifier: MouseOnly) -> ChoiceOutcome

Handle an event.

impl<T: PartialEq + Clone + Default> HandleEvent<Event, Popup, ChoiceOutcome> for ChoiceState<T>

fn handle(&mut self, event: &Event, _qualifier: Popup) -> ChoiceOutcome

Handle an event.

impl<T> HasFocus for ChoiceState<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 ChoiceState<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).