Struct PopupMenuState

pub struct PopupMenuState {
    pub popup: PopupCoreState,
    pub item_areas: Vec<Rect>,
    pub sep_areas: Vec<Rect>,
    pub navchar: Vec<Option<char>>,
    pub disabled: Vec<bool>,
    pub selected: Option<usize>,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

popup: PopupCoreState

Popup data.

item_areas: Vec<Rect>

Areas for each item. readonly. renewed for each render.

sep_areas: Vec<Rect>

Area for the separator after each item. The area has height 0 if there is no separator. readonly. renewed for each render.

navchar: Vec<Option<char>>

Letter navigation readonly. renewed for each render.

disabled: Vec<bool>

Disabled menu-items.

selected: Option<usize>

Selected item. read+write

mouse: MouseFlags

Mouse flags used for mouse interaction

non_exhaustive: NonExhaustive

Implementations

impl PopupMenuState

pub fn new() -> Self

New

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

New state with a focus name.

pub fn set_popup_z(&mut self, z: u16)

Set the z-index for the popup-menu.

pub fn popup_z(&self) -> u16

The z-index for the popup-menu.

pub fn flip_active(&mut self)

Show the popup.

pub fn is_active(&self) -> bool

Show the popup.

pub fn set_active(&mut self, active: bool)

Show the popup.

pub fn clear_areas(&mut self)

Clear the areas.

pub fn len(&self) -> usize

Number of items.

pub fn is_empty(&self) -> bool

Any items.

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

Selected item.

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

Selected item.

pub fn prev_item(&mut self) -> bool

Select the previous item.

pub fn next_item(&mut self) -> bool

Select the next item.

pub fn navigate(&mut self, c: char) -> MenuOutcome

Select by navigation key.

pub fn select_at(&mut self, pos: (u16, u16)) -> bool

Select item at position.

pub fn item_at(&self, pos: (u16, u16)) -> Option<usize>

Item at position.

Trait Implementations

impl Clone for PopupMenuState

fn clone(&self) -> PopupMenuState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopupMenuState

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

Formats the value using the given formatter.

impl Default for PopupMenuState

fn default() -> Self

Returns the “default value” for a type.

impl HandleEvent<Event, MouseOnly, MenuOutcome> for PopupMenuState

fn handle(&mut self, event: &Event, _: MouseOnly) -> MenuOutcome

Handle an event.

impl HandleEvent<Event, Popup, MenuOutcome> for PopupMenuState

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

Handle an event.