Enum TrayIconEvent

#[non_exhaustive]
pub enum TrayIconEvent {
    Click {
        id: TrayIconId,
        position: PhysicalPosition<f64>,
        rect: Rect,
        button: MouseButton,
        button_state: MouseButtonState,
    },
    DoubleClick {
        id: TrayIconId,
        position: PhysicalPosition<f64>,
        rect: Rect,
        button: MouseButton,
    },
    Enter {
        id: TrayIconId,
        position: PhysicalPosition<f64>,
        rect: Rect,
    },
    Move {
        id: TrayIconId,
        position: PhysicalPosition<f64>,
        rect: Rect,
    },
    Leave {
        id: TrayIconId,
        position: PhysicalPosition<f64>,
        rect: Rect,
    },
}

Describes a tray icon event.

Platform-specific:

• Linux: Unsupported. The event is not emmited even though the icon is shown and will still show a context menu on right click.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Click

A click happened on the tray icon.

Fields

id: TrayIconId

Id of the tray icon which triggered this event.

position: PhysicalPosition<f64>

Physical Position of this event.

rect: Rect

Position and size of the tray icon.

button: MouseButton

Mouse button that triggered this event.

button_state: MouseButtonState

Mouse button state when this event was triggered.

DoubleClick

A double click happened on the tray icon. Windows Only

Fields

id: TrayIconId

Id of the tray icon which triggered this event.

position: PhysicalPosition<f64>

Physical Position of this event.

rect: Rect

Position and size of the tray icon.

button: MouseButton

Mouse button that triggered this event.

Enter

The mouse entered the tray icon region.

Fields

id: TrayIconId

Id of the tray icon which triggered this event.

position: PhysicalPosition<f64>

Physical Position of this event.

rect: Rect

Position and size of the tray icon.

Move

The mouse moved over the tray icon region.

Fields

id: TrayIconId

Id of the tray icon which triggered this event.

position: PhysicalPosition<f64>

Physical Position of this event.

rect: Rect

Position and size of the tray icon.

Leave

The mouse left the tray icon region.

Fields

id: TrayIconId

Id of the tray icon which triggered this event.

position: PhysicalPosition<f64>

Physical Position of this event.

rect: Rect

Position and size of the tray icon.

Implementations

impl TrayIconEvent

pub fn id(&self) -> &TrayIconId

Returns the id of the tray icon which triggered this event.

pub fn receiver<'a>() -> &'a TrayIconEventReceiver

Gets a reference to the event channel’s TrayIconEventReceiver which can be used to listen for tray events.

Note

This will not receive any events if TrayIconEvent::set_event_handler has been called with a Some value.

pub fn set_event_handler<F: Fn(TrayIconEvent) + Send + Sync + 'static>( f: Option<F>, )

Set a handler to be called for new events. Useful for implementing custom event sender.

Note

Calling this function with a Some value, will not send new events to the channel associated with TrayIconEvent::receiver

Trait Implementations

impl Clone for TrayIconEvent

fn clone(&self) -> TrayIconEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrayIconEvent

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

Formats the value using the given formatter.