Struct TrayIconBuilder 

pub struct TrayIconBuilder<R: Runtime> { /* private fields */ }

Available on desktop and crate feature tray-icon only.

TrayIcon builder struct and associated methods.

Implementations

impl<R: Runtime> TrayIconBuilder<R>

pub fn new() -> Self

Creates a new tray icon builder.

Platform-specific:

• Linux: Sometimes the icon won’t be visible unless a menu is set. Setting an empty Menu is enough.

pub fn with_id<I: Into<TrayIconId>>(id: I) -> Self

Creates a new tray icon builder with the specified id.

Platform-specific:

• Linux: Sometimes the icon won’t be visible unless a menu is set. Setting an empty Menu is enough.

pub fn menu<M: ContextMenu>(self, menu: &M) -> Self

Set the a menu for this tray icon.

Platform-specific:

• Linux: once a menu is set, it cannot be removed or replaced but you can change its content.

pub fn icon(self, icon: Image<'_>) -> Self

Set an icon for this tray icon.

Platform-specific:

• Linux: Sometimes the icon won’t be visible unless a menu is set. Setting an empty Menu is enough.

pub fn tooltip<S: AsRef<str>>(self, s: S) -> Self

Set a tooltip for this tray icon.

Platform-specific:

• Linux: Unsupported.

pub fn title<S: AsRef<str>>(self, title: S) -> Self

Set the tray icon title.

Platform-specific

• Linux: The title will not be shown unless there is an icon as well. The title is useful for numerical and other frequently updated information. In general, it shouldn’t be shown unless a user requests it as it can take up a significant amount of space on the user’s panel. This may not be shown in all visualizations.
• Windows: Unsupported.

pub fn temp_dir_path<P: AsRef<Path>>(self, s: P) -> Self

Set tray icon temp dir path. Linux only.

On Linux, we need to write the icon to the disk and usually it will be $XDG_RUNTIME_DIR/tray-icon or $TEMP/tray-icon.

pub fn icon_as_template(self, is_template: bool) -> Self

Use the icon as a template. macOS only.

pub fn menu_on_left_click(self, enable: bool) -> Self

👎Deprecated since 2.2.0: Use TrayIconBuilder::show_menu_on_left_click instead.

Whether to show the tray menu on left click or not, default is true.

Platform-specific:

• Linux: Unsupported.

pub fn show_menu_on_left_click(self, enable: bool) -> Self

Whether to show the tray menu on left click or not, default is true.

Platform-specific:

• Linux: Unsupported.

pub fn on_menu_event<F: Fn(&AppHandle<R>, MenuEvent) + Sync + Send + 'static>( self, f: F, ) -> Self

Set a handler for menu events.

Note that this handler is called for any menu event, whether it is coming from this window, another window or from the tray icon menu.

pub fn on_tray_icon_event<F: Fn(&TrayIcon<R>, TrayIconEvent) + Sync + Send + 'static>( self, f: F, ) -> Self

Set a handler for this tray icon events.

pub fn id(&self) -> &TrayIconId

Access the unique id that will be assigned to the tray icon this builder will create.

pub fn build<M: Manager<R>>(self, manager: &M) -> Result<TrayIcon<R>>

Builds and adds a new TrayIcon to the system tray.

Trait Implementations

impl<R: Default + Runtime> Default for TrayIconBuilder<R>

fn default() -> TrayIconBuilder<R>

Returns the “default value” for a type.