Rust系统托盘图标库ksni的使用

ksni是一个实现了KDE/freedesktop StatusNotifierItem规范的Rust库，提供了跨平台的系统托盘图标和菜单功能集成。

基本示例

以下是ksni的基本使用示例：

use ksni::TrayMethods; // 提供spawn方法

#[derive(Debug)]
struct MyTray {
    selected_option: usize,
    checked: bool,
}

impl ksni::Tray for MyTray {
    fn id(&self) -> String {
        env!("CARGO_PKG_NAME").into()
    }
    fn icon_name(&self) -> String {
        "help-about".into()
    }
    fn title(&self) -> String {
        if self.checked { "CHECKED!" } else { "MyTray" }.into()
    }
    fn menu(&self) -> Vec<ksni::MenuItem<Self>> {
        use ksni::menu::*;
        vec![
            SubMenu {
                label: "a".into(),
                submenu: vec![
                    SubMenu {
                        label: "a1".into(),
                        submenu: vec![
                            StandardItem {
                                label: "a1.1".into(),
                                ..Default::default()
                            }
                            .into(),
                            StandardItem {
                                label: "a1.2".into(),
                                ..Default::default()
                            }
                            .into(),
                        ],
                        ..Default::default()
                    }
                    .into(),
                    StandardItem {
                        label: "a2".into(),
                        ..Default::default()
                    }
                    .into(),
                ],
                ..Default::default()
            }
            .into(),
            MenuItem::Separator,
            RadioGroup {
                selected: self.selected_option,
                select: Box::new(|this: &mut Self, current| {
                    this.selected_option = current;
                }),
                options: vec![
                    RadioItem {
                        label: "Option 0".into(),
                        ..Default::default()
                    },
                    RadioItem {
                        label: "Option 1".into(),
                        ..Default::default()
                    },
                    RadioItem {
                        label: "Option 2".into(),
                        ..Default::default()
                    },
                ],
                ..Default::default()
            }
            .into(),
            CheckmarkItem {
                label: "Checkable".into(),
                checked: self.checked,
                activate: Box::new(|this: &mut Self| this.checked = !this.checked),
                ..Default::default()
            }
            .into(),
            StandardItem {
                label: "Exit".into(),
                icon_name: "application-exit".into(),
                activate: Box::new(|_| std::process::exit(0)),
                ..Default::default()
            }
            .into(),
        ]
    }
}

#[tokio::main(flavor = "current_thread")]
async fn main() {
    let tray = MyTray {
        selected_option: 0,
        checked: false,
    };
    let handle = tray.spawn().await.unwrap();

    tokio::time::sleep(std::time::Duration::from_secs(5)).await;
    // 我们可以修改托盘
    handle.update(|tray: &mut MyTray| tray.checked = true).await;
    // 永久运行
    std::future::pending().await
}

完整示例代码

use ksni::TrayMethods;

#[derive(Debug)]
struct AppTray {
    counter: u32,
    is_active: bool,
}

impl ksni::Tray for AppTray {
    fn id(&self) -> String {
        "my-app-tray".into()
    }
    
    fn icon_name(&self) -> String {
        if self.is_active {
            "network-wired-activated"
        } else {
            "network-wired"
        }.into()
    }
    
    fn title(&self) -> String {
        format!("Counter: {}", self.counter)
    }
    
    fn menu(&self) -> Vec<ksni::MenuItem<Self>> {
        use ksni::menu::*;
        
        vec![
            StandardItem {
                label: format!("Click count: {}", self.counter),
                enabled: false,
                ..Default::default()
            }.into(),
            
            MenuItem::Separator,
            
            CheckmarkItem {
                label: "Active".into(),
                checked: self.is_active,
                activate: Box::new(|this: &mut Self| {
                    this.is_active = !this.is_active;
                }),
                ..Default::default()
            }.into(),
            
            StandardItem {
                label: "Increment".into(),
                icon_name: "list-add".into(),
                activate: Box::new(|this: &mut Self| {
                    this.counter += 1;
                }),
                ..Default::default()
            }.into(),
            
            StandardItem {
                label: "Reset".into(),
                icon_name: "edit-clear".into(),
                activate: Box::new(|this: &mut Self| {
                    this.counter = 0;
                }),
                ..Default::default()
            }.into(),
            
            MenuItem::Separator,
            
            StandardItem {
                label: "Quit".into(),
                icon_name: "application-exit".into(),
                activate: Box::new(|_| std::process::exit(0)),
                ..Default::default()
            }.into(),
        ]
    }
}

#[tokio::main]
async fn main() {
    let tray = AppTray {
        counter: 0,
        is_active: true,
    };
    
    let handle = tray.spawn().await.unwrap();
    
    // 每5秒更新一次计数器
    let mut interval = tokio::time::interval(std::time::Duration::from_secs(5));
    loop {
        interval.tick().await;
        handle.update(|tray| {
            tray.counter += 1;
        }).await;
    }
}

功能支持

• [x] org.kde.StatusNotifierItem
• [x] com.canonical.dbusmenu
• [x] org.freedesktop.DBus.Introspectable
• [x] org.freedesktop.DBus.Properties
• [x] 单选项目
• [ ] 文档
• [x] 异步支持
• [x] 可变菜单项

许可证

这是免费且不受限制的软件，发布到公共领域。任何人都可以自由复制、修改、发布、使用、编译、出售或分发此软件，无论是源代码形式还是编译后的二进制形式，用于任何目的，商业或非商业，以及通过任何方式。