2022-05-07 06:57:58 +10:00
|
|
|
//! menu-rs is a cross-platform menu creation library.
|
|
|
|
//!
|
|
|
|
//! # Creating root menus
|
|
|
|
//!
|
|
|
|
//! Before you can add submenus and menu items, you first need a root or a base menu.
|
|
|
|
//! ```no_run
|
|
|
|
//! let mut menu = Menu::new();
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! # Adding submens to the root menu
|
|
|
|
//!
|
|
|
|
//! Once you have a root menu you can start adding [`Submenu`]s by using [`Menu::add_submenu`].
|
|
|
|
//! ```no_run
|
|
|
|
//! let mut menu = Menu::new();
|
|
|
|
//! let file_menu = menu.add_submenu("File", true);
|
|
|
|
//! let edit_menu = menu.add_submenu("Edit", true);
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! # Aadding menu items and submenus within another submenu
|
|
|
|
//!
|
|
|
|
//! Once you have a [`Submenu`] you can star creating more [`Submenu`]s or [`TextMenuItem`]s.
|
|
|
|
//! ```no_run
|
|
|
|
//! let mut menu = Menu::new();
|
|
|
|
//!
|
|
|
|
//! let file_menu = menu.add_submenu("File", true);
|
|
|
|
//! let open_item = file_menu.add_text_item("Open", true);
|
|
|
|
//! let save_item = file_menu.add_text_item("Save", true);
|
|
|
|
//!
|
|
|
|
//! let edit_menu = menu.add_submenu("Edit", true);
|
|
|
|
//! let copy_item = file_menu.add_text_item("Copy", true);
|
|
|
|
//! let cut_item = file_menu.add_text_item("Cut", true);
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! # Add your root menu to a Window (Windows and Linux Only)
|
|
|
|
//!
|
|
|
|
//! You can use [`Menu`] to display a top menu in a Window on Windows and Linux.
|
|
|
|
//! ```no_run
|
|
|
|
//! let mut menu = Menu::new();
|
|
|
|
//! // --snip--
|
|
|
|
//! #[cfg(target_os = "windows")]
|
|
|
|
//! menu.init_for_hwnd(window.hwnd() as isize);
|
|
|
|
//! #[cfg(target_os = "linux")]
|
|
|
|
//! menu.init_for_gtk_window(>k_window);
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! # Processing menu events
|
|
|
|
//!
|
|
|
|
//! You can use [`menu_event_receiver`] to get a reference to the [`MenuEventReceiver`]
|
|
|
|
//! which you can use to listen to events when a menu item is activated
|
|
|
|
//! ```no_run
|
|
|
|
//! if let Ok(event) = menu_event_receiver().try_recv() {
|
|
|
|
//! match event.id {
|
|
|
|
//! _ if event.id == save_item.id() => {
|
|
|
|
//! println!("Save menu item activated");
|
|
|
|
//! },
|
|
|
|
//! _ => {}
|
|
|
|
//! }
|
|
|
|
//! }
|
|
|
|
//! ```
|
|
|
|
|
2022-05-07 00:25:45 +10:00
|
|
|
use crossbeam_channel::{unbounded, Receiver, Sender};
|
|
|
|
use once_cell::sync::Lazy;
|
|
|
|
|
2022-05-05 21:50:22 +10:00
|
|
|
mod platform_impl;
|
|
|
|
mod util;
|
|
|
|
|
2022-05-07 00:25:45 +10:00
|
|
|
static MENU_CHANNEL: Lazy<(Sender<MenuEvent>, Receiver<MenuEvent>)> = Lazy::new(|| unbounded());
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// A type alias to the receiver of the menu events channel.
|
|
|
|
pub type MenuEventReceiver = Receiver<MenuEvent>;
|
|
|
|
|
|
|
|
/// Gets a reference to the event channel's [MenuEventReceiver]
|
|
|
|
/// which can be used to listen for menu events.
|
|
|
|
pub fn menu_event_receiver<'a>() -> &'a MenuEventReceiver {
|
2022-05-07 00:25:45 +10:00
|
|
|
&MENU_CHANNEL.1
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Describes a menu event emitted when a menu item is activated
|
|
|
|
pub struct MenuEvent {
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Id of the menu item which triggered this event
|
2022-05-07 00:25:45 +10:00
|
|
|
pub id: u64,
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// This is the root menu type to which you can add
|
|
|
|
/// more submenus and later be add to the top of a window (on Windows and Linux)
|
|
|
|
/// or used as the menubar menu (on macOS) or displayed as a popup menu.
|
|
|
|
///
|
|
|
|
/// # Example
|
|
|
|
///
|
|
|
|
/// ```
|
|
|
|
/// let mut menu = Menu::new();
|
|
|
|
/// let file_menu = menu.add_submenu("File", true);
|
|
|
|
/// let edit_menu = menu.add_submenu("Edit", true);
|
|
|
|
/// ```
|
2022-05-05 21:50:22 +10:00
|
|
|
pub struct Menu(platform_impl::Menu);
|
|
|
|
|
|
|
|
impl Menu {
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Creates a new root menu.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn new() -> Self {
|
|
|
|
Self(platform_impl::Menu::new())
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Creates a new [`Submenu`] whithin this menu.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn add_submenu(&mut self, label: impl AsRef<str>, enabled: bool) -> Submenu {
|
|
|
|
Submenu(self.0.add_submenu(label, enabled))
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Adds this menu to a [`gtk::Window`].
|
2022-05-05 21:50:22 +10:00
|
|
|
#[cfg(target_os = "linux")]
|
|
|
|
pub fn init_for_gtk_window<W>(&self, w: &W)
|
|
|
|
where
|
|
|
|
W: gtk::prelude::IsA<gtk::Container>,
|
|
|
|
{
|
|
|
|
self.0.init_for_gtk_window(w)
|
|
|
|
}
|
2022-05-07 02:38:39 +10:00
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Adds this menu to a win32 window.
|
2022-05-07 02:38:39 +10:00
|
|
|
#[cfg(target_os = "windows")]
|
|
|
|
pub fn init_for_hwnd(&self, hwnd: isize) {
|
|
|
|
self.0.init_for_hwnd(hwnd)
|
|
|
|
}
|
2022-05-05 21:50:22 +10:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Clone)]
|
2022-05-07 06:57:58 +10:00
|
|
|
/// This is a submenu within another [`Submenu`] or [`Menu`].
|
2022-05-05 21:50:22 +10:00
|
|
|
pub struct Submenu(platform_impl::Submenu);
|
|
|
|
|
|
|
|
impl Submenu {
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Gets the submenus's current label.
|
2022-05-07 01:18:34 +10:00
|
|
|
pub fn label(&self) -> String {
|
|
|
|
self.0.label()
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Sets a new label for the submenu.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn set_label(&mut self, label: impl AsRef<str>) {
|
|
|
|
self.0.set_label(label)
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Gets the submenu's current state, whether enabled or not.
|
2022-05-07 01:18:34 +10:00
|
|
|
pub fn enabled(&self) -> bool {
|
|
|
|
self.0.enabled()
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Enables or disables the submenu
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn set_enabled(&mut self, enabled: bool) {
|
|
|
|
self.0.set_enabled(enabled)
|
|
|
|
}
|
2022-05-07 06:57:58 +10:00
|
|
|
|
|
|
|
/// Creates a new [`Submenu`] whithin this submenu.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn add_submenu(&mut self, label: impl AsRef<str>, enabled: bool) -> Submenu {
|
|
|
|
Submenu(self.0.add_submenu(label, enabled))
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Creates a new [`TextMenuItem`] whithin this submenu.
|
2022-05-07 00:25:45 +10:00
|
|
|
pub fn add_text_item(&mut self, label: impl AsRef<str>, enabled: bool) -> TextMenuItem {
|
|
|
|
TextMenuItem(self.0.add_text_item(label, enabled))
|
2022-05-05 21:50:22 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// This is a Text menu item within a [`Submenu`].
|
2022-05-05 21:50:22 +10:00
|
|
|
#[derive(Clone)]
|
|
|
|
pub struct TextMenuItem(platform_impl::TextMenuItem);
|
|
|
|
|
|
|
|
impl TextMenuItem {
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Gets the menu item's current label.
|
2022-05-07 01:18:34 +10:00
|
|
|
pub fn label(&self) -> String {
|
|
|
|
self.0.label()
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Sets a new label for the menu item.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn set_label(&mut self, label: impl AsRef<str>) {
|
|
|
|
self.0.set_label(label)
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Gets the menu item's current state, whether enabled or not.
|
2022-05-07 01:18:34 +10:00
|
|
|
pub fn enabled(&self) -> bool {
|
|
|
|
self.0.enabled()
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Enables or disables the menu item.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn set_enabled(&mut self, enabled: bool) {
|
|
|
|
self.0.set_enabled(enabled)
|
|
|
|
}
|
|
|
|
|
2022-05-07 06:57:58 +10:00
|
|
|
/// Gets the unique id for this menu item.
|
2022-05-05 21:50:22 +10:00
|
|
|
pub fn id(&self) -> u64 {
|
|
|
|
self.0.id()
|
|
|
|
}
|
|
|
|
}
|