IconMenuItem

Defined in: menu/iconMenuItem.ts:151

An icon menu item inside a Menu or Submenu and usually contains an icon and a text.

Extends

• MenuItemBase

Accessors

id

Get Signature

get id(): string

Defined in: menu/base.ts:128

The id of this item.

Returns

string

Inherited from

MenuItemBase.id

---

rid

Get Signature

get rid(): number

Defined in: core.ts:309

Returns

number

Inherited from

MenuItemBase.rid

Methods

close()

close(): Promise<void>

Defined in: core.ts:321

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Inherited from

MenuItemBase.close

---

isEnabled()

isEnabled(): Promise<boolean>

Defined in: menu/iconMenuItem.ts:177

Returns whether this icon menu item is enabled or not.

Returns

Promise<boolean>

---

setAccelerator()

setAccelerator(accelerator): Promise<void>

Defined in: menu/iconMenuItem.ts:191

Sets the accelerator for this icon menu item.

Parameters

accelerator

null | string

Returns

Promise<void>

---

setEnabled()

setEnabled(enabled): Promise<void>

Defined in: menu/iconMenuItem.ts:182

Sets whether this icon menu item is enabled or not.

Parameters

enabled

boolean

Returns

Promise<void>

---

setIcon()

setIcon(icon): Promise<void>

Defined in: menu/iconMenuItem.ts:200

Sets an icon for this icon menu item

Parameters

icon

null | string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image

Returns

Promise<void>

---

setText()

setText(text): Promise<void>

Defined in: menu/iconMenuItem.ts:168

Sets the text for this icon menu item.

Parameters

text

string

Returns

Promise<void>

---

text()

text(): Promise<string>

Defined in: menu/iconMenuItem.ts:163

Returns the text of this icon menu item.

Returns

Promise<string>

---

new()

static new(opts): Promise<IconMenuItem>

Defined in: menu/iconMenuItem.ts:158

Create a new icon menu item.

Parameters

opts

IconMenuItemOptions

Returns

Promise<IconMenuItem>