Struct TrayIconBuilder

pub struct TrayIconBuilder { /* private fields */ }

TrayIcon builder struct and associated methods.

Implementations

impl TrayIconBuilder

pub fn new() -> Self

Creates a new TrayIconBuilder with default TrayIconAttributes.

See TrayIcon::new for more info.

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

Sets the unique id to build the tray icon with.

pub fn with_menu(self, menu: Box<dyn ContextMenu>) -> 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 with_icon(self, icon: Icon) -> 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 with_tooltip<S: AsRef<str>>(self, s: S) -> Self

Set a tooltip for this tray icon.

Platform-specific:

• Linux: Unsupported.

pub fn with_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 with_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 with_icon_as_template(self, is_template: bool) -> Self

Use the icon as a template. macOS only.

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

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

pub fn id(&self) -> &TrayIconId

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

pub fn build(self) -> Result<TrayIcon>

Builds and adds a new TrayIcon to the system tray.

Trait Implementations

impl Default for TrayIconBuilder

fn default() -> TrayIconBuilder

Returns the “default value” for a type.