Inherits from | |
Conforms to | |
Framework | /System/Library/Frameworks/AppKit.framework |
Availability | Available in Mac OS X v10.0 and later. Not available to 64-bit applications. |
Companion guide | |
Declared in | NSMenuView.h |
The NSMenuView class handles the display of menus on the user’s screen. A menu view displays its menu either horizontally or vertically and allows the user to interact with the items of that menu, either to navigate through hierarchical menus or to select a particular item.
Note: NSMenuView
is deprecated and is no longer used to draw menus. Calling its methods will not affect the appearance of your menus. Instead, use NSView
customizations on an NSMenuItem
.
+ menuBarHeight
– setMenu:
– menu
– setHorizontal:
– isHorizontal
– setFont:
– font
– setHighlightedItemIndex:
– highlightedItemIndex
– setMenuItemCell:forItemAtIndex:
– menuItemCellForItemAtIndex:
– attachedMenuView
– attachedMenu
– isAttached
– isTornOff
– horizontalEdgePadding
– setHorizontalEdgePadding:
– update
– setNeedsSizing:
– needsSizing
– sizeToFit
– stateImageOffset
– stateImageWidth
– imageAndTitleOffset
– imageAndTitleWidth
– keyEquivalentOffset
– keyEquivalentWidth
– innerRect
– rectOfItemAtIndex:
– indexOfItemAtPoint:
– setNeedsDisplayForItemAtIndex:
– locationForSubmenu:
– setWindowFrameForAttachingToRect:onScreen:preferredEdge:popUpSelectedItem:
Returns the height of the menu bar.
+ (CGFloat)menuBarHeight
This method is superseded in Mac OS X v10.4 by the NSMenu menuBarHeight
instance method.
NSMenuView.h
Returns the menu object associated with this object’s attached menu view.
- (NSMenu *)attachedMenu
The attached menu view is the one associated with the currently visible submenu, if any.
NSMenuView.h
Returns the receiver’s attached menu view.
- (NSMenuView *)attachedMenuView
The attached menu view is the one associated with the currently visible submenu, if any.
NSMenuView.h
Attaches the submenu associated with the menu item at index.
- (void)attachSubmenuForItemAtIndex:(NSInteger)index
This method prepares the submenu for display by positioning its window and ordering it to the front.
– setWindowFrameForAttachingToRect:onScreen:preferredEdge:popUpSelectedItem:
– orderFront:
(NSWindow)NSMenuView.h
Detaches the window associated with the currently visible submenu and removes any menu item highlights.
- (void)detachSubmenu
If the submenu itself displays further submenus, this method detaches the windows associated with those submenus as well.
NSMenuView.h
Returns the default font used to draw the menu text.
- (NSFont *)font
New items use this font by default, although the item’s menu item cell can use a different font.
NSMenuView.h
Returns the index of the currently highlighted menu item, or –1 if no menu item in the menu is highlighted.
- (NSInteger)highlightedItemIndex
NSMenuView.h
Returns the amount of horizontal space used for padding menu item components.
- (CGFloat)horizontalEdgePadding
The edge padding is added to the sides of each menu item component. This space is used to provide a visual separation between components of the menu item.
NSMenuView.h
Returns the offset to the starting point of a menu item’s image and title section.
- (CGFloat)imageAndTitleOffset
The image and title section of a menu item displays an image, a title, or possibly both as a way to identify the purpose of the menu item. The value returned by this method is used for all menu items of the menu.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the maximum width of a menu item’s image and title section.
- (CGFloat)imageAndTitleWidth
The image and title section of a menu item displays an image, a title, or possibly both as a way to identify the purpose of the menu item. The value returned by this method is used for all menu items of the menu.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the index of the menu item underneath the specified or –1 if no menu item is underneath that point.
- (NSInteger)indexOfItemAtPoint:(NSPoint)point
This method considers the menu borders as part of the item when calculating whether point is in the menu item rectangle. This method invokes the rectOfItemAtIndex:
method to obtain the basic rectangle for each menu item but may adjust that rectangle before testing.
NSMenuView.h
Deprecated. Tear-off menus are not supported in Mac OS X.
- (id)initAsTearOff
NSMenuView.h
Initialized a newly allocated menu view with a specified frame rectangle.
- (id)initWithFrame:(NSRect)frame
This method is the designated initialization method for NSMenuView.
NSMenuView.h
Returns the drawing rectangle for the menu contents.
- (NSRect)innerRect
This rectangle is different (typically smaller) from the view bounds in that it does not include the space used to draw the menu borders.
– bounds
(NSView)NSMenuView.h
Returns YES
if this menu is currently attached to its parent menu, NO
otherwise.
- (BOOL)isAttached
NSMenuView.h
Returns YES
if the menu is displayed horizontally; such as for a menu bar, otherwise returns NO
.
- (BOOL)isHorizontal
NSMenuView.h
Deprecated. Tear-off menus are not supported in Mac OS X.
- (BOOL)isTornOff
Returns YES
if this menu view’s window is disassociated from its parent menu.
NSMenuView.h
Creates a new menu item cell for the newly created item and marks the menu view as needing to be resized.
- (void)itemAdded:(NSNotification *)notification
This method is registered with the menu view’s associated NSMenu object for notifications of the type NSMenuDidAddItemNotification
. The notification parameter contains the notification data.
NSMenuView.h
Marks the menu view as needing to be resized so changes in size resulting from a change in the menu will be tracked.
- (void)itemChanged:(NSNotification *)notification
This method is registered with the menu view’s associated NSMenu object for notifications of the type NSMenuDidChangeItemNotification
. The notification parameter contains the notification data.
NSMenuView.h
Removes the removed item’s menu item cell and marks the menu view as needing to be resized.
- (void)itemRemoved:(NSNotification *)notification
This method is registered with the menu view’s associated NSMenu object for notifications of the type NSMenuDidRemoveItemNotification
. The notification parameter contains the notification data.
NSMenuView.h
Returns the beginning position of the menu’s key equivalent text.
- (CGFloat)keyEquivalentOffset
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the width of the menu’s key equivalent text.
- (CGFloat)keyEquivalentWidth
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the origin of the submenu view’s window.
- (NSPoint)locationForSubmenu:(NSMenu *)aSubmenu
The aSubmenu parameter specifies the submenu being positioned and must belong to a menu item of this menu view. This method positions the submenu adjacent to its menu item as well as possible given the type of menu and the space constraints of the user’s screen.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the menu object associated with this menu view.
- (NSMenu *)menu
NSMenuView.h
Returns the menu item cell at the specified location.
- (NSMenuItemCell *)menuItemCellForItemAtIndex:(NSInteger)index
NSMenuView.h
Returns YES
if the menu view needs to be resized due to changes in the menu object, NO
otherwise.
- (BOOL)needsSizing
NSMenuView.h
Uses the associated menu object to perform the action associated with the specified item when a key equivalent is pressed.
- (void)performActionWithHighlightingForItemAtIndex:(NSInteger)index
Because the menu item at index might not currently be visible, this method provides visual feedback by highlighting the nearest visible parent menu item before performing the action. After the action has been sent, this method removes the highlighting for the menu item.
– performActionForItemAtIndex:
(NSMenu)NSMenuView.h
Returns the drawing rectangle of the specified menu item.
- (NSRect)rectOfItemAtIndex:(NSInteger)index
The drawing rectangle may not be the same width or height as the actual menu and in fact is typically smaller to account for borders drawn by the menu view.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Sets the default font to use when drawing the menu text.
- (void)setFont:(NSFont *)font
NSMenuView.h
Highlights the menu item at a specific location.
- (void)setHighlightedItemIndex:(NSInteger)index
Specify –1 for index to remove all highlighting from the menu.
The rectangle of the menu item is marked as invalid and is redrawn the next time the event loop comes around. If another menu item was previously highlighted, that menu item is redrawn without highlights when the event loop comes around again.
NSMenuView.h
Sets the orientation of the menu.
- (void)setHorizontal:(BOOL)flag
If flag is YES
, the menu’s items are displayed horizontally; otherwise the menu’s items are displayed vertically.
NSMenuView.h
Sets the horizontal padding for menu item components.
- (void)setHorizontalEdgePadding:(CGFloat)pad
NSMenuView.h
Sets the menu to be displayed in the receiver
- (void)setMenu:(NSMenu *)menu
This method invokes the setNeedsSizing:
method to force the menu view’s layout to be recalculated before drawing.
This method adds the menu view to the new NSMenu object’s list of observers. The notifications this method establishes notify this menu view when menu items in the NSMenu object are added, removed, or changed. This method removes the menu view from its previous NSMenu object’s list of observers.
NSMenuView.h
Replaces the menu item cell at a specific location.
- (void)setMenuItemCell:(NSMenuItemCell *)cell forItemAtIndex:(NSInteger)index
This method does not change the contents of the menu itself; it changes only the cell used to display the menu item at index. The old cell is released, and both the new cell and the menu view are marked as needing resizing.
NSMenuView.h
Adds the region occupied by the menu item at a specific location to the menu view’s invalid region.
- (void)setNeedsDisplayForItemAtIndex:(NSInteger)index
The region to be redrawn includes the space occupied by the menu borders. This invalid region is redrawn the next time the event loop comes around.
NSMenuView.h
Sets a flag that indicates whether the layout is invalid and needs resizing.
- (void)setNeedsSizing:(BOOL)flag
If flag is YES
, the menu contents have changed or the menu appearance has changed. This method is used internally; you should not need to invoke it directly unless you are implementing a subclass that can cause the layout to become invalid.
NSMenuView.h
Causes the menu view to resize its window so its frame is the appropriate size to attach to a specified rectangle within the screen.
- (void)setWindowFrameForAttachingToRect:(NSRect)screenRect onScreen:(NSScreen *)screen preferredEdge:(NSRectEdge)edge popUpSelectedItem:(NSInteger)selectedItemIndex
If selectedItemIndex contains a value other than –1, this method attempts to position the menu such that the item at selectedItemIndex appears on top of screenRect.
The selectedItemIndex parameter specifies the amount by which the selected item’s rectangle overlaps screenRect.
If the preferred edge, edge, cannot be honored, because there is not enough room, the opposite edge is used. If the rectangle does not completely fit either edge, this method uses the edge where there is more room.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Used internally by the menu view to cache information about the menu item geometry.
- (void)sizeToFit
This cache is updated as necessary when menu items are added, removed, or changed.
The geometry of each menu item is determined by asking its corresponding menu item cell. The menu item cell is obtained from the menuItemCellForItemAtIndex:
method.
NSMenuView.h
Returns the offset to the space reserved for state images of this menu.
- (CGFloat)stateImageOffset
The offset is used for all menu items of the menu.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Returns the maximum width of the state images used by this menu.
- (CGFloat)stateImageWidth
The width is used for all menu items of the menu.
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view information.
NSMenuView.h
Handles events sent to this menu view.
- (BOOL)trackWithEvent:(NSEvent *)event
If event is a mouse event, this method tracks the cursor position in the menu and displays the menus as appropriate. This method also handles mouse clicks that result in the selection of a menu item, in which case the menu item’s action is performed.
You should not need to use this method directly.
NSMenuView.h
Asks the associated menu object to update itself.
- (void)update
If any changes have been made to the menu’s contents, this method invokes sizeToFit
to update the menu view’s layout.
– sizeToFit
– setNeedsSizing:
– update
(NSMenu)NSMenuView.h
© 2009 Apple Inc. All Rights Reserved. (Last updated: 2009-02-04)