Struct StatusItem 

pub struct StatusItem { /* private fields */ }

What a status item shows: its icon, text and menu. Built by the closure handed to status_item, which re-runs whenever a signal it reads changes.

Implementations

impl StatusItem

pub fn new() -> StatusItem

An item with nothing set yet.

pub fn icon(self, symbol: Symbol) -> StatusItem

A platform symbol as the icon, drawn in the menu bar’s or panel’s own color.

pub fn vector(self, name: impl Into<VectorName>) -> StatusItem

A bundled vector glyph as the icon (res::vectors::…), drawn as a template: the shape in the menu bar’s or panel’s own color. The usual choice for a status item.

pub fn image(self, name: impl Into<ImageName>) -> StatusItem

A bundled image as the icon (res::images::…), drawn as it is. Call template for a monochrome glyph that should take the menu bar’s color instead.

pub fn raster(self, image: StatusImage) -> Self

A runtime RGBA image, preserving its logical width (a chart or compact status grid). AppKit renders this in color; template opts into a monochrome template. Other backends keep using the icon/vector/image fallback, if supplied. The image owns its pixels and survives closing the window that produced it.

pub fn template(self) -> StatusItem

Draw the image by its shape alone, in the menu bar’s or panel’s own color, so one glyph reads in light and dark (a macOS template image). What icon and vector already do; this opts an image or a raster in.

pub fn title<M>(self, title: impl IntoText<M>) -> StatusItem

Text beside the icon where the platform shows it (the macOS menu bar): a timer, a count, a short status. A literal, a localized text, a signal or a closure; live.

pub fn tooltip<M>(self, tooltip: impl IntoText<M>) -> StatusItem

The hover text. The same sources as title.

pub fn menu<M>(self, entries: impl MenuContent<M>) -> StatusItem

The item’s menu, built from the same entries as app_menu (a list or a derived closure). Include a menu_role(MenuRole::Quit) (or an item calling day::quit()) in an app that keeps running without a window, or the user has no way to end it.

pub fn on_activate(self, f: impl Fn() + 'static) -> StatusItem

Run f when the user clicks the item itself, where the platform tells a click apart from opening the menu (a left click on macOS and Windows; a Linux tray’s primary action). The menu then opens on a right click. Without it, any click opens the menu.

Trait Implementations

impl Default for StatusItem

fn default() -> Self

Returns the “default value” for a type.