Struct Menu

pub struct Menu(/* private fields */);

A menu object.

This may be a window menu, an application menu (macOS) or a context (right-click) menu.

Configuring menus

Currently, a menu and its items cannot be changed once created. If you need to change anything about a menu (for instance, disabling or selecting items) you need to create a new menu with the desired properties.

Implementations

impl Menu

pub fn new() -> Menu

Create a new empty window or application menu.

Examples found in repository

examples/quit.rs (line 73)

fn main() {
    tracing_subscriber::fmt().init();
    let app = Application::new().unwrap();

    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );

    let mut menubar = Menu::new();
    menubar.add_dropdown(file_menu, "Application", true);

    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<QuitState>::default());
    builder.set_title("Quit example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

examples/shello.rs (line 138)

fn main() {
    tracing_subscriber::fmt().init();
    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );
    file_menu.add_item(
        0x101,
        "O&pen",
        Some(&HotKey::new(SysMods::Cmd, "o")),
        None,
        true,
    );
    file_menu.add_item(
        0x102,
        "S&ave",
        Some(&HotKey::new(SysMods::Cmd, "s")),
        None,
        true,
    );
    let mut menubar = Menu::new();
    menubar.add_dropdown(Menu::new(), "Application", true);
    menubar.add_dropdown(file_menu, "&File", true);

    let app = Application::new().unwrap();
    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<HelloState>::default());
    builder.set_title("Hello example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

pub fn new_for_popup() -> Menu

Create a new empty context menu.

Some platforms distinguish between these types of menus, and some do not.

pub fn add_dropdown(&mut self, menu: Menu, text: &str, enabled: bool)

Add the provided Menu as a submenu of self, with the provided title.

Examples found in repository

examples/quit.rs (line 83)

fn main() {
    tracing_subscriber::fmt().init();
    let app = Application::new().unwrap();

    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );

    let mut menubar = Menu::new();
    menubar.add_dropdown(file_menu, "Application", true);

    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<QuitState>::default());
    builder.set_title("Quit example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

examples/shello.rs (line 161)

fn main() {
    tracing_subscriber::fmt().init();
    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );
    file_menu.add_item(
        0x101,
        "O&pen",
        Some(&HotKey::new(SysMods::Cmd, "o")),
        None,
        true,
    );
    file_menu.add_item(
        0x102,
        "S&ave",
        Some(&HotKey::new(SysMods::Cmd, "s")),
        None,
        true,
    );
    let mut menubar = Menu::new();
    menubar.add_dropdown(Menu::new(), "Application", true);
    menubar.add_dropdown(file_menu, "&File", true);

    let app = Application::new().unwrap();
    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<HelloState>::default());
    builder.set_title("Hello example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

pub fn add_item( &mut self, id: u32, text: &str, key: Option<&HotKey>, selected: Option<bool>, enabled: bool, )

Add an item to this menu.

The id should uniquely identify this item. If the user selects this item, the responsible WinHandler’s command method will be called with this id. If the enabled argument is false, the menu item will be grayed out; the hotkey will also be disabled. If the selected argument is true, the menu will have a checkmark or platform appropriate equivalent indicating that it is currently selected. The key argument is an optional HotKey that will be registered with the system.

Examples found in repository

examples/quit.rs (lines 74-80)

fn main() {
    tracing_subscriber::fmt().init();
    let app = Application::new().unwrap();

    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );

    let mut menubar = Menu::new();
    menubar.add_dropdown(file_menu, "Application", true);

    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<QuitState>::default());
    builder.set_title("Quit example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

examples/shello.rs (lines 139-145)

fn main() {
    tracing_subscriber::fmt().init();
    let mut file_menu = Menu::new();
    file_menu.add_item(
        0x100,
        "E&xit",
        Some(&HotKey::new(SysMods::Cmd, "q")),
        None,
        true,
    );
    file_menu.add_item(
        0x101,
        "O&pen",
        Some(&HotKey::new(SysMods::Cmd, "o")),
        None,
        true,
    );
    file_menu.add_item(
        0x102,
        "S&ave",
        Some(&HotKey::new(SysMods::Cmd, "s")),
        None,
        true,
    );
    let mut menubar = Menu::new();
    menubar.add_dropdown(Menu::new(), "Application", true);
    menubar.add_dropdown(file_menu, "&File", true);

    let app = Application::new().unwrap();
    let mut builder = WindowBuilder::new(app.clone());
    builder.set_handler(Box::<HelloState>::default());
    builder.set_title("Hello example");
    builder.set_menu(menubar);

    let window = builder.build().unwrap();
    window.show();

    app.run(None);
}

pub fn add_separator(&mut self)

Add a separator to the menu.