Class CheckMenuItem

A check menu item inside a Menu or Submenu and usually contains a text and a check mark or a similar toggle that corresponds to a checked and unchecked states.

Hierarchy

MenuItemBase
- CheckMenuItem

Index

Accessors

Methods

close new text setText isEnabled setEnabled setAccelerator isChecked setChecked

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: CheckMenuItemOptions): Promise<CheckMenuItem>
Create a new check menu item.
Parameters
- opts: CheckMenuItemOptions
Returns Promise<CheckMenuItem>
- Defined in menu/checkMenuItem.ts:27

text

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

Returns Promise<string>
- Defined in menu/checkMenuItem.ts:34

setText

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

isEnabled

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

Returns Promise<boolean>
- Defined in menu/checkMenuItem.ts:48

setEnabled

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

setAccelerator

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

isChecked

isChecked(): Promise<boolean>
Returns whether this check menu item is checked or not.

Returns Promise<boolean>
- Defined in menu/checkMenuItem.ts:71

setChecked

setChecked(checked: boolean): Promise<void>
Sets whether this check menu item is checked or not.
Parameters
- checked: boolean
Returns Promise<void>
- Defined in menu/checkMenuItem.ts:76