Struct State 

pub struct State<Id, Key = ()> { /* private fields */ }

Available on crate feature context-menu only.

The menu, which area it opened on and where.

Implementations

impl<Id: Copy + PartialEq, Key: Clone + PartialEq> State<Id, Key>

pub fn new(entries: impl IntoIterator<Item = Entry<Id>>) -> Self

A closed menu. Item ids must be unique across submenus.

pub fn menu(&self) -> &State<Id>

The menu entries, highlight and open submenus.

pub fn is_open(&self) -> bool

pub fn is_open_on(&self, key: &Key) -> bool

Whether the menu is open on the area key.

pub fn target(&self) -> Option<&Key>

The area the menu last opened on. It stays set after the menu closes, so the app can tell which row a chosen item belongs to.

pub fn position(&self) -> Option<Point>

Where a right-click opened the menu, relative to the area’s top left corner, or None when it opened from the keyboard below the area.

pub fn is_checked(&self, id: Id) -> bool

pub fn set_checked(&mut self, id: Id, checked: bool)

Checks or unchecks an item. Checking a radio item unchecks its group.

pub fn set_disabled(&mut self, id: Id, disabled: bool)

pub fn update(&mut self, event: Event<Id, Key>) -> Option<Output<Id>>

Applies an event and returns what was chosen, if anything. Opening on another area moves the menu there and resets it.

pub fn key_event( &self, keymap: &Keymap<Action>, key: &Event, target: Key, ) -> Option<Event<Id, Key>>

Turns a key press into an event: first through keymap, then, while the menu is open, as typeahead for a letter or digit. target is the area the opening chord opens the menu on, such as the focused row; pass () for a menu with a single area.

Trait Implementations

impl<Id: Clone, Key: Clone> Clone for State<Id, Key>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug, Key: Debug> Debug for State<Id, Key>

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

Formats the value using the given formatter.

impl<Id: PartialEq, Key: PartialEq> PartialEq for State<Id, Key>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<Id: PartialEq, Key: PartialEq> StructuralPartialEq for State<Id, Key>