Struct tray_indicator::Tray

pub struct Tray { /* private fields */ }

Implementations

impl Tray

pub fn new(guid: u128, title: &str) -> Self

pub fn set_click<F: 'static + Fn()>(&mut self, action: F)

pub fn set_menu(&mut self, menu: Vec<MenuItem>)

pub fn display(self) -> Result<(), TrayError>

pub fn exit()

pub fn set_icon(&mut self, bytes: &[u8])

Trait Implementations

impl Tray for Tray

fn id(&self) -> String

It’s a name that should be unique for this application and consistent between sessions, such as the application name itself.

fn title(&self) -> String

It’s a name that describes the application, it can be more descriptive than Id.

fn category(&self) -> Category

Describes the category of this item.

fn activate(&mut self, _x: i32, _y: i32)

Asks the status notifier item for activation, this is typically a consequence of user input, such as mouse left click over the graphical representation of the item. The application will perform any task is considered appropriate as an activation request.

fn icon_pixmap(&self) -> Vec<Icon>

Carries an ARGB32 binary representation of the icon

fn menu(&self) -> Vec<MenuItem<Self>>

The menu that you want to display

fn watcher_offine(&self) -> bool

The org.kde.StatusNotifierWatcher is offine

fn secondary_activate(&mut self, _x: i32, _y: i32)

Is to be considered a secondary and less important form of activation compared to Activate. This is typically a consequence of user input, such as mouse middle click over the graphical representation of the item. The application will perform any task is considered appropriate as an activation request.

fn scroll(&mut self, _delta: i32, _dir: &str)

The user asked for a scroll action. This is caused from input such as mouse wheel over the graphical representation of the item.

fn status(&self) -> Status

Describes the status of this item or of the associated application.

fn window_id(&self) -> i32

It’s the windowing-system dependent identifier for a window, the application can chose one of its windows to be available through this property or just set 0 if it’s not interested.

fn icon_theme_path(&self) -> String

An additional path to add to the theme search path to find the icons.

fn icon_name(&self) -> String

The item only support the context menu, the visualization should prefer showing the menu or sending ContextMenu() instead of Activate() The StatusNotifierItem can carry an icon that can be used by the visualization to identify the item.

fn overlay_icon_name(&self) -> String

The Freedesktop-compliant name of an icon. This can be used by the visualization to indicate extra state information, for instance as an overlay for the main icon.

fn overlay_icon_pixmap(&self) -> Vec<Icon>

ARGB32 binary representation of the overlay icon described in the previous paragraph.

fn attention_icon_name(&self) -> String

The Freedesktop-compliant name of an icon. this can be used by the visualization to indicate that the item is in RequestingAttention state.

fn attention_icon_pixmap(&self) -> Vec<Icon>

ARGB32 binary representation of the requesting attention icon describe in the previous paragraph.

fn attention_movie_name(&self) -> String

An item can also specify an animation associated to the RequestingAttention state. This should be either a Freedesktop-compliant icon name or a full path. The visualization can chose between the movie or AttentionIconPixmap (or using neither of those) at its discretion.

fn tool_tip(&self) -> ToolTip

Data structure that describes extra information associated to this item, that can be visualized for instance by a tooltip (or by any other mean the visualization consider appropriate.

fn text_direction(&self) -> TextDirection

Represents the way the text direction of the application. This allows the server to handle mismatches intelligently.

fn watcher_online(&self)

The org.kde.StatusNotifierWatcher is online