Struct workflow_nw::ipc::imports::Tray

pub struct Tray { /* private fields */ }

Interface for creating system tray icons and menus. For usage example please refer to nw_sys::tray

Tray is an abstraction of different controls on different platforms, usually it’s a small icon shown on the OS’s notification area. On Mac OS X it’s called Status Item, on GTK it’s Status Icon, and on Windows it’s System Tray Icon.

⧉ NWJS Documentation

Implementations

impl Tray

pub fn new(options: &Options) -> Tray

Synopsis

//Create a tray icon
let tray = nw_sys::Tray::new(&nw_sys::tray::Options::new().title("Tray").icon("img/icon.png"));

Create a new Tray, option is an contains initial settings for the Tray. Every field has its own property in the Tray, see documentation of each property for details.

⧉ NWJS Documentation

impl Tray

pub fn title(&self) -> String

Get the title of the tray.

⧉ NWJS Documentation

impl Tray

pub fn set_title(&self, title: &str)

Set the title of the tray.

⧉ NWJS Documentation

impl Tray

pub fn tooltip(&self) -> String

Get the tooltip of the tray.

⧉ NWJS Documentation

impl Tray

pub fn set_tooltip(&self, tooltip: &str)

Set the tooltip of the tray. tooltip shows when you hover the Tray with mouse. On Mac OS X title will be showed on status bar along with its icon, but it doesn’t have effects on GTK and Windows, since the latter two platforms only support tray to be showed as icons.

Note:

tooltip is showed on all three platforms. Should be set as Tray property rather from option object constructor.

⧉ NWJS Documentation

impl Tray

pub fn icon(&self) -> String

Get the icon of the tray.

⧉ NWJS Documentation

impl Tray

pub fn set_icon(&self, icon: &str)

Set the icon of the tray. Icon must a path to your icon file. It can be a relative path which points to an icon in your app, or an absolute path pointing to a file in user’s system.

Mac OS X caveat: when used in notification context, png icon is not sized down like in windows notification area, it is rather displayed in 1:1 ratio.

⧉ NWJS Documentation

impl Tray

pub fn alticon(&self) -> String

(Mac) Get the alternate (active) tray icon.

⧉ NWJS Documentation

impl Tray

pub fn set_alticon(&self, alticon: &str)

(Mac) Set the alternate (active) tray icon.

⧉ NWJS Documentation

impl Tray

pub fn icons_are_templates(&self) -> bool

(Mac) Get whether icon and alticon images are treated as “templates” (true by default). When the property is set to true the images are treated as “templates” and the system automatically ensures proper styling according to the various states of the status item (e.g. dark menu, light menu, etc.). Template images should consist only of black and clear colours and can use the alpha channel in the image to adjust the opacity of black content.

⧉ NWJS Documentation

impl Tray

pub fn set_icons_are_templates(&self, value: bool)

(Mac) Set whether icon and alticon images are treated as “templates” (true by default).

⧉ NWJS Documentation

impl Tray

pub fn menu(&self) -> Option<Menu>

Get the menu of the tray

⧉ NWJS Documentation

impl Tray

pub fn set_menu(&self, menu: &Menu)

Set the menu of the tray, menu will be showed when you click on the tray icon.

let menu = nw_sys::Menu::new();
menu.append(&nw_sys::MenuItem::new(&nw_sys::menu_item::Options::new().label("Menu 1")));
tray.set_menu(&menu);

⧉ NWJS Documentation

impl Tray

pub fn remove(&self)

Remove the tray

tray = null;<–– TODO

Once removed, you will not be able to show it again and you should set your tray variable to null to make it garbage collected. There is no way temporarily hide a tray icon.

⧉ NWJS Documentation

impl Tray

pub fn on(&self, event: &str, callback: &Function)

Event handling: Click

Emitted when user clicks the menu item with left mouse button.

⧉ NWJS Documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Tray

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Tray> for Tray

fn as_ref(&self) -> &Tray

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Tray

fn clone(&self) -> Tray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tray

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

Formats the value using the given formatter.

impl Deref for Tray

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for Tray

fn from(obj: JsValue) -> Tray

Converts to this type from the input type.

impl From<Tray> for JsValue

fn from(obj: Tray) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Tray

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: <Tray as FromWasmAbi>::Abi) -> Tray

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Tray

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> <&'a Tray as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Tray

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> <Tray as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Tray

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Tray

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Tray

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

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

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for Tray

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Tray

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Tray as LongRefFromWasmAbi>::Abi, ) -> <Tray as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Tray

fn is_none(abi: &<Tray as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Tray

fn none() -> <&'a Tray as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Tray

fn none() -> <Tray as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Tray

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Tray>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <Tray as RefFromWasmAbi>::Abi, ) -> <Tray as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.