Struct tauri_runtime::SystemTray

#[non_exhaustive]
pub struct SystemTray {
    pub id: TrayId,
    pub icon: Option<Icon>,
    pub menu: Option<SystemTrayMenu>,
    pub icon_as_template: bool,
    pub menu_on_left_click: bool,
    pub title: Option<String>,
    pub on_event: Option<Box<TrayEventHandler>>,
    pub tooltip: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: TrayId

icon: Option<Icon>

menu: Option<SystemTrayMenu>

icon_as_template: bool

menu_on_left_click: bool

title: Option<String>

on_event: Option<Box<TrayEventHandler>>

tooltip: Option<String>

Implementations

impl SystemTray

pub fn new() -> Self

Creates a new system tray that only renders an icon.

pub fn menu(&self) -> Option<&SystemTrayMenu>

pub fn with_id(self, id: TrayId) -> Self

Sets the tray id.

pub fn with_icon(self, icon: Icon) -> Self

Sets the tray icon.

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

Sets the tray icon as template.

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

Sets whether the menu should appear when the tray receives a left click. Defaults to true.

pub fn with_title(self, title: &str) -> Self

pub fn with_tooltip(self, tooltip: &str) -> Self

Sets the tray icon tooltip.

Platform-specific:

• Linux: Unsupported

pub fn with_menu(self, menu: SystemTrayMenu) -> Self

Sets the menu to show when the system tray is right clicked.

pub fn on_event<F: Fn(&SystemTrayEvent) + Send + 'static>(self, f: F) -> Self

Trait Implementations

impl Clone for SystemTray

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SystemTray

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SystemTray

fn default() -> Self

Returns the “default value” for a type.