Struct MenuState 

pub struct MenuState { /* private fields */ }

The open menu of a DropdownMenu, a ContextMenu, or a text field.

Owned by the view that shows the menu, which observes it so a change renders. The rows are given when the menu opens, so what they show (whether Paste has something to paste) is read at that moment.

While open the menu holds focus. It closes on an outside press, on Escape at its root, when focus leaves it, and when an item is chosen, and then gives focus back to the element that had it before.

Implementations

impl MenuState

pub fn new(cx: &mut Context<'_, Self>) -> Self

A closed menu.

pub fn is_open(&self) -> bool

Whether the menu is open.

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

The key of the row the keyboard or the pointer is on, in the innermost level that has one.

pub fn open( &mut self, entries: impl IntoIterator<Item = impl Into<MenuEntry>>, anchor: MenuAnchor, window: &mut Window, cx: &mut Context<'_, Self>, )

Opens the menu with entries at anchor and moves focus into it. An action an item dispatches goes to the element that had focus before, as its key binding would, and its shortcut is read there; with nothing focused it goes up from the element the menu is drawn in. A menu that is open already opens again in the new place.

pub fn set_entries( &mut self, entries: impl IntoIterator<Item = impl Into<MenuEntry>>, cx: &mut Context<'_, Self>, )

Replaces the rows of the open menu, as an answer that arrives after it opened. Submenus close; the keyboard stays on the row with the same key when there is one. A closed menu ignores it.

pub fn open_for( &mut self, entries: impl IntoIterator<Item = impl Into<MenuEntry>>, anchor: MenuAnchor, action_context: &FocusHandle, window: &mut Window, cx: &mut Context<'_, Self>, )

Opens the menu as open does, with the actions its items dispatch going to action_context, and their shortcuts read from it.

pub fn close(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Closes the whole menu and gives focus back.

Trait Implementations

impl EventEmitter<MenuEvent> for MenuState

impl Focusable for MenuState

The menu’s own focus handle, which holds the keyboard while it is open.

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.