Skip to main content

StatusItem

Struct StatusItem 

Source
pub struct StatusItem { /* private fields */ }
Expand description

A live status item. Dropping it removes the item from the bus.

Implementations§

Source§

impl StatusItem

Source

pub fn new<F>( conn: &Connection, item: Item, menu: Vec<MenuEntry>, on_event: F, ) -> Result<StatusItem, Error>
where F: FnMut(Event) + Send + 'static,

Exports the item and its menu on conn and registers with the watcher if one is running (and again whenever one starts). on_event runs on the connection’s reader thread, so it should hand the event on rather than block.

§Errors

Returns an error when the item’s or the menu’s object path is already exported on conn, when the item’s bus name cannot be owned, or when a call to the bus or the watcher fails.

Source

pub fn service(&self) -> &str

The bus name the item registered under: its own well-known name, or the connection’s unique name inside a sandbox.

Source

pub fn set_menu(&self, menu: Vec<MenuEntry>) -> Result<(), Error>

Replaces the menu and tells hosts to fetch it again.

§Errors

Returns an error when the LayoutUpdated signal cannot be sent.

Source

pub fn set_icon( &self, icon_name: &str, pixmaps: Vec<Pixmap>, ) -> Result<(), Error>

Replaces the icon (theme name and pixmaps).

§Errors

Returns an error when the NewIcon signal cannot be sent.

Source

pub fn set_title(&self, title: &str) -> Result<(), Error>

Replaces the title.

§Errors

Returns an error when the NewTitle signal cannot be sent.

Source

pub fn set_tooltip(&self, tooltip: &str) -> Result<(), Error>

Replaces the tooltip text.

§Errors

Returns an error when the NewToolTip signal cannot be sent.

Source

pub fn set_status(&self, status: Status) -> Result<(), Error>

Changes the status.

§Errors

Returns an error when the NewStatus signal cannot be sent.

Trait Implementations§

Source§

impl Drop for StatusItem

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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, 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.