Struct ChoiceState

pub struct ChoiceState<T = usize>
where
    T: PartialEq,
{
    pub area: Rect,
    pub nav_char: Vec<Vec<char>>,
    pub keys: Vec<T>,
    pub item_area: Rect,
    pub button_area: Rect,
    pub item_areas: Vec<Rect>,
    pub selected: usize,
    pub popup: PopupCoreState,
    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.

keys: Vec<T>

Key for each item. 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.

selected: usize

Select item. read+write

popup: PopupCoreState

Popup state.

focus: FocusFlag

Focus flag. read+write

mouse: MouseFlags

Mouse util.

non_exhaustive: NonExhaustive

Implementations

impl<T> ChoiceState<T>

where T: PartialEq,

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_value(&mut self, key: &T) -> bool

where T: PartialEq,

Select the given value.

Returns false if there is no such value, or no items, or nothing changed.

Doesn’t change the selection if the given key doesn’t exist.

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

Get the selected value or None if there are no items.

pub fn value_ref(&self) -> &T

Get the selected value.

Panic

Panics if there is no selection or no items.

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

Select the item.

pub fn selected(&self) -> usize

Selected

pub fn is_empty(&self) -> bool

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,

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

Get the selected value or None there are no items.

pub fn value(&self) -> T

Get the selected value.

Panic

Panics if there are no items.

impl<T> ChoiceState<T>

where T: PartialEq + Clone + Default,

pub fn value_or_default(&self) -> T

Get the selected value or T::default() if there are no items.

impl<T> ChoiceState<T>

where T: PartialEq,

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

Select by first character.

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

Select at position

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

Select next entry.

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

Select prev entry.

Trait Implementations

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

where T: PartialEq + Debug,

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

Formats the value using the given formatter.

impl<T> Default for ChoiceState<T>

where T: PartialEq,

fn default() -> Self

Returns the “default value” for a type.

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

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

Handle an event.

impl<T: PartialEq> HandleEvent<Event, Popup, Outcome> for ChoiceState<T>

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

Handle an event.

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

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

Handle an event.

impl<T> HasFocus for ChoiceState<T>

where T: PartialEq,

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 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,

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

Relocate the areas in this widgets state.