Struct PopupMenuState 

pub struct PopupMenuState {
    pub area: Rect,
    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 focus: FocusFlag,
    pub mouse: MouseFlags,
    pub non_exhaustive: NonExhaustive,
}

State & event handling.

Fields

area: Rect

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

focus: FocusFlag

Current focus state. read+write

mouse: MouseFlags

Mouse flags used for mouse interaction

non_exhaustive: NonExhaustive

Implementations

impl PopupMenuState

pub fn new() -> PopupMenuState

New

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

New 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)

👎Deprecated since 2.1.0: use relocate_popup_hidden()

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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for PopupMenuState

fn default() -> PopupMenuState

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 all events.

Key-events are only handled when the popup menu is_active. You need to set this state according to your logic.

The popup menu will return MenuOutcome::Hide if it thinks it should be hidden.

impl HandleEvent<Event, Regular, MenuOutcome> for PopupMenuState

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

Handle an event.

impl HasFocus for PopupMenuState

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

Build the focus-structure for the container/widget.

fn focus(&self) -> FocusFlag

Access to the focus flag.

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 build_nav(&self, navigable: Navigation, builder: &mut FocusBuilder)

Build the focus-structure for the container/widget.

fn id(&self) -> usize

Provide a unique id for the widget.

fn is_focused(&self) -> bool

Does this widget have the focus. Or, if the flag is used for a container, does any of widget inside the container have the focus.

fn lost_focus(&self) -> bool

This widget just lost the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn gained_focus(&self) -> bool

This widget just gained the focus. This flag is set by [Focus::handle] if there is a focus transfer, and will be reset by the next call to [Focus::handle].

fn has_mouse_focus(&self) -> bool

This flag is set by [Focus::handle], if a mouse-event matches one of the areas associated with a widget.

impl HasScreenCursor for PopupMenuState

fn screen_cursor(&self) -> Option<(u16, u16)>

This returns the cursor position if

impl RelocatableState for PopupMenuState

fn relocate(&mut self, _shift: (i16, i16), _clip: Rect)

Relocate the areas in this widgets state.

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

Relocate only popup areas. As rendering the popups is a separate render, this has to be separate too.

fn relocate_popup_hidden(&mut self)

Relocate all popup areas to a clip-rect (0,0+0x0).

fn relocate_hidden(&mut self)

Relocate all areas to a clip-rect (0,0+0x0).