MenuItem
Menu item.
| Module | require("gui") |
| Type | Class |
Class methods
create(type)
Create a menu item with type.
Parameters
MenuItem::Typetype
Return
MenuItemcreate(options)
Create a menu item with options.
Parameters
ObjectoptionsMenuItem::TypetypeMenuItem::RoleroleBooleancheckedMenusubmenuBooleanvisibleBooleanenabledStringlabelAcceleratoracceleratorImageimageFunctiononClick
Return
MenuItemMethods
click()
Emulate user clicking the menu item.
setLabel(label)
Change the item's label.
Parameters
Stringlabel
getLabel()
Return the item's label.
Return
StringsetSubmenu(submenu)
Set the submenu attached to the item.
This method only works for submenu type menu items.
Parameters
Menusubmenu
getSubmenu()
Return the submenu attached to the item.
Return
MenusetChecked(checked)
Set the checked state of the item.
This method only works for radio and checkbox type menu items.
Parameters
Booleanchecked
isChecked()
Return the checked state of the item.
Return
BooleansetEnabled(enabled)
Enable/disable the item.
Parameters
Booleanenabled
isEnabled()
Return whether the item is enabled.
Return
BooleansetVisible(visible)
Show/hide the item.
Parameters
Booleanvisible
isVisible()
Return whether the item is visible to users.
Return
BooleansetAccelerator(accelerator)
Set the accelerator used to activate the item.
Parameters
Acceleratoraccelerator
setImage(image) macOS Windows
Set the item's image.
Parameters
Imageimage
getImage() macOS Windows
Return the item's image.
Return
ImageEvents
onClick(self)
Emitted when item is clicked.
Parameters
MenuItemself
Preventable
No.Delegates
validate(self)
Called before the item shows or activates, should return whether the item is enabled.
Parameters
MenuItemself
Return
Boolean