ciantic/trayicon-rs

Tray Icon Rust

TrayIcon

Currently I target Windows tray icon implementation, with popup menu, click, double click events. Goal is to provide a channel for events and ability to plug in winit event loop easily.

Open here a full working example with winit crate 🢅

TODO

Provide coordinates of the Tray Icon area for custom popups.

Alternatives

Most mature alternative is qdot's systray-rs. Unfortunately I got frustrated with the API in it and decided to rewrite my own. This however largely does not use the code in it, instead I loaned my old C/C++ code repository as a template.

Change log

• 0.2.0 - 2024-05-09
  • Removed dependency to winit crate, now setting a sender is a function.
  • Added show_menu, this means user must call it to show the menu even on right click. Previously right click always showed the menu.

trayicon-rs's Issues

winit example not compiling

When I try to run the Winit example (clone this repo, navigate to the winit example, and cargo run) I get

mismatched types
expected struct winit::event_loop::EventLoopProxy<Events>
found struct EventLoopProxy<Events>
perhaps two different versions of crate winit are being used?

Show menu function

I can't find any function to show the menu.
I would like to show the menu after a specific event (for instance after a simple or double click).

Is there a way to do that with the current API?

Consider removing TrayIconSender

Since #5 seems to be ignored (and updating winit every time is not really convenient), I suggest that we remove the sender_* functions entirely and provide a callback F: Fn(T) -> () (where T is the event type). Since almost all existing message passing implementations (std, winit, and crossbeam) only takes &self, this would be fine. The final code would look like this:

let proxy = event_loop.create_proxy();
let mut tray_icon = TrayIconBuilder::new()
  .sender(move |e| { let _ = proxy.send(e.clone()); });

This completely eliminates the dependency on crossbeam and winit.

trayicon::Error should implement std::error::Error

Subj, otherwise it is impossible to box it when writing a function that produces multiple error types.

How to change menu item text after menu was created?

I want to do some kind of runtime changes to the menu, however failing to find any relevant API. Thanks in advance

[FEATURE]: Icon::from_resource

I want to load Icon from resuouce.
Avoid multiple loads and reduce file size.

I use embed-resource lib, Write an *.rc include Icon 、cur file.

Is there a function to remove ICON at the exit of the program?

Is there a function to remove ICON at the exit of the program?
Somehow, I could not see a function call to TrayIcon that removes the ICON from System Tray.