millennium-core 1.0.0-beta.3

// Copyright 2022 pyke.io
//           2019-2021 Tauri Programme within The Commons Conservancy
//                     [https://tauri.studio/]
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![allow(clippy::tabs_in_doc_comments)]

//! **UNSTABLE** -- The `SystemTray` struct and associated types.
//!
//! Use [SystemTrayBuilder][tray_builder] to create your tray instance.
//!
//! [ContextMenu][context_menu] is used to created a Window menu on Windows and
//! Linux. On macOS it's used in the menubar.
//!
//! ```rust,ignore
//! # let icon_rgba = Vec::<u8>::new();
//! # let icon_width = 0;
//! # let icon_height = 0;
//! let mut tray_menu = ContextMenu::new();
//! let icon = Icon::from_rgba(icon_rgba, icon_width, icon_height);
//!
//! tray_menu.add_item(MenuItemAttributes::new("My menu item"));
//!
//! let mut system_tray = SystemTrayBuilder::new(icon, Some(tray_menu))
//! 	.build(&event_loop)
//! 	.unwrap();
//! ```
//!
//! # Linux
//! A menu is required or the tray return an error containing `assertion
//! 'G_IS_DBUS_CONNECTION (connection)'`.
//!
//! [tray_builder]: crate::system_tray::SystemTrayBuilder
//! [menu_bar]: crate::menu::MenuBar
//! [context_menu]: crate::menu::ContextMenu

pub use crate::icon::{BadIcon, Icon};
use crate::{
	error::OsError,
	event_loop::EventLoopWindowTarget,
	menu::ContextMenu,
	platform_impl::{SystemTray as SystemTrayPlatform, SystemTrayBuilder as SystemTrayBuilderPlatform}
};
/// Object that allows you to build SystemTray instance.
pub struct SystemTrayBuilder(pub(crate) SystemTrayBuilderPlatform);

#[cfg(target_os = "linux")]
use std::path::PathBuf;

impl SystemTrayBuilder {
	/// Creates a new SystemTray for platforms where this is appropriate.
	pub fn new(icon: Icon, tray_menu: Option<ContextMenu>) -> Self {
		Self(SystemTrayBuilderPlatform::new(icon, tray_menu.map(|m| m.0.menu_platform)))
	}

	/// Builds the SystemTray.
	///
	/// Possible causes of error include denied permission, incompatible system,
	/// and lack of memory.
	pub fn build<T: 'static>(self, window_target: &EventLoopWindowTarget<T>) -> Result<SystemTray, OsError> {
		self.0.build(window_target)
	}
}

/// Represents a System Tray instance.
///
/// ## Drop behavior
///
/// * **Linux**:
/// 	- Dropping the tray too early could lead to a default icon.
/// 	- Dropping the tray after the icon has been added to the system tray may not remove it.
/// * **Windows**:
/// 	- Dropping the tray will effectively remove the icon from the system tray.
pub struct SystemTray(pub SystemTrayPlatform);

impl SystemTray {
	/// Set new tray icon.
	pub fn set_icon(&mut self, icon: Icon) {
		self.0.set_icon(icon)
	}

	/// Set new tray menu.
	pub fn set_menu(&mut self, tray_menu: &ContextMenu) {
		self.0.set_menu(&tray_menu.0.menu_platform)
	}
}