Struct rat_widget::popup_menu::PopupMenuState

pub struct PopupMenuState {
    pub focus: FocusFlag,
    pub area: Rect,
    pub z_areas: [ZRect; 1],
    pub item_areas: Vec<Rect>,
    pub sep_areas: Vec<Rect>,
    pub navchar: Vec<Option<char>>,
    pub selected: Option<usize>,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

focus: FocusFlag

Focusflag is used to decide the visible/not-visible state.

area: Rect

Total area

z_areas: [ZRect; 1]

Area with z-index for Focus.

item_areas: Vec<Rect>

Areas for each item.

sep_areas: Vec<Rect>

Area for the separator after each item.

navchar: Vec<Option<char>>

Letter navigation

selected: Option<usize>

Selected item.

mouse: MouseFlags

Mouse flags

non_exhaustive: NonExhaustive

Implementations

impl PopupMenuState

pub fn new() -> Self

New

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

New with a focus name.

pub fn clear(&mut self)

Reset the state to defaults.

pub fn flip_active(&mut self)

Show the popup.

pub fn active(&self) -> bool

Show the popup.

pub fn set_active(&self, active: bool)

Show the popup.

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.

impl HasFocusFlag for PopupMenuState

fn focus(&self) -> FocusFlag

Focus flag.

fn area(&self) -> Rect

Focus area.

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

Widget area with z index.

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.