Struct ChoiceState

pub struct ChoiceState {

    pub area: Rect,
    pub z_areas: [ZRect; 2],
    pub nav_char: Vec<Vec<char>>,
    pub item_area: Rect,
    pub button_area: Rect,
    pub item_areas: Vec<Rect>,
    pub len: usize,
    pub default_settable: bool,
    pub selected: Option<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.

z_areas: [ZRect; 2]

All areas 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.

len: usize

Total number of items. read only. renewed with each render.

default_settable: bool

Can return to default with a user interaction. read only. renewed for each render.

selected: Option<usize>

Select item. read+write

popup: PopupCoreState

Popup state.

focus: FocusFlag

Focus flag. read+write

mouse: MouseFlags

Mouse util.

non_exhaustive: NonExhaustive

Implementations

impl ChoiceState

pub fn new() -> Self

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

pub fn is_popup_active(&self) -> bool

pub fn flip_popup_active(&mut self)

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

impl ChoiceState

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

Select

pub fn clear_offset(&mut self)

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

pub fn offset(&self) -> usize

pub fn max_offset(&self) -> usize

pub fn page_len(&self) -> usize

pub fn scroll_by(&self) -> usize

pub fn scroll_to_selected(&mut self) -> bool

impl ChoiceState

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

fn clone(&self) -> ChoiceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChoiceState

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

Formats the value using the given formatter.

impl Default for ChoiceState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, Outcome> for ChoiceState

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

Handle an event.

impl HandleEvent<Event, Popup, Outcome> for ChoiceState

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

Handle an event.

impl HandleEvent<Event, Regular, Outcome> for ChoiceState

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

Handle an event.

impl HasFocus for ChoiceState

fn focus(&self) -> FocusFlag

Access to the flag for the rest.

fn area(&self) -> Rect

Area for mouse focus.

fn z_areas(&self) -> &[ZRect]

The widget might have several disjointed/overlapping areas. This is the case if it is showing a popup, but there might be other causes.

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

Build the focus-structure for the container.

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 RelocatableState for ChoiceState

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

Relocate the areas in this widgets state.