Go to file
Amr Bashir 662e17d0ec
refactor: impl drop for inner types (#92)
* refactor: impl drop for inner types

* macos

* impl todos in macos .remove()

* remove code

* fix gtk accelerator not working after creating the context menu
2023-08-08 19:32:27 +03:00
.changes refactor: impl drop for inner types (#92) 2023-08-08 19:32:27 +03:00
.github/workflows refactor(gtk): accept a container param instead of creating it (#75) 2023-07-25 22:01:35 +03:00
examples refactor: add MenuId type and related functions (#91) 2023-08-04 16:17:58 -03:00
src refactor: impl drop for inner types (#92) 2023-08-08 19:32:27 +03:00
.gitignore chore: add license 2022-12-08 20:50:24 +02:00
Cargo.toml Apply Version Updates From Current Changes (#88) 2023-08-03 19:56:18 +03:00
CHANGELOG.md Apply Version Updates From Current Changes (#88) 2023-08-03 19:56:18 +03:00
LICENSE-APACHE chore: add license 2022-12-08 20:50:24 +02:00
LICENSE-MIT chore: add license 2022-12-08 20:50:24 +02:00
LICENSE.spdx chore: add license 2022-12-08 20:50:24 +02:00
README.md chore: update docs 2023-07-28 04:38:38 +03:00
renovate.json chore: remove trailing comma 2022-11-27 12:49:54 +02:00

muda is a Menu Utilities library for Desktop Applications.

Platforms supported:

  • Windows
  • macOS
  • Linux (gtk Only)

Platform-specific notes:

Cargo Features

  • common-controls-v6: Use TaskDialogIndirect API from ComCtl32.dll v6 on Windows for showing the predefined About menu item dialog.
  • libxdo: Enables linking to libxdo on Linux which is used for the predfined Copy, Cut, Paste and SelectAll menu item.
  • serde: Enables de/serializing the dpi types.

Dependencies (Linux Only)

gtk is used for menus and libxdo is used to make the predfined Copy, Cut, Paste and SelectAll menu items work. Be sure to install following packages before building:

Arch Linux / Manjaro:

pacman -S gtk3 xdotool

Debian / Ubuntu:

sudo apt install libgtk-3-dev libxdo-dev

Example

Create the menu and add your items

let menu = Menu::new();
let menu_item2 = MenuItem::new("Menu item #2", false, None);
let submenu = Submenu::with_items("Submenu Outer", true,&[
  &MenuItem::new("Menu item #1", true, Some(Accelerator::new(Some(Modifiers::ALT), Code::KeyD))),
  &PredefinedMenuItem::separator(),
  &menu_item2,
  &MenuItem::new("Menu item #3", true, None),
  &PredefinedMenuItem::separator(),
  &Submenu::with_items("Submenu Inner", true,&[
    &MenuItem::new("Submenu item #1", true, None),
    &PredefinedMenuItem::separator(),
    &menu_item2,
  ])
]);

Then add your root menu to a Window on Windows and Linux or use it as your global app menu on macOS

// --snip--
#[cfg(target_os = "windows")]
menu.init_for_hwnd(window.hwnd() as isize);
#[cfg(target_os = "linux")]
menu.init_for_gtk_window(&gtk_window, Some(&vertical_gtk_box));
#[cfg(target_os = "macos")]
menu.init_for_nsapp();

Context menus (Popup menus)

You can also use a [Menu] or a [Submenu] show a context menu.

// --snip--
let position = muda::PhysicalPosition { x: 100., y: 120. };
#[cfg(target_os = "windows")]
menu.show_context_menu_for_hwnd(window.hwnd() as isize, Some(position.into()));
#[cfg(target_os = "linux")]
menu.show_context_menu_for_gtk_window(&gtk_window, Some(position.into()));
#[cfg(target_os = "macos")]
menu.show_context_menu_for_nsview(nsview, Some(position.into()));

Processing menu events

You can use MenuEvent::receiver to get a reference to the MenuEventReceiver which you can use to listen to events when a menu item is activated

if let Ok(event) = MenuEvent::receiver().try_recv() {
    match event.id {
        _ if event.id == save_item.id() => {
            println!("Save menu item activated");
        },
        _ => {}
    }
}

License

Apache-2.0/MIT