Skip to main content

StatusItemSpec

Struct StatusItemSpec 

Source
pub struct StatusItemSpec {
    pub id: String,
    pub icon: Option<Icon>,
    pub raster: Option<StatusImage>,
    pub template: bool,
    pub title: String,
    pub tooltip: String,
    pub menu: Vec<MenuItem>,
    pub activate: u64,
}
Expand description

One status item: an icon in the menu bar (macOS), the notification area (Windows) or a StatusNotifierItem host’s tray (Linux), with a menu (docs/status-item.md).

Fields§

§id: String

The app’s name for the item, stable across updates: what a backend diffs by.

§icon: Option<Icon>

The glyph. None shows the title alone (macOS) or the app’s icon (elsewhere).

§raster: Option<StatusImage>

A runtime image. AppKit prefers this over icon, preserving aspect ratio and point size up to 18pt high; other backends ignore it and show icon/title as before.

§template: bool

Draw the icon as a template: its shape only, in the menu bar’s or panel’s own color, so it reads in light and dark. Symbols are always templates.

§title: String

Text beside the icon where the platform shows one (the macOS menu bar). Empty: icon only.

§tooltip: String

The hover text.

§menu: Vec<MenuItem>

The menu the item opens. Same model and dispatch as the app menu.

§activate: u64

A dispatch id (the Event::MenuAction registry) run when the user clicks the item itself, where the platform separates a click from opening the menu (a left click on macOS and Windows, the host’s “activate” on Linux). 0: a click opens the menu.

Trait Implementations§

Source§

impl Clone for StatusItemSpec

Source§

fn clone(&self) -> StatusItemSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StatusItemSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for StatusItemSpec

Source§

fn eq(&self, other: &StatusItemSpec) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StatusItemSpec

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Day API ↩ Guides· daybrite.dev