Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature dropdown-menu only.

The entries of a menu, whether it is open and what is highlighted.

Implementations

impl<Id: Copy + PartialEq> State<Id>

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

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

pub fn entries(&self) -> &[Entry<Id>]

pub fn is_open(&self) -> bool

pub fn depth(&self) -> usize

How many menus are open: 0 when closed, 1 for the root menu, plus one per open submenu.

pub fn highlighted(&self) -> Option<Id>

The highlighted item in the menu that has keyboard focus.

pub fn highlighted_at(&self, depth: usize) -> Option<usize>

The highlighted row index in the menu depth levels deep.

pub fn item(&self, id: Id) -> Option<&Item<Id>>

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

Whether a checkbox or radio item is checked.

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)

Enables or disables an item. A disabled item loses its highlight.

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

Applies an event and returns what was chosen, if anything.

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

Turns a key press into an event: first through keymap, then, while the menu is open, as typeahead for a letter or digit. An open menu does this itself; an app calls it for a closed menu’s Action::Open chord.

Trait Implementations

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

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> Debug for State<Id>

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

Formats the value using the given formatter.

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

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

Equality operator ==.

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

Inequality operator !=.

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