Struct Menu 

pub struct Menu {
    pub name: SharedString,
    pub items: Vec<MenuItem>,
    pub disabled: bool,
}

A menu in the application’s menu bar, or a submenu inside another menu.

Build a menu with Menu::new and fill it with Menu::items. Pass the menus to App::set_menus to show them. Each call to set_menus replaces the whole menu bar. Only macOS draws the menu bar from these menus. Linux and Windows store them, and App::get_menus returns them, but they don’t draw a menu bar.

Picking an MenuItem::Action dispatches its action through App::dispatch_action. An App::on_action handler for that action runs for the menu item and for its key binding alike.

Examples

use std::{cell::Cell, rc::Rc};

use gpui::{App, Menu, MenuItem, OsAction, SystemMenuType, TestApp, actions};

actions!(app_menu_example, [Preferences, Undo]);

fn set_up_menus(cx: &mut App, preferences_opened: Rc<Cell<bool>>) {
    // A menu item and a key binding for the same action share one handler.
    cx.on_action(move |_: &Preferences, _cx| preferences_opened.set(true));
    cx.on_action(|_: &Undo, _cx| {
        // Undo the last edit here.
    });
    cx.set_menus([
        Menu::new("App").items([
            MenuItem::os_submenu("Services", SystemMenuType::Services),
            MenuItem::separator(),
            MenuItem::action("Preferences...", Preferences),
        ]),
        Menu::new("Edit").items([MenuItem::os_action("Undo", Undo, OsAction::Undo)]),
    ]);
}

// Picking the menu item dispatches its action. The test harness has no menu bar,
// so it dispatches the action directly.

Fields

name: SharedString

The title of the menu, as shown in the menu bar.

items: Vec<MenuItem>

The entries of the menu, in display order.

disabled: bool

Whether the menu is disabled. On macOS, a disabled submenu can’t be opened.

Implementations

impl Menu

pub fn new(name: impl Into<SharedString>) -> Self

Creates an empty menu with the given title.

Add entries with Self::items.

pub fn items(self, items: impl IntoIterator<Item = MenuItem>) -> Self

Replaces the menu’s entries with items, and returns the menu.

The previous entries are discarded.

pub fn disabled(self, disabled: bool) -> Self

Sets whether the menu is disabled, and returns the menu.

pub fn owned(self) -> OwnedMenu

Converts this menu into an OwnedMenu, the form that App::get_menus returns.

Platforms call this when they store the menu bar set with App::set_menus, so you rarely need it.