Class IconMenuItem

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

Hierarchy

MenuItemBase
- IconMenuItem

Index

Accessors

Methods

close new text setText isEnabled setEnabled setAccelerator setIcon

Accessors

rid

get rid(): number
Returns number
Inherited from MenuItemBase.rid
- Defined in core.ts:309

id

get id(): string
The id of this item.

Returns string
Inherited from MenuItemBase.id
- Defined in menu/base.ts:128

Methods

close

close(): Promise<void>
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
- Defined in core.ts:321

`Static`new

new(opts: IconMenuItemOptions): Promise<IconMenuItem>
Create a new icon menu item.
Parameters
- opts: IconMenuItemOptions
Returns Promise<IconMenuItem>
- Defined in menu/iconMenuItem.ts:158

text

text(): Promise<string>
Returns the text of this icon menu item.

Returns Promise<string>
- Defined in menu/iconMenuItem.ts:163

setText

setText(text: string): Promise<void>
Sets the text for this icon menu item.
Parameters
- text: string
Returns Promise<void>
- Defined in menu/iconMenuItem.ts:168

isEnabled

isEnabled(): Promise<boolean>
Returns whether this icon menu item is enabled or not.

Returns Promise<boolean>
- Defined in menu/iconMenuItem.ts:177

setEnabled

setEnabled(enabled: boolean): Promise<void>
Sets whether this icon menu item is enabled or not.
Parameters
- enabled: boolean
Returns Promise<void>
- Defined in menu/iconMenuItem.ts:182

setAccelerator

setAccelerator(accelerator: null | string): Promise<void>
Sets the accelerator for this icon menu item.
Parameters
- accelerator: null | string
Returns Promise<void>
- Defined in menu/iconMenuItem.ts:191

setIcon

setIcon(
    icon:
        | null
        | string
        | number[]
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Image,
): Promise<void>
Sets an icon for this icon menu item
Parameters
- icon: null | string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image
Returns Promise<void>
- Defined in menu/iconMenuItem.ts:200