An object that manages an app’s menus.
SDK
- macOS 10.0+
Framework
- AppKit
Class
NSMenu
Topics
Managing the Menu Bar
class func menuReturns a Boolean value that indicates whether the menu bar is visible.
class func setSets whether the menu bar is visible and selectable by the user.
var menuThe menu bar height for the main menu in pixels.
Creating an NSMenu Object
init(title: String)Initializes and returns a menu having the specified title and with autoenabling of menu items turned on.
Adding and Removing Menu Items
func insertInserts a menu item into the menu at a specific location.
func insertCreates and adds a menu item at a specified location in the menu.
func addAdds a menu item to the end of the menu.
func addCreates a new menu item and adds it to the end of the menu.
func removeRemoves a menu item from the menu.
func removeRemoves the menu item at a specified location in the menu.
func itemInvoked when a menu item is modified visually (for example, its title changes).
func removeRemoves all the menu items in the menu.
Finding Menu Items
func item(withReturns the first menu item in the menu with the specified tag.
func item(withReturns the first menu item in the menu with a specified title.
func item(at: Int)Returns the menu item at a specific location of the menu.
var numberThe number of menu items in the menu, including separator items.
var items: [NSMenuAn array containing the menu items in the menu.
Finding Indices of Menu Items
func index(of: NSMenuReturns the index identifying the location of a specified menu item in the menu.
func indexReturns the index of the first menu item in the menu that has a specified title.
func indexReturns the index of the first menu item in the menu identified by a tag.
func indexReturns the index of the first menu item in the menu that has a specified action and target.
func indexReturns the index of the first menu item in the menu that has a given represented object.
func indexReturns the index of the menu item in the menu with the given submenu.
Managing Submenus
func setAssigns a menu to be a submenu of the menu controlled by a given menu item.
func submenuThe action method assigned to menu items that open submenus.
var supermenu: NSMenu?The parent menu that contains the menu as a submenu.
var isIndicates whether the menu is offscreen or attached to another menu (or if it’s the main menu).
Enabling and Disabling Menu Items
var autoenablesIndicates whether the menu automatically enables and disables its menu items.
func update()Enables or disables the menu items of the menu based on the NSMenuValidation informal protocol and sizes the menu to fit its current menu items if necessary.
Getting and Setting the Menu Font
var font: NSFont!The font of the menu and its submenus.
Handling Keyboard Equivalents
func performPerforms the action for the menu item that corresponds to the given key equivalent.
Simulating Mouse Clicks
func performCauses the application to send the action message of a specified menu item to its target.
Managing the Title
var title: StringThe title of the menu.
Configuring Menu Size
var minimumThe minimum width of the menu in screen coordinates.
var size: NSSizeThe size of the menu in screen coordinates
Getting Menu Properties
var propertiesThe available properties for the menu.
Managing Menu Change Notifications
var menuIndicates whether messages are sent to the application’s windows each time the menu changes.
Displaying Contextual Menus
var allowsIndicates whether the pop-up menu allows appending of contextual menu plug-in items.
Displaying Context-Sensitive Help
class func popDisplays a contextual menu over a view for an event.
class func popDisplays a contextual menu over a view for an event using a specified font.
func helpOverridden by subclasses to implement specialized context-sensitive help behavior.
func popPops up the menu at the specified location.
Managing Display of the State Column
var showsIndicates whether the menu displays the state column.
Controlling Allocation Zones
Handling Highlighting
var highlightedIndicates the currently highlighted item in the menu.
Managing the User Interface
var userConfigures the layout direction of menu items in the menu.
Managing the Delegate
var delegate: NSMenuThe delegate of the menu.
Handling Tracking
func cancelDismisses the menu and ends all menu tracking.
func cancelDismisses the menu and ends all menu tracking without displaying the associated animation.
Constants
struct NSMenuThese constants are used as a bitmask for specifying a set of menu or menu item properties, and are contained by the properties property.
Notifications
class let didPosted after a menu item is added to the menu.
class let didPosted after a menu item in the menu changes appearance.
class let didPosted when menu tracking begins.
class let didPosted when menu tracking ends, even if no action is sent.
class let didPosted after a menu item is removed from the menu.
class let didPosted just after the application dispatches a menu item’s action method to the menu item’s target.
class let willPosted just before the application dispatches a menu item’s action method to the menu item’s target.
Initializers
Relationships
Inherits From
See Also
Menus
class NSMenuA command item in an app menu.
protocol NSMenuThe optional methods implemented by delegates of NSMenu objects to manage menu display and handle some events.