Skip to main content

Tray

Struct Tray 

Source
pub struct Tray<Msg> { /* private fields */ }
Expand description

The application’s tray icon, described: its tooltip, its icon, its menu, what a click on it does, and whether closing the window leaves the application running in it.

Implementations§

Source§

impl<Msg> Tray<Msg>

Source

pub fn new(tooltip: impl Into<String>) -> Self

A tray icon showing tooltip when the pointer rests on it, with the application’s icon and an empty menu; a click on it brings the window forward.

Source

pub fn icon(self, icon: AppIcon) -> Self

The icon, when it is not the application’s own.

Source

pub fn item(self, label: impl Into<String>, message: Msg) -> Self

Adds an item labelled label that sends message.

Source

pub fn disabled_item(self, label: impl Into<String>) -> Self

Adds an item that is shown but cannot be chosen: a status line, or an action not available now.

Source

pub fn show_item(self, label: impl Into<String>) -> Self

Adds an item that brings the window forward, showing it if it was hidden.

Source

pub fn quit_item(self, label: impl Into<String>) -> Self

Adds an item that ends the application.

Source

pub fn separator(self) -> Self

Adds a line between items.

Source

pub fn on_click(self, message: Msg) -> Self

What a click on the icon sends, in place of bringing the window forward.

Source

pub fn keep_running(self) -> Self

Closing the window hides it, and the application goes on in the tray until a quit_item — or the system — ends it. Without one, closing the window ends the application as it always does.

Auto Trait Implementations§

§

impl<Msg> Freeze for Tray<Msg>
where Vec<TrayEntry<Msg>>: Freeze, TrayAction<Msg>: Freeze,

§

impl<Msg> RefUnwindSafe for Tray<Msg>
where Vec<TrayEntry<Msg>>: RefUnwindSafe, TrayAction<Msg>: RefUnwindSafe,

§

impl<Msg> Send for Tray<Msg>
where Vec<TrayEntry<Msg>>: Send, TrayAction<Msg>: Send,

§

impl<Msg> Sync for Tray<Msg>
where Vec<TrayEntry<Msg>>: Sync, TrayAction<Msg>: Sync,

§

impl<Msg> Unpin for Tray<Msg>
where Vec<TrayEntry<Msg>>: Unpin, TrayAction<Msg>: Unpin,

§

impl<Msg> UnsafeUnpin for Tray<Msg>
where Vec<TrayEntry<Msg>>: UnsafeUnpin, TrayAction<Msg>: UnsafeUnpin,

§

impl<Msg> UnwindSafe for Tray<Msg>
where Vec<TrayEntry<Msg>>: UnwindSafe, TrayAction<Msg>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Msg> IntoMsg<Msg> for Msg

Source§

fn defer(work: impl Fn() -> Msg + 'static) -> Msg

The message that stands for work’s result.
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more