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.

Constructor

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 *
CSingleCharPane::CreateSingleCharPaneStream(
 LStream *inStream )
{
 return( new CSingleCharPane( inStream ) );
}


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

Boolean 
CSingleCharPane::HandleKeyPress(
 const EventRecord &inKeyEvent )
{
 mChar = inKeyEvent.message & charCodeMask;
 
 SetUpdateCommandStatus( true );
 Refresh();
 
 return true;
}


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


void
CSingleCharPane::FindCommandStatus( 
 CommandT inCommand,
 Boolean&outEnabled,
 Boolean&outUsesMark,
 Char16 &outMark,
 Str255 outName )
{
 if (inCommand == 1000)
 outEnabled = (mChar == 'x');
 else
 LCommander::FindCommandStatus(inCommand, outEnabled,
 outUsesMark, outMark, outName);
}


void
CSingleCharPane::DrawSelf()
{
 Rect   frameRect;
 short  x, y, frameWidth, frameHeight;
 const shortk  FontSize = 128;
 FontInfo myFontInfo;
 
 CalcLocalFrameRect( frameRect );
 
 frameWidth = frameRect.right - frameRect.left;
 frameHeight = frameRect.bottom - frameRect.top;
 
 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 {
public:
 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,
 Boolean&outEnabled,
 Boolean&outUsesMark,
 Char16 &outMark,
 Str255 outName );
 virtual void    DrawSelf();
 
protected:
 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...

 
AAPL
$97.67
Apple Inc.
+0.64
MSFT
$44.50
Microsoft Corpora
+0.10
GOOG
$589.02
Google Inc.
-4.33

MacTech Search:
Community Search:

Software Updates via MacUpdate

Vienna 3.0.0 RC 2 :be5265e: - RSS and At...
Vienna is a freeware and Open-Source RSS/Atom newsreader with article storage and management via a SQLite database, written in Objective-C and Cocoa, for the OS X operating system. It provides... Read more
VLC Media Player 2.1.5 - Popular multime...
VLC Media Player is a highly portable multimedia player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX, MP3, OGG, ...) as well as DVDs, VCDs, and various streaming protocols. It... Read more
Default Folder X 4.6.7 - Enhances Open a...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more
TinkerTool 5.3 - Expanded preference set...
TinkerTool is an application that gives you access to additional preference settings Apple has built into Mac OS X. This allows to activate hidden features in the operating system and in some of the... Read more
Audio Hijack Pro 2.11.0 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Intermission 1.1.1 - Pause and rewind li...
Intermission allows you to pause and rewind live audio from any application on your Mac. Intermission will buffer up to 3 hours of audio, allowing users to skip through any assortment of audio... Read more
Autopano Giga 3.6 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more
Airfoil 4.8.7 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Microsoft Remote Desktop 8.0.8 - Connect...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
xACT 2.30 - Audio compression toolkit. (...
xACT stands for X Aaudio Compression Toolkit, an application that encodes and decodes FLAC, SHN, Monkey’s Audio, TTA, Wavpack, and Apple Lossless files. It also can encode these formats to MP3, AAC... Read more

Latest Forum Discussions

See All

This Week at 148Apps: July 21-25, 2014
Another Week of Expert App Reviews   At 148Apps, we help you sort through the great ocean of apps to find the ones we think you’ll like and the ones you’ll need. Our top picks become Editor’s Choice, our stamp of approval for apps with that little... | Read more »
Reddme for iPhone - The Reddit Client (...
Reddme for iPhone - The Reddit Client 1.0 Device: iOS iPhone Category: News Price: $.99, Version: 1.0 (iTunes) Description: Reddme for iPhone is an iOS 7-optimized Reddit client that offers a refreshing new way to experience Reddit... | Read more »
Jacob Jones and the Bigfoot Mystery : Ep...
Jacob Jones and the Bigfoot Mystery : Episode 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Jacob Jones is back in Episode 2 of one of Apples 'Best of 2013' games and an App Store... | Read more »
New Trailer For Outcast Odyssey, A New K...
New Trailer For Outcast Odyssey, A New Kind of Card Battler Posted by Jennifer Allen on July 25th, 2014 [ permalink ] Out this Fall is a new kind of card battle game: Outcast Odyssey. | Read more »
Hay Day – Tip, Tricks, Strategies, and C...
Recently got into Supercell’s other huge hit, Hay Day and could do with some advice on what to do? We’ve got you covered with some helpful trips and tricks to bear in mind! Ticking Along One of the key things to keep in mind while building up that... | Read more »
Monster Head Review
Monster Head Review By Nadia Oxford on July 25th, 2014 Our Rating: :: FEEDING TIMEUniversal App - Designed for iPhone and iPad Racking up a high score with Monster Head is trickier than it first appears. The appeal wears out fairly... | Read more »
Garfield: Survival of the Fattest Coming...
Garfield: Survival of the Fattest Coming to iOS this Fall Posted by Jennifer Allen on July 25th, 2014 [ permalink ] Who loves lasagna? Me. Also everyone’s favorite grumpy fat cat, Garfield. | Read more »
Happy Flock Review
Happy Flock Review By Andrew Fisher on July 25th, 2014 Our Rating: :: HERD IT ALL BEFOREUniversal App - Designed for iPhone and iPad Underneath the gloss of Happy Flock’s visuals is a game of very little substance. It’s cute, but... | Read more »
Square Register Updates Adds Offline Pay...
Square Register Updates Adds Offline Payments Posted by Ellis Spice on July 25th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Looking For Group – Hearthstone’s Curse...
For the first time since its release (which has thankfully been a much shorter window for iPad players than their PC counterparts), Blizzard’s wildly successful Hearthstone: Heroes of Warcraft CCG is sporting some brand new content: the single... | Read more »

Price Scanner via MacPrices.net

Apple’s 2014 Back to School promotion: $100 g...
 Apple’s 2014 Back to School promotion includes a free $100 App Store Gift Card with the purchase of any new Mac (Mac mini excluded), or a $50 Gift Card with the purchase of an iPad or iPhone,... Read more
iMacs on sale for $150 off MSRP, $250 off for...
Best Buy has iMacs on sale for up to $160 off MSRP for a limited time. Choose free home shipping or free instant local store pickup (if available). Prices are valid for online orders only, in-store... Read more
Mac minis on sale for $100 off MSRP, starting...
Best Buy has Mac minis on sale for $100 off MSRP. Choose free shipping or free instant local store pickup. Prices are for online orders only, in-store prices may vary: 2.5GHz Mac mini: $499.99 2.3GHz... Read more
Global Tablet Market Grows 11% in Q2/14 Notwi...
Worldwide tablet sales grew 11.0 percent year over year in the second quarter of 2014, with shipments reaching 49.3 million units according to preliminary data from the International Data Corporation... Read more
New iPhone 6 Models to Have Staggered Release...
Digitimes’ Cage Chao and Steve Shen report that according to unnamed sources in Apple’s upstream iPhone supply chain, the new 5.5-inch iPhone will be released several months later than the new 4.7-... Read more
New iOS App Helps People Feel Good About thei...
Mobile shoppers looking for big savings at their favorite stores can turn to the Goodshop app, a new iOS app with the latest coupons and deals at more than 5,000 online stores. In addition to being a... Read more
Save on 5th generation refurbished iPod touch...
The Apple Store has Apple Certified Refurbished 5th generation iPod touches available starting at $149. Apple’s one-year warranty is included with each model, and shipping is free. Many, but not all... Read more
What Should Apple’s Next MacBook Priority Be;...
Stabley Times’ Phil Moore says that after expanding its iMac lineup with a new low end model, Apple’s next Mac hardware decision will be how it wants to approach expanding its MacBook lineup as well... Read more
ArtRage For iPhone Painting App Free During C...
ArtRage for iPhone is currently being offered for free (regularly $1.99) during Comic-Con San Diego #SDCC, July 24-27, in celebration of the upcoming ArtRage 4.5 and other 64-bit versions of the... Read more
With The Apple/IBM Alliance, Is The iPad Now...
Almost since the iPad was rolled out in 2010, and especially after Apple made a 128 GB storage configuration available in 2012, there’s been debate over whether the iPad is a serious tool for... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
WW Sales Program Manager, *Apple* Online St...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
Lead Software Engineer, *Apple* Online Stor...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
Manager, *Apple* Fullfillment Operation (AF...
…cross-functional teams to drive the highest level of program management quality for Apple . You will help plan launch strategy and demand generation programs with Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.