Struct MenuState 

pub struct MenuState {
    pub active_menu: Option<usize>,
    pub highlighted_item: Option<usize>,
    pub submenu_path: Vec<usize>,
    pub plugin_menus: Vec<Menu>,
    pub context: MenuContext,
}

Menu bar state (tracks which menu is open and which item is highlighted)

Fields

active_menu: Option<usize>

Index of the currently open menu (None if menu bar is closed)

highlighted_item: Option<usize>

Index of the highlighted item within the active menu or current submenu

submenu_path: Vec<usize>

Path of indices into nested submenus (empty = at top level menu) Each element is the index of the submenu item that was opened

plugin_menus: Vec<Menu>

Runtime menu additions from plugins

context: MenuContext

Context containing named boolean states for conditions and checkboxes

Implementations

impl MenuState

pub fn new() -> Self

pub fn open_menu(&mut self, index: usize)

Open a menu by index

pub fn close_menu(&mut self)

Close the currently open menu (and all submenus)

pub fn next_menu(&mut self, total_menus: usize)

Navigate to the next menu (right) - only at top level

pub fn prev_menu(&mut self, total_menus: usize)

Navigate to the previous menu (left) - only at top level

pub fn in_submenu(&self) -> bool

Check if we’re currently in a submenu

pub fn submenu_depth(&self) -> usize

Get the current submenu depth (0 = top level menu)

pub fn open_submenu(&mut self, menus: &[Menu]) -> bool

Open a submenu at the current highlighted item Returns true if a submenu was opened, false if the item wasn’t a submenu

pub fn close_submenu(&mut self) -> bool

Close the current submenu and go back to parent Returns true if a submenu was closed, false if already at top level

pub fn get_current_items<'a>( &self, menus: &'a [Menu], active_idx: usize, ) -> Option<&'a [MenuItem]>

Get the menu items at the current submenu level

pub fn get_current_items_cloned(&self, menu: &Menu) -> Option<Vec<MenuItem>>

Get owned vec of current items (for use when Menu is cloned) DynamicSubmenus are expanded to regular Submenus

pub fn next_item(&mut self, menu: &Menu)

Navigate to the next item in the current menu/submenu (down)

pub fn prev_item(&mut self, menu: &Menu)

Navigate to the previous item in the current menu/submenu (up)

pub fn get_highlighted_action( &self, menus: &[Menu], ) -> Option<(String, HashMap<String, Value>)>

Get the currently highlighted action (if any) This navigates through the submenu path to find the currently highlighted item

pub fn is_highlighted_submenu(&self, menus: &[Menu]) -> bool

Check if the currently highlighted item is a submenu

pub fn get_menu_at_position(&self, menus: &[Menu], x: u16) -> Option<usize>

Get the menu index at a given x position in the menu bar Returns the menu index if the click is on a menu label

pub fn get_item_at_position(&self, menu: &Menu, y: u16) -> Option<usize>

Get the item index at a given y position in the dropdown y is relative to the menu bar (so y=1 is the first item in dropdown)

Trait Implementations

impl Clone for MenuState

fn clone(&self) -> MenuState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuState

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

Formats the value using the given formatter.

impl Default for MenuState

fn default() -> MenuState

Returns the “default value” for a type.