Struct State 

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

Available on crate feature menubar only.

The menus, which one is open and which title has the keyboard focus.

Implementations

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

pub fn new(menus: impl IntoIterator<Item = Menu<Id>>) -> Self

A closed menubar. Item ids must be unique across every menu.

pub fn shows_mnemonics(&self) -> bool

Whether the bar was last used from the keyboard, which underlines the mnemonics while it has focus.

pub fn menus(&self) -> &[Menu<Id>]

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

The position of the open menu.

pub fn is_open(&self) -> bool

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

The title with the keyboard focus. The open menu’s title keeps it.

pub fn is_focused(&self) -> bool

Whether the bar takes the keys that move along it.

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

The highlighted item in the open menu.

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

Whether a checkbox or radio item in any menu is checked.

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

Checks or unchecks an item, in whichever menu holds it.

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

Enables or disables an item, in whichever menu holds it.

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

Applies an event and returns what was chosen, if anything. Choosing an item closes the menu and leaves the bar.

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

Turns a key press into an event. While a menu is open, the bar’s keymap goes first (Left and Right open and close submenus before they move between menus), then menu_keymap and typeahead. While closed, the bar claims Action::Focus, its mnemonics with Alt, and, only while it has focus, its other actions and bare mnemonics.

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>