Home > Articles > Home & Office Computing > Mac OS X

Carbon API Menu Options Explained

Apr 19, 2002

📄 Contents

␡

⎙ Print

< Back Page 14 of 18 Next >

This chapter is from the book 

Carbon Programming

Learn More Buy

Main Menu Manager Constants, Data Types, and Functions

Constants

For markChar Parameter of SetItemMark Calls

noMark  = 0
commandMark = 17
checkMark = 18
diamondMark = 19
appleMark = 20

For beforeID Parameter of InsertMenu to Insert a Submenu into the Submenu Portion of the Menu List

hierMenu  = -1

For options Parameter of CreateStandardFontMenu Calls

KHierarchicalFontMenuOption = 0x00000001

Modifier Key Masks for GetMenuItemModifiers and SetMenuItemModifiers Calls

kMenuCommandModifiers = 0   If no bit is set, only the Command key is used.
kMenuShiftModifier  = (1 << 0) If this bit (bit 0) is set, the Shift key is used.
kMenuOptionModifier = (1 << 1) If this bit (bit 1) is set, the Option key is used.
kMenuControlModifier = (1 << 2) If this bit (bit 2) is set, the Control key is used.
kMenuNoCommandModifier = (1 << 3) If this bit (bit 3) is set, the Command key is not used.

Menu Icon Handle Constants for GetMenuItemIconHandle and SetMenuItemIconHandle Calls

kMenuNoIcon   = 0 No icon.
kMenuIconType   = 1 'ICON' handle.
kMenuShrinkIconType = 2 32-by-32 'ICON' handle shrunk (at display time) to 16-by-16.
kMenuSmallIconType  = 3 'SICN' handle.
kMenuColorIconType  = 4 'cicn' handle.
kMenuIconSuiteType  = 5 Icon suite handle.

Menu Attributes

kMenuAttrExcludesMarkColumn = (1 << 0)
kMenuAttrAutoDisable  = (1 << 2)

Data Types

typedef struct OpaqueMenuHandle* MenuHandle;
typedef MenuHandle MenuRef;
typedef SInt16  MenuID;
typedef UInt16  MenuItemIndex;
typedef UInt32  MenuCommand;
typedef Handle  MenuBarHandle;
typedef UInt32  MenuAttributes;

Functions

Creating and Disposing of Menus

MenuRef NewMenu(MenuID menuID, ConstStr255Param menuTitle);
MenuRef GetMenu(short resourceID);
void  DisposeMenu(MenuRef theMenu);

Creating a Help Menu (Mac OS X)

OSStatus HMGetHelpMenu(MenuRef *outHelpMenu,MenuItemIndex *outFirstCustomItemIndex);

Adding Menus to and Removing Menus from the Current Menu List

void  InsertMenu(MenuRef theMenu,MenuID beforeID);
void  DeleteMenu(MenuID menuID);
void  ClearMenuBar(void);

Getting a MenuBar Description from an 'MBAR' resource

MenuBarHandle GetNewMBar(short menuBarID);

Getting, Setting and Disposing of the Menu Bar

MenuBarHandle GetMenuBar(void);
void   SetMenuBar(MenuBarHandle mbar);
OSStatus  DisposeMenuBar(MenuBarHandle mbar);
short   GetMBarHeight(void);

Drawing the Menu Bar

void  DrawMenuBar(void);
void  InvalMenuBar(void);

Controlling Menu Bar Visibility

void  HideMenuBar(void);
void  ShowMenuBar(void);
Boolean IsMenuBarVisible(void);

Modifying the Menu Width

Boolean GetMenuExcludesMarkColumn(MenuRef menu);
OSStatus SetMenuExcludesMarkColumn(MenuRef menu,Boolean excludesMark);

Responding to User Choice of a Menu Command

Uint32 MenuEvent(const EventRecord *inEvent);
long  MenuSelect(Point startPt);
long  MenuChoice(void);
void  HiliteMenu(MenuID menuID);
long  PopUpMenuSelect(MenuRef menu,short top,short left,short popUpItem);

Getting a Reference to a Menu object

MenuRef GetMenuRef(MenuID menuID);

Adding and Deleting Menu Items

void  AppendMenu(MenuRef menu,ConstStr255Param data);
void  InsertMenuItem(MenuRef theMenu,ConstStr255Param itemString,short afterItem);
OSStatus AppendMenuItemText(MenuRef menu,ConstStr255Param inString);
OSStatus AppendMenuItemTextWithCFString(MenuRef menu,CFStringRef inString,
   MenuItemAttributes inAttributes,MenuCommand inCommandID,MenuItemIndex *outNewItem);
OSStatus InsertMenuItemText(MenuRef menu,ConstStr255Param inString,UInt16 afterItem);
OSStatus InsertMenuItemTextWithCFString(MenuRef menu,CFStringRef inString,
   MenuItemIndex inAfterItem,MenuItemAttributes inAttributes,MenuCommand inCommandID);
void  DeleteMenuItem(MenuRef theMenu,short item);
void  AppendResMenu(MenuRef theMenu,ResType theType);
void  InsertResMenu(MenuRef theMenu,ResType theType,short afterItem);

Enabling and Disabling Menus, Menu Items, and Menu Item Icons

void  EnableMenuItem(MenuRef theMenu,MenuItemIndex item);
void  DisableMenuItem(MenuRef theMenu,MenuItemIndex item);
Boolean IsMenuItemEnabled(MenuRef menu,MenuItemIndex item);
void  DisableAllMenuItems(MenuRef theMenu);
void  EnableAllMenuItems(MenuRef theMenu);
Boolean MenuHasEnabledItems(MenuRef theMenu);
void  EnableMenuCommand(MenuRef theMenu,MenuCommand commandID);
void  DisableMenuCommand(MenuRef theMenu,MenuCommand commandID);
Boolean IsMenuCommandEnabled(MenuRef menu,MenuCommand commandID);
void  EnableMenuItemIcon(MenuRef theMenu,MenuItemIndex item);
void  DisableMenuItemIcon(MenuRef theMenu,MenuItemIndex item);
Boolean IsMenuItemIconEnabled(MenuRef menu,MenuItemIndex item);

Getting and Setting Menu Item Command IDs

OSErr  GetMenuItemCommandID(MenuRef inMenu,SInt16 inItem,UInt32 *outCommandID);
OSErr  SetMenuItemCommandID(MenuRef inMenu,SInt16 inItem,UInt32 inCommandID);

Menu Object Accessor Functions

MenuID GetMenuID(MenuRef menu);
void  SetMenuID(MenuRef menu,MenuID menuID);
SInt16 GetMenuWidth(MenuRef menu);
void  SetMenuWidth(MenuRef menu,SInt16 width);
SInt16 GetMenuHeight(MenuRef menu);
void  SetMenuHeight(MenuRef menu,SInt16 height);
StringPtr GetMenuTitle(MenuRef menu,Str255 title);
OSStatus SetMenuTitle(MenuRef menu,ConstStr255Param title);
OSStatus SetMenuTitleWithCFString(MenuRef menu,CFStringRef inString);
OSStatus GetMenuDefinition(MenuRef menu,MenuDefSpecPtr outDefSpec);
OSStatus SetMenuDefinition (MenuRef menu,const MenuDefSpec *defSpec);

Manipulating and Accessing Menu Item Characteristics

void  GetMenuItemText(MenuRef menu,short item,Str255 itemString);
void  SetMenuItemText(MenuRef theMenu, short item, ConstStr255Param itemString);
OSStatus SetMenuItemTextWithCFString(MenuRef menu,MenuItemIndex item,CFStringRef inString);
void  GetItemStyle(MenuRef theMenu,short item,Style* chStyle);
void  SetItemStyle(MenuRef theMenu,short item, StyleParameter chStyle);
void  GetItemMark(MenuRef theMenu,short item,CharParameter *markChar);
void  SetItemMark(MenuRef theMenu,short item,CharParameter markChar);
void  CheckMenuItem(MenuRef theMenu,short item,Boolean checked);
OSStatus GetMenuFont(MenuRef menu,SInt16 *outFontID,UInt16 *outFontSize);
OSStatus SetMenuFont(MenuRef menu,SInt16 inFontID,UInt16 inFontSize);
void  GetItemIcon(MenuRef theMenu,short item,short *iconIndex);
void  SetItemIcon(MenuRef theMenu,short item,short iconIndex);
void  GetItemCmd(MenuRef theMenu,short item,short *cmdChar);
void  SetItemCmd(MenuRef theMenu,short item,short cmdChar);
OSErr  GetMenuItemFontID(MenuRef inMenu,SInt16 inItem,SInt16* outFontID);
OSErr  SetMenuItemFontID(MenuRef inMenu,SInt16 inItem,SInt16 inFontID);
OSErr  GetMenuItemHierarchicalID(MenuRef inMenu,SInt16 inItem,SInt16 *outHierID);
OSErr  SetMenuItemHierarchicalID(MenuRef inMenu,SInt16 inItem,SInt16 inHierID);
OSErr  GetMenuItemIconHandle(MenuRef inMenu,SInt16 inItem,MenuIconType outIconType,
   Handle* outIconHandle);
OSErr  SetMenuItemIconHandle(MenuRef inMenu,SInt16 inItem,MenuIconType inIconType,
   Handle inIconHandle);
OSErr  GetMenuItemKeyGlyph(MenuRef inMenu,SInt16 inItem,SInt16 *outGlyph);
OSErr  SetMenuItemKeyGlyph(MenuRef inMenu,SInt16 inItem,SInt16 inGlyph);
OSErr  GetMenuItemModifiers(MenuRef inMenu,SInt16 inItem,SInt16* outModifiers);
OSErr  SetMenuItemModifiers(MenuRef inMenu,SInt16 inItem,SInt16 inModifiers);
OSErr  GetMenuItemRefCon(MenuRef inMenu,SInt16 inItem,SInt32* outRefCon);
OSErr  SetMenuItemRefCon(MenuRef inMenu,SInt16 inItem,SInt32 inRefCon);
OSErr  GetMenuItemTextEncoding(MenuRef inMenu,SInt16 inItem,TextEncoding* outScriptID);
OSErr  SetMenuItemTextEncoding(MenuRef inMenu,SInt16 inItem,TextEncoding inScriptID);

Getting a Menu Reference and Menu ID from a Command ID

OSStatus GetIndMenuItemWithCommandID(MenuRef menu,MenuCommand commandID,UInt32 itemIndex,
   MenuRef *outMenu,MenuItemIndex *outIndex);

Associating Data with Menu Items

OSStatus SetMenuCommandProperty(MenuRef menu,MenuCommand commandID,OSType propertyCreator,
   OSType propertyTag,ByteCount propertySize,const void *propertyData);
OSStatus GetMenuCommandPropertySize(MenuRef menu,MenuCommand commandID,OSType propertyCreator,
   OSType propertyTag,ByteCount *size);
OSStatus GetMenuCommandProperty(MenuRef menu,MenuCommand commandID,OSType propertyCreator,
   OSType propertyTag,ByteCount bufferSize,ByteCount *actualSize,void *propertyBuffer);
OSStatus RemoveMenuCommandProperty(MenuRef menu,MenuCommand commandID,OSType propertyCreator,
   OSType propertyTag);

Counting Items in a Menu

short  CountMenuItems(MenuRef theMenu);
ItemCount CountMenuItemsWithCommandID(MenuRef menu,MenuCommand commandID);

Building and Updating Font Menus and Obtaining Font Family and Style

OSStatus CreateStandardFontMenu(MenuRef menu,MenuItemIndex afterItem,MenuID firstHierMenuID,
   OptionBits options,ItemCount *outHierMenuCount);
OSStatus UpdateStandardFontMenu(MenuRef menu,ItemCount *outHierMenuCount);
OSStatus GetFontFamilyFromMenuSelection(MenuRef menu,MenuItemIndex item,
   FMFontFamily *outFontFamily,FMFontStyle *outStyle);

Recalculating Menu Dimensions

void  CalcMenuSize(MenuRef theMenu);

Highlighting the Menu Bar

void  FlashMenuBar(MenuID menuID);

< Back Page 14 of 18 Next >

🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Privacy Notice

Overview

Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security

Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children

This site is not directed to children under the age of 13.

Marketing

Pearson may send or direct marketing communications to users, provided that

Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
Such marketing is consistent with applicable law and Pearson's legal obligations.
Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out

Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

As required by law.
With the consent of the individual (or their parent, if the individual is a minor)
In response to a subpoena, court order or legal process, to the extent permitted or required by law
To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
To investigate or address actual or suspected fraud or other illegal activities
To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links

This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020

Email Address