TweetFollow Us on Twitter

PP Commanders
Volume Number:12
Issue Number:2
Column Tag:Getting Started

PowerPlant and Commanders

By Dave Mark, MacTech Magazine Regular Contributing Author

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

This month, we’re going to explore a brand new aspect of PowerPlant: the concept of commands, commanders, and the LCommander PowerPlant class. PowerPlant commands are similar to messages. You’ve already seen how messages are sent from a broadcaster (such as a button) to all listeners registered to listen to that broadcaster. The command model is slightly different.

Commands are associated with menus and keyDown events. To respond to menu selections and user keystrokes, you’ll need to create a class derived (at least in part) from the LCommander class. There are three key functions you’ll inherit and override from the LCommander base class.

• HandleKeyPress() - receives an EventRecord containing a character typed by the user.

• ObeyCommand() - receives a command number associated with a specific menu command. When we create this month’s project, you’ll see how to associate a command number with a specific menu item.

• FindCommandStatus() - gives your LCommander subclass a chance to update (i.e. enable, disable, check, uncheck, change item text) the status of the menu item associated with a specified command.

Basically, PowerPlant handles the administrative work of keeping track of which menu items need to be enabled, which pane should receive which event, etc. Every PowerPlant application has a chain of command. The chain (really a tree) starts with the LApplication object and flows downward through other objects that handle commands to the panes that will become the targets of the commands. Think of the current target as the application’s current focus. If a keystroke is entered, the corresponding keyDown event will be sent to the current target pane (perhaps a window, perhaps a textEdit pane within the window).

As you’ll see in this month’s program, you’ll have a little setup work to do, and then you’ll override the three LCommander functions described above. That’s pretty much it. Of course, as you get deeper into PowerPlant you’ll discover that there is much more you can do, but for now, concentrate on understanding the basics.

A Sneak Preview of BeepCommander

This month’s program is called BeepCommander. It features a single window type that responds to keyDowns by displaying the typed character in the window. Figure 1 shows a BeepCommander window.

Figure 1. A BeepCommander window.

BeepCommander also features a menu named Special with a single item named Beep. When you select Beep, your computer beeps (gasp!). The sneaky thing is, the Beep item is only enabled when the letter ‘x’ is typed. I know, I know, weird user interface. That’s fine. The point is to show the relationship between menus, keystrokes and the LPane and LCommander functions you’ll be overriding.

Let’s get started.

Create a New Project

The first thing you’ll need to do is create a new project, based on the PowerPlant stationery.

• Create a new folder called BeepCommander.

• Launch CodeWarrior and create a new project named BeepCommander.µ.

• In the project window, double-click on the file <PP Starter Resource>.rsrc. This will open the file in Constructor.

• In Constructor, do a Save As... and save the file in the BeepCommander folder as BeepCommander.rsrc.

(This last step tells Constructor to completely duplicate the file, and not just the resources it uses. This is definitely the right way to replace the stationery resource file.)

• Quit Constructor and return to CodeWarrior.

• Add the file BeepCommander.rsrc to the project.

• Delete the file <PP Starter Resource>.rsrc from the project.

• In the project window, double-click on the file <PP Starter Source>.cp.

• Select Save As... from the File menu and save the file as BeepCommander.cp.

Notice that the stationery file name changed from <PP Starter Resource>.rsrc to BeepCommander.cp in the project window. You might want to dog-ear this page and refer back to it the first few times you create your own PowerPlant projects. These first nine steps make a good starting point for all your new PowerPlant stationery-based projects.

Creating the Project Resources

Your next task is to add a new menu to the project and associate a command number with the menu’s item.

• Launch your favorite resource editor.

Be sure you install the appropriate resource editing templates for your resource editor. You’ll find the files PowerPlant Resorcerer TMPLs and PowerPlant ResEdit TMPLs buried in subfolders within the Metrowerks CodeWarrior folder. To install the Resorcerer templates, drag the file PowerPlant Resorcerer TMPLs into the folder Resorcerer® Templates. To install the ResEdit templates, duplicate ResEdit, then use ResEdit to edit the copy. Open the file PowerPlant ResEdit TMPLs and copy the 'TMPL' resources into your copy of ResEdit. Your copy now has the templates installed. As always, keep your original around in case things get screwed up.

• Select Open... from the File menu and open the file BeepCommander.rsrc.

• Create a new 'MENU' resource. Change its id to 131 (be sure it gets changed in both places if you are using ResEdit). Give the new menu a title of Special and create a single item called Beep. If you like, give Beep a command-key equivalent of AppleB.

• Create a 'Mcmd' resource, also with an id of 131. Add a single item with a command number of 1000.

The 'Mcmd' resource you just created associates a command number of 1000 with the Special menu’s Beep item.

Figure 2 shows the hex version of this resource in ResEdit in case you can’t get your 'Mcmd' resource template working or if you just want to check your handiwork.

Figure 2. The hex version of 'Mcmd' 131.

• Modify 'MBAR' 128, adding the new 'MENU' id (131) to the list of other 'MENU' ids already in the resource.

• Save your changes and quit your resource editor.


Now we’ll use Constructor to create the views we’ll use in this program.

• Back in CodeWarrior, double-click on the file BeepCommander.rsrc to open the file in Constructor.

• In Constructor, delete the existing “<Replace Me>” view.

• Select New Resource from the Edit menu to create a new view.

• When the New Resource dialog appears, type Single Char Window in the textEdit field, be sure the popup menu is set to LWindow, then click OK.

• Close the new view window.

• Be sure the new view is highlighted in the master view list, then select Resource Info from the Edit menu.

• When the view info window appears, change the resource id to 1000.

• Close the view info window.

• Double-click on the view name in the master view list to reopen the view editing window.

This view represents our main window, the window that will be created when you select New from our application’s File menu. We’re now going to add a pane to the window that will be reflected in our source code by the class CSingleCharPane. Just as a heads up, CSingleCharPane will be partially derived from the LCommander class and will be the target for both menu selections from our new 'MENU' and for keystrokes. More on all this later.

• Drag an LPane from the palette into the center of the view editing window.

• Double-click on the LPane to open a pane info window.

• Set the Location coordinates according to those shown in Figure 3.

• Check all four of the Binding to Superview checkboxes, keeping the pane proportional to its enclosing window.

• Change the Pane ID to 2000.

• Change the Class ID to Cmdr.

This last step is extremely important. The Class ID is what ties this view resource to the CSingleCharPane class we’ll define when we get to the source code. By the way, just as Apple reserves all lower case resource types, Metrowerks reserves all lower case Class IDs (for example, 'abcd' is reserved, but 'Abcd' is just fine).

• Save your changes and quit Constructor.

Figure 3. The pane info window for our LPane.

Adding the Source Code

Your next step is to return to CodeWarrior and type in some new source code.

• Back in CodeWarrior, create a new source code file, save it under the name CSingleCharPane.cp.

• Type in the following source code:

#include <LPane.h>
#include <LCommander.h>
#include "CSingleCharPane.h"

CSingleCharPane *
 LStream *inStream )
 return( new CSingleCharPane( inStream ) );

CSingleCharPane::CSingleCharPane( LStream *inStream ) :
 LPane( inStream )
 mChar = 'x';

 const EventRecord &inKeyEvent )
 mChar = inKeyEvent.message & charCodeMask;
 SetUpdateCommandStatus( true );
 return true;

CSingleCharPane::ObeyCommand( CommandT inCommand,
 void *ioParam )
 if ( inCommand == 1000 )
 SysBeep( 20 );
 return true;
 return LCommander::ObeyCommand(inCommand, ioParam);

 CommandT inCommand,
 Char16 &outMark,
 Str255 outName )
 if (inCommand == 1000)
 outEnabled = (mChar == 'x');
 LCommander::FindCommandStatus(inCommand, outEnabled,
 outUsesMark, outMark, outName);

 Rect   frameRect;
 short  x, y, frameWidth, frameHeight;
 const shortk  FontSize = 128;
 FontInfo myFontInfo;
 CalcLocalFrameRect( frameRect );
 frameWidth = frameRect.right - frameRect.left;
 frameHeight = frameRect.bottom -;
 TextSize( kFontSize );
 x = (frameWidth - CharWidth( mChar )) / 2
  + frameRect.left;
 GetFontInfo( &myFontInfo );
 y = frameRect.bottom - ((frameHeight - 
 myFontInfo.ascent + myFontInfo.descent) / 2);
 MoveTo( x, y );
 DrawChar( mChar );

Save your work, and add the file to the project.

Comments on SingleCharPane.cp

SingleCharPane.cp starts off with a creation function. We’ll pass that in when we register this new class by calling URegistrar::RegisterClass(). Notice that the creation routine actually creates the CSingleCharPane object. Get used to this way of doing things in PowerPlant.

Next comes the constructor. Notice that the constructor maps the input parameter to the LPane constructor. CSingleCharPane is derived from both LPane and LCommander. The data member mChar holds the last character typed. We initialize it to ‘x’, since that’s the magic character that enables the Beep item.

The function CSingleCharPane::HandleKeyPress() is inherited from the LCommander class and gets called in response to a keyDown event. The function returns true if the keystroke was handled correctly (in our case, we always return true). LCommander::SetUpdateCommandStatus(true) marks the menu bar as needing its status updated. LPane::Refresh() forces an update on the visible portion of the pane.

CSingleCharPane::ObeyCommand() is also inherited from LCommander and returns true if the command was obeyed. If we get command 1000 (that’s the command number of the Beep item), we’ll beep once and return true. Any other command causes a call to the inherited ObeyCommand(). This passes the command back up the chain to our commander. The LApplication class is the ultimate commander and has no supercommander. If the LApplication class can’t handle your command, you are out of luck!

CSingleCharPane::FindCommandStatus() is inherited from LCommander. It checks to see if the command sent to it is 1000 (the Beep item). If so, it sets the enable parameter depending on whether mChar is set to ‘x’. We could also have put a mark next to the Beep item or changed its name (try messing with these two: make the item name change to Beep followed by the current letter in the window, or add a checkmark next to the item when you type an ‘x’). If the command wasn’t a 1000, we’ll pass it back up the chain.

DrawSelf() is an LPane member function. DrawSelf() is paired with a member function named Draw(). Draw() gets called to set up the pane’s drawing environment in preparation for drawing (sort of like a call to SetPort()) and DrawSelf() is called to do the actual drawing. You might call an inherited Draw() method to prepare your derived pane for drawing, but you’ll override the DrawSelf() method to provide your own drawing method.

CSingleCharPane() calls CalcLocalFrameRect() to get our pane’s Rect. We’ll then set the font size to kFontSize, do some font calculations and draw the character in the window.

By the way, if you are trying to figure out the calling sequence for an overriding function, check out the function you are overriding. For example, when you are creating CSingleCharPane::ObeyCommand(), check out LCommander::ObeyCommand() or, even better, CPPStarterApp::ObeyCommand(). Also, get yourself a copy of Inside PowerPlant, which comes on your CodeWarrior CD and contains complete descriptions of all of these routines. You can also buy a printed copy of Inside PowerPlant directly from Metrowerks.

Adding the Include File CSingleCharPane.h

Next, we’ll create the include file CSingleCharPane.h that defines the CSingleCharPane class.

• Create a second source code file and save it as CSingleCharPane.h.

• Type in this source code:

#include <LPane.h>
#include <LCommander.h>

class CSingleCharPane : public LPane,
 public LCommander {
 enum { class_ID = 'Cmdr' };
 static CSingleCharPane *CreateSingleCharPaneStream(
 LStream *inStream );
 CSingleCharPane( LStream *inStream );
 virtual Boolean HandleKeyPress(
 const EventRecord &inKeyEvent );
 virtual Boolean ObeyCommand( 
 CommandT inCommand, void *ioParam );
 virtual void    FindCommandStatus( 
 CommandT inCommand,
 Char16 &outMark,
 Str255 outName );
 virtual void    DrawSelf();
 char   mChar;

• Save your typing and close the window.

The CSingleCharPane class is derived from both LPane and LCommander. The class definition starts off by creating the enumeration constant class_ID which has a value of 'Cmdr', the same value you typed into the LPane’s Class ID field in Constructor. Next comes all of the member function declarations and, finally, the declaration of the data member mChar.

Editing BeepCommander.cp

Your final bit of work is to add a few lines of code to BeepCommander.cp.

• Open the file BeepCommander.cp.

• Add these lines to ObeyCommand(), just after the call of LWindow::CreateWindow() and just before the call to theWindow->Show():

 CSingleCharPane *theCharPane =
 (CSingleCharPane *)theWindow->FindPaneByID( 2000 );
 theWindow->SetLatentSub( theCharPane );

• Add this line to top of the file at the end of the #include list:

#include "CSingleCharPane.h"

• Go to the top of the file and change the const window_Sample to have a value of 1000, like this:

const ResIDTwindow_Sample = 1000;  // EXAMPLE

• Finally, add this code to the constructor:

 URegistrar::RegisterClass( CSingleCharPane::class_ID,
 CSingleCharPane::CreateSingleCharPaneStream );

Till Next Month

Well, that’s about it for BeepCommander. Once all your code is in, run the darn thing. The window shown in Figure 1 will appear. Type some characters and watch the letters flash by. Notice that the Special menu is enabled only when you type the letter ‘x’. Why is the entire menu disabled and not just the Beep item? This is a feature, not a bug. PowerPlant disables a menu title when all of its items are disabled.

Next month, we’ll expand our horizons a bit more and explore yet another corner of PowerPlant. See you then...


Community Search:
MacTech Search:

Software Updates via MacUpdate

Suitcase Fusion 6 17.3.0 - Font manageme...
Suitcase Fusion 6 is the creative professional's font manager. Every professional font manager should deliver the basics: spectacular previews, powerful search tools, and efficient font organization... Read more
Nisus Writer Pro 2.1.2 - Multilingual wo...
Nisus Writer Pro is a powerful multilingual word processor, similar to its entry level products, but brings new features such as table of contents, indexing, bookmarks, widow and orphan control,... Read more
calibre 2.40.0 - Complete e-book library...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Vivaldi - An advanced browser...
Vivaldi is a browser for our friends. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind... Read more
OmniPlan 3.0 - Robust project management...
With OmniPlan, you can create logical, manageable project plans with Gantt charts, schedules, summaries, milestones, and critical paths. Break down the tasks needed to make your project a success,... Read more
Yummy FTP 1.11 - FTP/SFTP/FTPS client fo...
Yummy FTP is an FTP + SFTP + FTPS file transfer client which focuses on speed, reliability and productivity. Whether you need to transfer a few files or a few thousand, schedule automatic backups, or... Read more
Tweetbot 2.1 - Popular Twitter client. (...
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
MacPilot 8.0 - Enable over 1,200 hidden...
MacPilot gives you the power of UNIX and the simplicity of Macintosh, which means a phenomenal amount of untapped power in your hands! Use MacPilot to unlock over 1,200 features, and access them all... Read more
Typinator 6.7 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
Adobe Lightroom 6.2 - Import, develop, a...
Adobe Lightroom is available as part of Adobe Creative Cloud for as little as $9.99/month bundled with Photoshop CC as part of the photography package. Lightroom 6 is also available for purchase as a... Read more

Balloony Land offers a fresh twist on th...
Balloony Land by Palringo offers a fresh twist on the match three genre and is out now on iOS and Android. First-off, you'll be popping balloons instead of crushing candy and the balloons will float up and fill the empty spaces instead of dropping... | Read more »
Sago Mini Babies (Education)
Sago Mini Babies 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: Introducing the Sago Mini babies. Boys and girls love caring for these adorable characters. Feed Robin her favorite mush... | Read more »
PAUSE - Relaxation at your fingertip (H...
PAUSE - Relaxation at your fingertip 1.1 Device: iOS iPhone Category: Healthcare & Fitness Price: $1.99, Version: 1.1 (iTunes) Description: | Read more »
Super Sharp (Games)
Super Sharp 1.1 Device: iOS Universal Category: Games Price: $1.99, Version: 1.1 (iTunes) Description: Your finger has never been so sharp! Cut with skill to complete the 120 ingenious physics levels of Super Sharp and become a cut... | Read more »
Assembly - Graphic design for everyone...
Assembly - Graphic design for everyone 1.0 Device: iOS Universal Category: Photography Price: $2.99, Version: 1.0 (iTunes) Description: Assembly is the easiest most powerful design tool on the App Store. Create anything you can... | Read more »
Dub Dash (Games)
Dub Dash 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: ARE YOU READY FOR THE ULTIMATE CHALLENGE? UNIQUE SYMBIOSIS OF MUSIC AND GRAPHICS | Read more »
Leave Me Alone (Games)
Leave Me Alone 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: 33% off launch sale!!! Somewhere between the 1980s and 1990s there exists a world that never was. A world of skatepunks,... | Read more »
YAMGUN (Games)
YAMGUN 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: The invasion has begun! Protect the walls of the citadel against waves of enemies! But watch out, you will soon run out of ammo...... | Read more »
Chesh (Games)
Chesh 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: It’s like chess, only not at all. ***40% off for a limited time to celebrate our launch!*** Chesh is a game of skill, strategy, luck,... | Read more »
Dust: An Elysian Tail (Games)
Dust: An Elysian Tail 1.051 Device: iOS Universal Category: Games Price: $5.99, Version: 1.051 (iTunes) Description: *Dust: An Elysian Tail is a visually rich experience and thus requires devices with 1GB RAM**Please note that... | Read more »

Price Scanner via

TP-LINK Next-Gen Routers Support a Large Numb...
TP-LINK, specialists in consumer and business networking products, have announced the availability of Archer C2600, the company’s next-generation router featuring wireless AC, multi-user MIMO, and 4-... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free, and... Read more
Save up to $350 with Apple refurbished iMacs
Apple has Certified Refurbished iMacs available for up to $350 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27″ 3.5GHz 5K iMac – $1949 $350 off MSRP - 27... Read more
Mac Pros on sale for up to $300 off MSRP
B&H Photo has Mac Pros on sale for up to $300 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2818.99, $181 off MSRP - 3.5GHz 6-core Mac Pro: $3699... Read more
5K iMacs on sale for up to $150 off MSRP, fre...
B&H Photo has the 27″ 3.3GHz 5K iMac on sale for $1899.99 including free shipping plus NY tax only. Their price is $100 off MSRP. They have the 27″ 3.5GHz 5K iMac on sale for $2149, $150 off MSRP... Read more
Twelve South Redesigns BookArc For Today’s Sm...
Twelve South has announced a redesigned version of their very first product, BookArc for MacBook. Tailored specifically for the newest generation of MacBooks, BookArc holds the new, smaller Apple... Read more
Phone 6s Tips & Tricks – Tips Book For iP...
Poole, United Kingdom based Tap Guides Ltd. has announced the release and immediate availability of iPhone 6s Tips & Tricks, an in-depth eBook available in the iBookstore that’s priced just $2.99... Read more
Apple refurbished 2014 13-inch Retina MacBook...
Apple has 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 shipping is free... Read more
13-inch 2.5GHz MacBook Pro on sale for $994,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $994.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $105 off MSRP. Price valid... Read more
Is The iPad Pro Really A Serious Laptop Repla...
Probably not, at least for productive professionals and other power users. Steve Jobs declared that we’d entered the “post-PC Era” with the advent of the original iPad in 2010, a phrase we don’t hear... Read more

Jobs Board

*Apple* Desktop Analyst - KDS Staffing (Unit...
…work with some of the brightest engineers. Job Description Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Points:Depth of Read more
*Apple* Retail Online, Customer Experience R...
**Job Summary** Apple Retail's Online Store sells Apple products to customers around the world. In addition to selling Apple products with unique services such Read more
Frameworks Engineer, *Apple* Watch - Apple...
**Job Summary** Join the team that is shaping the future of software development for Apple Watch! As a software engineer on the Apple Watch Frameworks team you will Read more
Senior Manager, Global Direct Marketing *App...
**Job Summary** Apple Retail is looking for an experienced Direct Marketing Leader to join its Marketing team. This position will take a leadership role in creating Read more
*Apple* Online Store Expansion - Apple (Unit...
**Job Summary** The Online Apple Store is seeking a person to lead its expansion into new countries. Based in Cupertino, CA, this person will develop and maintain an Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.