trayicon 0.4.0

Tray Icon, that thing in the corner
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! ## Example
//! [Open full example with winit here 🢅](https://github.com/Ciantic/trayicon-rs/blob/master/examples/winit/src/main.rs)

#[cfg(target_os = "windows")]
#[path = "./sys/windows/mod.rs"]
mod sys;

#[cfg(target_os = "macos")]
#[path = "./sys/macos/mod.rs"]
mod sys;

#[cfg(target_os = "linux")]
#[path = "./sys/linux/mod.rs"]
mod sys;

mod icon;
mod menubuilder;
mod trayicon;
mod trayiconbuilder;
mod trayiconsender;

/// Helper trait that combines the common trait bounds used throughout the library
pub trait TrayIconEvent: PartialEq + Clone + 'static + Send + Sync {}
impl<T> TrayIconEvent for T where T: PartialEq + Clone + 'static + Send + Sync {}

// Public api
pub use crate::icon::Icon;
pub use crate::menubuilder::{MenuBuilder, MenuItem};
pub use crate::trayicon::TrayIcon;
pub use crate::trayiconbuilder::Error;
pub use crate::trayiconbuilder::TrayIconBuilder;

/// Status/visibility state for the tray icon (KDE StatusNotifierItem status)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TrayIconStatus {
    /// Normal visible state
    Active,
    /// Icon blinks/animates to draw attention (KDE)
    NeedsAttention,
    /// Icon is hidden or minimized (KDE)
    Passive,
}

// Each OS specific implementation must export following:
pub(crate) use crate::sys::{
    // MenuBuilder<T> -> Result<MenuSys<T>, Error>
    build_menu,

    // TrayIconBuilder<T> -> Result<Box<TrayIconSys<T>>, Error>
    build_trayicon,

    // Struct that must implement IconBase + Clone
    IconSys,

    // Struct
    MenuSys,

    // Struct that must implement TrayIconBase
    TrayIconSys,
};

/// TrayIconSys must implement this
pub(crate) trait TrayIconBase<T>
where
    T: PartialEq + Clone + 'static + Send + Sync,
{
    fn set_icon(&mut self, icon: &Icon) -> Result<(), Error>;
    fn set_menu(&mut self, menu: &MenuBuilder<T>) -> Result<(), Error>;
    fn set_tooltip(&mut self, tooltip: &str) -> Result<(), Error>;

    /// Set title (KDE only)
    ///
    /// Used in KDE as the application title for the tray icon (Title property).
    /// On other platforms, this does nothing by default.
    fn set_title(&mut self, _title: &str) -> Result<(), Error> {
        Ok(())
    }

    /// Show the menu (Windows only)
    ///
    /// On KDE and MacOS right click by default opens the menu, there is no programmatic way to open it.
    fn show_menu(&mut self) -> Result<(), Error> {
        Ok(())
    }

    /// Set the status of the tray icon (KDE only)
    ///
    /// On KDE, this controls the StatusNotifierItem status:
    /// - Active: Normal visible state
    /// - NeedsAttention: Icon blinks/animates to draw attention
    /// - Passive: Icon is hidden or minimized
    ///
    /// On other platforms, this does nothing by default.
    fn set_status(&mut self, _status: TrayIconStatus) -> Result<(), Error> {
        Ok(())
    }

    /// Get the XDG activation token (KDE only)
    fn get_xdg_activation_token(&self) -> Option<String> {
        None
    }
}

/// IconSys must implement this
pub(crate) trait IconBase {
    fn from_buffer(
        buffer: &'static [u8],
        width: Option<u32>,
        height: Option<u32>,
    ) -> Result<IconSys, Error>;
}