TweetFollow Us on Twitter

Sprocket Menus 1
Volume Number:11
Issue Number:5
Column Tag:Getting Started

Sprocket Menus, Part 1

By Dave Mark, MacTech Magazine Regular Contributing Author

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

My February ’93 Getting Started column featured a program called MenuMaster. MenuMaster constructed a menu bar consisting of four menus: The traditional Apple, File, and Edit menus, as well as a special Options menu (Figure 1). Selecting the first item changes it from Change My Name to Change Me Back Again. Selecting the first item again changes it back to Change My Name.

Selecting Disable Me disables the second item and enables the third item. If you then select the newly enabled Enable Previous Item, it gets disabled and Disable Me is reenabled.

If you select Add Extra Menu, a new menu is inserted in the menu bar and Add Extra Menu is disabled. The new menu, titled Extra Menu, features a single item, Delete Me. Selecting Delete Me deletes the extra menu from the menu bar and reenables Add Extra Menu.

Finally, selecting Append Item adds an extra item (Can’t Delete Me...) to the end of the menu. As its names implies, there’s no way to delete this extra item.

Fig. 1. MenuMaster’s Options menu.

A Sprocket Version of MenuMaster

This month we’re going to use Sprocket to implement most of MenuMaster’s functionality. We’ll skip the ability to append an item to the end of a menu for two reasons. First, appending a single item to the end of a menu just isn’t done that often and isn’t particularly useful. More importantly (and probably for the same reason), Sprocket doesn’t give you an easy way to append a new item to a menu.

If you come up with a good reason to add this functionality to Sprocket (or if you have any comments or bugs to report), send e-mail to sprocket@hax.com.

As I mentioned last month, Sprocket based its menu-handling model on that used by OpenDoc. At the heart of this model is a replacement for the MENU resource type. A CMNU resource is just like a MENU resource, with one important addition. Each menu item features a command number. You’ll use this command number to refer to the item, instead of the more traditional method of specifying the menu the item belongs to, along with the item’s position in the menu (e.g., menu 129, item 4).

Figure 2. The CMNU resource, featuring a Cmd-Num field for each menu item.

Check out the ResEdit snapshot in Figure 2. It shows the CMNU resource that represents our new Options menu. The first menu item, Change My Name, is selected. The command number for this item is 1000. When the user selects this item, Sprocket will pass the associated command number (in this case, 1000) as a parameter to the routine HandleMenuCommand() (it’s in the file SprocketStarter.cp). Instead of creating a separate item dispatch routine for each menu (HandleAppleMenu(), HandleFileMenu(), etc.), you’ll create a single switch statement containing cases for all your commands.

Sprocket automatically creates a menu bar at application startup. In C++ terms, Sprocket constructs a TMenuBar object, which is implemented in the files TMenuBar.cp and TMenuBar.h. Here’s the TMenuBar class definition:

class TMenuBar
 {
public:
Resource ('MBAR' and 'CMNU') Utilities
 
 OSErr  GetNewMenuBar(short whichMBAR);
 MenuRefGetMenuFromCMNU(short whichMenu);
Menu command mapping functions

 MenuCommandID   GetCommand(MenuID menu, MenuItemID item);
 void   GetMenuAndItem(MenuCommandID commandNum, 
 MenuID * returnedMenu, MenuItemID * returnedItem);
 OSErr  RegisterCommand(  MenuCommandID commandNum, 
   MenuID menu, MenuItemID item);
 OSErr  UnregisterCommand(MenuCommandID commandNum);
Menu enable/disable routines for menu items

 void   EnableCommand(MenuCommandID commandNum, 
 Boolean enable);
 void   EnableAndCheckCommand(MenuCommandID commandNum, 
 Boolean enable, Boolean check);
 void   GetItemString(MenuCommandID commandNum,
 StringPtr itemString);
 void   SetItemString(MenuCommandID commandNum,
 StringPtr itemString);
helpful utility functions
 void   HideMenuBar();
 void   ShowMenuBar();
 void   RedrawIfNeeded();
 void   Invalidate();
 void   Validate();

private:
"globals"
 static Boolean  fgMenuBarNeedsRedraw;
 static Boolean  fgMenuBarHidden;
mapping tables
 TMenuCommandTable fCommandTable;
 TMenuItemTable  fMenuItemTable;
internal methods
 MenuHandle GetMenuHandleAndItemFromCommand(
 MenuCommandID commandNum, 
 MenuID *menu,MenuItemID *item);
 };

The first member function, GetNewMenuBar() uses the specified MBAR resource to build a new menu bar. Though this version of Sprocket only creates a single menu bar, this might not be the case in the future. For now, a pointer to the menu bar object is stored in the global gMenuBar. Take a minute to open up the file SprocketMain.cp and check out the code around line 363. This is where Sprocket creates the TMenuBar object based on the MBAR resource in SprocketStarter.rsrc.

The member function GetMenuFromCMNU() loads a CMNU resource and walks through it, one item at a time. It builds a traditional menu structure, passing each item’s command number to the RegisterCommand() member function, which adds the command to Sprocket’s menu command table. If you are going to take advantage of Sprocket’s menu command mechanism, you must register your menu item commands. If you base your menus on a CMNU resource, GetMenuFromCMNU() will register your menu items automatically. If the menus in your MBAR resource correspond to a CMNU resource, Sprocket will register the menu items automatically.

If you don’t want to use a CMNU resource, you can still add and delete your menus to and from the global menu bar yourself. For example, since a font or size menu will have a dynamic number of items, the CMNU resource just doesn’t make sense. We’ll look at that process in a future column.

The member function GetCommand() takes a menu and item ID and returns the associated command. GetMenuAndItem() takes a command and returns the associated menu and item ID.

If you want to delete a menu whose commands have been registered, you can use the UnregisterCommand() member function to, one-at-a-time, unregister the commands in that menu. Otherwise, you’ll orphan commands in the command table.

EnableCommand() and EnableAndCheckCommand() let you enable, disable, check, and uncheck a menu command. GetItemString() and SetItemString() allow you to retrieve and set an items name using its command.

HideMenuBar() and ShowMenuBar() let you hide and show the menu bar (what a concept!). Invalidate() marks the menu bar as needing to be redrawn. Validate() sets the menu bar as up to date. RedrawIfNeeded() redraws the menu bar if the invalid flag has been set. Note that RedrawIfNeeded() is called in Sprocket’s main event loop, so there’s no need for you to call it yourself.

This Month’s Resources

Sprocket gets its resources from four different resource files. CreditsBox.rsrc contains the resources used to build the Sprocket about box. StandardMenus.rsrc contains some standard MENU and CMNU resources. If you want to change any of these menus, copy the appropriate resource from StandardMenus.rsrc into SprocketStarter.rsrc and delete the original from StandardMenus.rsrc. Modify the version you copied into SprocketStarter.rsrc.

Sprocket.rsrc contains various resources used by Sprocket and should not be modified. SprocketStarter.rsrc is your resource center. Put all the resources you add to Sprocket there.

You’ll need to modify one resource and add three new ones to SprocketStarter.rsrc. First, open up MBAR 128 and add menu ID 1000 to the list already in place.

If you’re not using Projector (the sourced code control system), you might want to delete the ckid resources you’ll find in each of the resource files. That will get rid of the annoying link error complaining about the multiply-defined resource.

Next, you’ll create your three CMNU resources. The first represents the Options menu we want to add to the end of the menu bar. In general, when you add a new resource to Sprocket, you’ll start numbering your resources from 1000, instead of at 128 the way you normally would. This is just a convention, and might change as Sprocket grows up.

When you create CMNU 1000, be sure to change the resource ID in both places: once in the “Get Info” box and also in the “Edit Menu and MDEF ID” dialog.

Figure 3. CMNU 1000

Enter a command number of 1000 for the item Change My Name, 1001 for Disable Me, 1002 for Enable Previous Item, 1003 for Add Extra Menu, and 1004 for Beeps. Next, disable the item Enable Previous Item. After that, click on the Beeps item, check the has SubMenu checkbox and enter 100 as the submenu ID (Figure 4). Since submenu IDs are limited to a single byte, we won’t be able to give the submenu CMNU resource an ID greater than 1000. So much for sticking to conventions!

Figure 4. The Beeps item, with its submenu ID of 100 entered.

Next, create a new CMNU resource with an ID of 1001 (Once again, be sure to change the ID in both places). The menu will have a title of Extra Menu and a single item, Delete This Menu. Give the item Delete This Menu a command of 1007 (Figure 5).

Figure 5. CMNU 1001

Finally, create a CMNU resource with an ID of 100. Add two items, Beep Once with a command ID of 1005 and Beep Twice with a command ID of 1006 (Figure 6).

Figure 6. CMNU 100.

Save your changes and quit your resource editor.

Modifying the Source Code

Now launch CodeWarrior or Symantec C++ and edit SprocketStarter.h. Start by adding this global reference to the file:

extern Boolean   gItemNameChanged;

gItemNameChanged is a Boolean that indicates whether the item Change My Name has been selected. It tells us whether the item should read Change My Name or Change Me Back Again.

Next, add this enum to the file:

enum
{
 mSubMenu = 100,
 mExtraMenu = 1001,
 
 cChangeName= 1000,
 cDisableMe = 1001,
 cEnablePrevious = 1002,
 cAddExtraMenu   = 1003,
 cBeeps = 1004,
 cBeepOnce= 1005,
 cBeepTwice = 1006,
 cDeleteExtraMenu= 1007
};

The first two constants specify the two CMNU resource IDs. The next 8 specify the menu command IDs. Notice that the menu constants start with a lower case “m” and the commands start with a lower case “c”. Unfortunately, the Apple event registry starts all its class names with a lower-case “c”, so be on the lookout for name collisions.

Next, add these three constants to the file:

const StringPtr kUnchangedName = "\pChange My Name";
const StringPtr kChangedName = "\pChange Me Back Again";
const short kLastMenu = 0;

The first two are just Pascal strings we used for the menu names. We really should have implemented these strings as ‘STR ’ resources to make the code easier to localize. In general, I try never to specify strings in code, but I guess I was just feeling a bit lazy.

The last constant will be used in our call of InsertMenu(), telling InsertMenu() to insert the menu at the end of the menu bar.

Next, edit the file SprocketStarter.cp. Start by adding this global definition at the top of the file:

Boolean gItemNameChanged = false;

Next, add these three lines to the beginning of the routine SetUpApplication():

MenuRef hierMenu;

hierMenu = gMenuBar->GetMenuFromCMNU( mSubMenu );
InsertMenu( hierMenu, -1 ); 

GetMenuFromCMNU() loads CMNU 100, registers all the commands, and returns a MenuHandle to a standard menu based on the CMNU resource. InsertMenu() inserts the resulting menu in the menu bar.

Finally, add the cases to handle our new commands to the switch in HandleMenuCommand() further down in SprocketStarter.cp. Here’s my edited copy of HandleMenuCommand():

HandleMenuCommand
void
HandleMenuCommand(MenuCommandID theCommand)
 {
 MenuRefextraMenu;
 OSErr  err;
 
 switch (theCommand)
 {
 case cAbout:
 AboutBox();
 break;
 
 case cNew:
 CreateNewDocument();
 break;
 
 case cOpen:
 OpenExistingDocument();
 break;
 
 case cPreferences:
 TPreferencesDialogWindow * prefsDialog = 
 new TPreferencesDialogWindow;
 break;
 
#ifqAOCEAware
 case cNewMailableWindow:
 TMailableDocWindow *aWackyThing = new TMailableDocWindow;
 break;
#endif

Here come the new commands. This first one switches the first menu item between Change My Name and Change Me Back Again. Notice that we’re using the global TMenuBar object to change the menus. If Sprocket ever gets modified to use more than one menu bar, we’ll have to modify this code to be sure we use the menu bar that contains the menu we want to work with. Of course, if that happens, you can count on some sample code in this column to show you how to do that.

 case cChangeName:
 if ( gItemNameChanged )
 gMenuBar->SetItemString( cChangeName, kUnchangedName );
 else
 gMenuBar->SetItemString( cChangeName, kChangedName );
 gItemNameChanged = ! gItemNameChanged;
 break;

This command disables Disable Me and enables Enable Previous Item.

 case cDisableMe:
 gMenuBar->EnableCommand( cDisableMe, false );
 gMenuBar->EnableCommand( cEnablePrevious, true );
 break;

This command does just the opposite.

 case cEnablePrevious:
 gMenuBar->EnableCommand( cDisableMe, true );
 gMenuBar->EnableCommand( cEnablePrevious, false );
 break;

This command disables the item that spawned this command in the first place (Add Extra Menu), then builds a new menu from the extra menu CMNU resource. We add the new menu to the end of the menu bar, then call Invalidate() to force the menu bar to get redrawn.

 case cAddExtraMenu:
 gMenuBar->EnableCommand( cAddExtraMenu, false );
 extraMenu = gMenuBar->GetMenuFromCMNU( mExtraMenu );
 InsertMenu( extraMenu, kLastMenu );

 gMenuBar->Invalidate();
 break;

This command deletes the extra menu we added with the previous command. First, we reenable the Add Extra Menu item. Notice that we didn’t have to retrieve the menu that this item belongs to. All we needed was the command. This definitely makes life a lot simpler.

 case cDeleteExtraMenu:
 gMenuBar->EnableCommand( cAddExtraMenu, true );

Since the TMenuBar class doesn’t support a DeleteCMNU() method, we’ll have to deregister the command by hand. A DeleteCMNU() method would step through all the items in the specified menu, calling UnregisterCommand() for each item. It would then delete the menu for us. Since our extra menu only contains a single item, it’s no big deal to do this by hand. Once we are done, we’ll force a menu bar redraw. Look for a DeleteCMNU() method in a future version of Sprocket.

 err = gMenuBar->UnregisterCommand( cDeleteExtraMenu );
 DeleteMenu( mExtraMenu );
 
 gMenuBar->Invalidate();
 break;

This next command corresponds to the parent menu of our hierarchical submenu. Normally, this command will never get called because the menu manager won’t detect a selection of the parent item of a submenu (Figure 7). There are times when this is useful, however. For example, imagine if you built a menu of applications, where each application item had a submenu listing some frequently used documents that can be opened by that application (NowMenus does this). If you select a document from a submenu, its parent application gets launched and opens the selected document. If you release the mouse with the application selected (without selecting a document from the submenu), you might want to launch the application without specifying a document.

The point here is this: Specify commands for all your menu items, even the hierarchical parent menus. A future version of Sprocket might include a workaround to execute commands associated with these currently orphaned items.

 case cBeeps:
 break;

Figure 7. A menu item with its submenu showing.
If the mouse button was released at this point, the Beeps item
(rather than either of the submenu items) would be selected.

These next two items are horribly technical. They beep either once or twice, depending on the item selected.

 case cBeepOnce:
 SysBeep( 20 );
 break;
 case cBeepTwice:
 SysBeep( 20 ); SysBeep( 20 );
 break;
 default:
 break;
 }
 }

Till Next Month

There are still some concepts that we need to get into regarding Sprocket and menus. For example, when do you make the decision about which menu items you will enable and disable to ensure that things are set up correctly before a user makes a selection from a menu. How should the frontmost window affect which menu items are enabled or disabled? We’ll explore these important issues in next month’s column. See you then!

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple GarageBand 10.1 - Complete recordi...
The new GarageBand is a whole music creation studio right inside your Mac -- complete with keyboard, synths, orchestral and percussion instruments, presets for guitar and voice, an entirely... Read more
Duplicate Annihilator 5.7.7 - Find and d...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator... Read more
OS X Server 4.1.3 - For OS X 10.10 Yosem...
Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, develop software, host your own website, publish wikis, configure Mac, iPhone,... Read more
Firefox 39.0 - Fast, safe Web browser. (...
Firefox offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and casual... Read more
pwSafe 4.1 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
Kodi 15.0.rc1 - Powerful media center to...
Kodi (was XBMC) is an award-winning free and open-source (GPL) software media player and entertainment hub that can be installed on Linux, OS X, Windows, iOS, and Android, featuring a 10-foot user... Read more
Coda 2.5.11 - One-window Web development...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few surprises... Read more
Bookends 12.5.7 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Access the power of Bookends directly from Mellel, Nisus Writer Pro, or MS Word (... Read more
Maya 2016 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
RapidWeaver 6.2.3 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more

Rage of Bahamut is Giving Almost All of...
The App Store isn't what it used to be back in 2012, so it's not unexpected to see some games changing their structures with the times. Now we can add Rage of Bahamut to that list with the recent announcement that the game is severely cutting back... | Read more »
Adventures of Pip (Games)
Adventures of Pip 1.0 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ** ONE WEEK ONLY — 66% OFF! *** “Adventures of Pip is a delightful little platformer full of charm, challenge and impeccable... | Read more »
Divide By Sheep - Tips, Tricks, and Stre...
Who would have thought splitting up sheep could be so involved? Anyone who’s played Divide by Sheep, that’s who! While we’re not about to give you complete solutions to everything (because that’s just cheating), we will happily give you some... | Read more »
NaturalMotion and Zynga Have Started Tea...
An official sequel to 2012's CSR Racing is officially on the way, with Zynga and NaturalMotion releasing a short teaser trailer to get everyone excited. Well, as excited as one can get from a trailer with no gameplay footage, anyway. [Read more] | Read more »
Grab a Friend and Pick up Overkill 3, Be...
Overkill 3 is a pretty enjoyable third-person shooter that was sort of begging for some online multiplayer. Fortunately the begging can stop, because its newest update has added an online co-op mode. [Read more] | Read more »
Scanner Pro's Newest Update Adds Au...
Scanner Pro is one of the most popular document scanning apps on iOS, thanks in no small part to its near-constant updates, I'm sure. Now we're up to update number six, and it adds some pretty handy new features. [Read more] | Read more »
Heroki (Games)
Heroki 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: CLEAR THE SKIES FOR A NEW HERO!The peaceful sky village of Levantia is in danger! The dastardly Dr. N. Forchin and his accomplice,... | Read more »
Wars of the Roses (Games)
Wars of the Roses 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
TapMon Battle (Games)
TapMon Battle 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: It's time to battle!Tap! Tap! Tap! Try tap a egg to hatch a Tapmon!Do a battle with another tapmons using your hatched tapmons! *... | Read more »
Alchemic Dungeons (Games)
Alchemic Dungeons 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: ### Release Event! ### 2.99$->0.99$ for limited time! ### Roguelike Role Playing Game! ### Alchemic Dungeons is roguelike... | Read more »

Price Scanner via MacPrices.net

RamDisk4Mac App Helps Run Your Mac Faster And...
Ever use a RAM disk? If you’ve come to the Mac in the OS X era, likely not. The Classic Mac OS had a RAM disk function built-in, but that was dropped in the conversion to OS X. What is a RAM disk?... Read more
13-inch 1.6GHz MacBook Air on sale for $849,...
Best Buy has the 2015 13″ 1.6GHz/128GB MacBook Air on sale for $849.99 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Apple Refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished iMacs available for up to $380 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27″ 3.5GHz 5K iMac – $1949 $... Read more
Apple refurbished 2014 13-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and... Read more
Seagate Backup Plus Drives Feature 200GB of C...
Seagate Technology plc has announced that its Backup Plus family of external storage offerings will now include 200GB of OneDrive cloud storage, a major added value, and the addition of Lyve’s photo... Read more
Canon PIXMA MG3620 Wireless Inkjet All-in-One...
Canon U.S.A., Inc. has announced the PIXMA MG3620 Wireless (1) Inkjet All-in-One (AIO) printer for high-quality photo and document printing. Built with convenience in mind for the everyday home user... Read more
July 4th Holiday Weekend 13-inch MacBook Pro...
Save up to $150 on the purchase of a new 2015 13″ Retina MacBook Pro at the following resellers this weekend. Shipping is free with each model: 2.7GHz/128GB MSRP $1299 2.7GHz/... Read more
27-inch 3.5GHz 5K iMac on sale for $2149, sav...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2149.99. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary. Their price is $... Read more
Apple now offering refurbished 2015 11-inch...
The Apple Store is now offering Apple Certified Refurbished 2015 11″ MacBook Airs as well as 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.5GHz Retina MacBook Pro on sale for $2274 including free shipping. Their price is $225 off MSRP, and it’s the lowest price available for this model. Read more

Jobs Board

*Apple* Music Producer - Apple (United State...
**Job Summary** Apple Music seeks a Producer to help shepherd some of the most important content and editorial initiatives within the music app, with a particular focus Read more
Editor, *Apple* News - Apple (United States...
**Job Summary** Editor, Apple News The Apple News team is looking for passionate, knowledgeable editors to help identify and deliver the best in breaking national, Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
Engineering Project Manager - *Apple* Searc...
**Job Summary** Apple 's new Spotlight Suggestions service provides fast, relevant search results from the Inte et in Spotlight and Safari on iOS and OS X. We are looking Read more
Business Development Manager - *Apple* Pay...
**Job Summary** Apple Pay is seeking an experienced relationship manager to support the ongoing management of partners for the Apple Pay platform. This position will Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.