Struct workflow_nw :: ipc :: imports :: MenuItem Copy item path

impl MenuItem

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

Create MenuItem

impl MenuItem

pub fn label(&self) -> String

Get the label of a MenuItem

impl MenuItem

pub fn set_label(&self) -> String

Set the label of a MenuItem

impl MenuItem

pub fn get_type(&self) -> String

Get the type of a MenuItem

impl MenuItem

pub fn icon(&self) -> String

Get the icon of a MenuItem

impl MenuItem

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

Set the icon of a MenuItem, it 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.

It has no effect on setting icon of a separator item.

impl MenuItem

pub fn icon_is_template(&self) -> bool

(Mac) Get whether icon image is treated as “template”.

(Mac) Set whether icon image is treated as “template” (true by default). When the property is set to true the image is treated as “template” 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. It has no effects on Linux and Windows.

impl MenuItem

pub fn tooltip(&self) -> String

(Mac) Get the tooltip of a MenuItem

impl MenuItem

(Mac) Set the tooltip of a MenuItem, it can only be plain text. A tooltip is short string that describes the menu item, it will show when you hover your mouse on the item.

impl MenuItem

pub fn checked(&self) -> bool

Get whether the MenuItem is checked.

impl MenuItem

pub fn set_checked(&self, checked: bool)

Set whether the MenuItem is checked. Usually if a MenuItem is checked. There will be a mark on the left side of it. It’s used mostly to indicate whether an option is on.

impl MenuItem

pub fn enabled(&self) -> bool

Get whether the MenuItem is enabled.

impl MenuItem

pub fn set_enabled(&self, enabled: bool)

Set whether the MenuItem is enabled. An disabled MenuItem will be greyed out and you will not be able to click on it.

impl MenuItem

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

Get the submenu of a MenuItem.

impl MenuItem

pub fn set_submenu(&self, submenu: &Menu)

Set the submenu of a MenuItem, the submenu must be a Menu object. You should set submenu in the option when creating the MenuItem. Changing it at runtime is slow on some platforms.

impl MenuItem

pub fn set_click(&self, callback: &Function)

Set the submenu of a MenuItem, the submenu must be a Menu object. You should set submenu in the option when creating the MenuItem. Changing it at runtime is slow on some platforms.

impl MenuItem

pub fn key(&self) -> String

A single character string to specify the shortcut key for the menu item.

impl MenuItem

pub fn set_key(&self, key: &str)

Set shortcut key

Valid Keys for All Platforms Alphabet: a-z Digits: 0-9 Other keys on main area: [ , ] , ’ , , , . , / , ` , - , = , \ , ’ , ; , Tab Esc Down , Up , Left , Right W3C DOM Level 3 KeyboardEvent Key Values: KeyA (same as A), Escape (same as Esc), F1, ArrowDown (same as Down) etc. Special Keys for Mac Only

On Mac, you can also use special keys as shortcut key with String.fromCharCode(specialKey).

Here are some useful keys:

28: Left (←) 29: Right (→) 30: Up (↑) 31: Down (↓) 27: Escape (⎋) 11: PageUp (⇞) 12: PageDown (⇟) For full list of special keys supported on Mac, see NSMenuItem.keyEquivalent and NSEvent: Function-Key Unicodes.

impl MenuItem

pub fn modifiers(&self) -> String

Get modifier keys A string to specify the modifier keys for the shortcut of the menu item. It should be the concatenation of the following strings: cmd / command / super, shift, ctrl, alt. e.g. “cmd+shift+alt”. cmd represents different keys on all platforms: Windows key (Windows) on Windows and Linux, Apple key (⌘) on Mac. super and command are aliases of cmd.

impl MenuItem

pub fn set_modifiers(&self, key: &str)

Set modifier keys

Methods from Deref<Target = 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.

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

Applies the binary in JS operator on the two JsValues.

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.

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

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

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

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

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

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

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

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

Applies the binary < JS operator on the two JsValues.

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

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

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

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

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

Applies the binary > JS operator on the two JsValues.

pub fn unchecked_into_f64(&self) -> f64

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

Trait Implementations§

impl AsRef<JsValue> for MenuItem

fn as_ref(&self) -> &JsValue

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

impl AsRef<MenuItem> for MenuItem

fn as_ref(&self) -> &MenuItem

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

impl Clone for MenuItem

fn clone(&self) -> MenuItem

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for MenuItem

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

Formats the value using the given formatter. Read more

impl Deref for MenuItem

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for MenuItem

fn from(obj: JsValue) -> MenuItem

Converts to this type from the input type.

impl From<MenuItem> for JsValue

fn from(obj: MenuItem) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for MenuItem

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: <MenuItem as FromWasmAbi>::Abi) -> MenuItem

Recover a Self from Self::Abi. Read more

impl<'a> IntoWasmAbi for &'a MenuItem

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 MenuItem as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for MenuItem

type Abi = <JsValue as IntoWasmAbi>::Abi

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

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

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

impl JsCast for MenuItem

fn instanceof(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> MenuItem

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

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

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

fn has_type<T>(&self) -> bool
where T: JsCast,

Test whether this JS value has a type T. Read more

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. Read more

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. Read more

fn unchecked_into<T>(self) -> T
where T: JsCast,

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

fn unchecked_ref<T>(&self) -> &T
where T: JsCast,

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

fn is_instance_of<T>(&self) -> bool
where T: JsCast,

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

fn is_type_of(val: &JsValue) -> bool

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

impl LongRefFromWasmAbi for MenuItem

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = MenuItem

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for MenuItem

fn is_none(abi: &<MenuItem 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 MenuItem

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

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

impl OptionIntoWasmAbi for MenuItem

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

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

impl RefFromWasmAbi for MenuItem

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<MenuItem>

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.