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
$100.86
Apple Inc.
-0.77
MSFT
$46.76
Microsoft Corpora
+0.52
GOOG
$579.95
Google Inc.
+6.85

MacTech Search:
Community Search:

Software Updates via MacUpdate

Capture One Pro 8.0.0.433 - RAW workflow...
Capture One Pro 8 is a professional RAW converter offering you ultimate image quality with accurate colors and incredible detail from more than 300 high-end cameras -- straight out of the box. It... Read more
Adobe Acrobat Pro 11.0.09 - Powerful PDF...
Adobe Acrobat allows users to communicate and collaborate more effectively and securely. Unify a wide range of content in a single organized PDF Portfolio. Collaborate through electronic document... Read more
Adobe Reader 11.0.09 - View PDF document...
Adobe Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more
iFFmpeg 4.6.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
NTFS 11.3.62 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
OS X Yosemite 10.10 DP8 - Developer Prev...
Note: This is a Developer Preview. You must be a registered Apple Mac Developer to download this update. You can also sign up for the free OS X Beta Program to download and preview public beta... Read more
FotoMagico 4.5 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Screenshot Path 1.2.1 - Change the defau...
Screenshot Path lets you change the folder where OS X saves screenshots. Screenshots are saved by default to the user’s desktop. This is handy for the occasional screenshot but those looking to take... Read more
Fantastical 1.3.16 - Create calendar eve...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
GIMP 2.8.14 - Powerful, free image editi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more

Latest Forum Discussions

See All

Zynga Unveils First Look at Looney Tunes...
Zynga Unveils First Look at Looney Tunes Dash! Posted by Ellis Spice on September 16th, 2014 [ permalink ] Be vewy, vewy qwiet. I’m hunting wunners featuwing wabbits, and luckily, it’s duck season wunner season. | Read more »
Guardians on the Go – How to Connect to...
At this point I’m relatively certain most of the country is familiar with Destiny. And for those looking to augment their game a bit, Bungie has changed their Bungie Mobile Companion App to Destiny Companion. | Read more »
Kunin Review
Kunin Review By Jordan Minor on September 16th, 2014 Our Rating: :: SHURIKEN DO ITUniversal App - Designed for iPhone and iPad Kunin is a nervous test of ninja reflexes.   Developer: Dodreams Price: FREE Version Reviewed: 1.0.1... | Read more »
4 KEMCO Titles are Just $0.99 for a Limi...
4 KEMCO Titles are Just $0.99 for a Limited Time Posted by Jessica Fisher on September 16th, 2014 [ permalink ] KEMCO RPGs Destiny Fantasia, Infinite Dunamis, Bonds of the Sk | Read more »
Introducing Flash, the Latest Wearable F...
Introducing Flash, the Latest Wearable Fitness Monitor from Misfit Posted by Jessica Fisher on September 16th, 2014 [ permalink ] The Misfit Flash is the newly-released fitness and sleep monitor from | Read more »
Hyper Trip Review
Hyper Trip Review By Jennifer Allen on September 16th, 2014 Our Rating: :: HYPER TWITCHYUniversal App - Designed for iPhone and iPad Tough and unforgiving, Hyper Trip is a bit like Snake – if Snake was really harsh.   | Read more »
Collectible Card Game Earthcore: Shatter...
Collectible Card Game Earthcore: Shattered Elements is Set to Arrive on iOS in 2015 Posted by Ellis Spice on September 16th, 2014 [ permalink ] Polish developers | Read more »
Boogey Boy Review
Boogey Boy Review By Jennifer Allen on September 16th, 2014 Our Rating: :: PRETTY BUT BASICUniversal App - Designed for iPhone and iPad It looks delightful but lack of Game Center support and more variety really affects the fun... | Read more »
Vizzywig 4K (Photography)
Vizzywig 4K 1.0 Device: iOS iPhone Category: Photography Price: $999.99, Version: 1.0 (iTunes) Description: REQUIRES: iOS 7 on iPhone 5S with 32GB or 64GB. (Do not use iOS 8)The world's FIRST mobile 4K video capture, editing and... | Read more »
The Sleeping Prince Review
The Sleeping Prince Review By Jennifer Allen on September 15th, 2014 Our Rating: :: RESTRICTIVE KINGDOM SAVINGUniversal App - Designed for iPhone and iPad The Sleeping Prince looks and feels great to play, but its lack of peril and... | Read more »

Price Scanner via MacPrices.net

Sprint offers 16GB iPad mini for $199.99 with...
Sprint is offering 1st generation 16GB iPad minis for $199.99 with a 2-year service agreement. Standard MSRP for this iPad is $429. Their price is the lowest available for this model. Read more
2.5GHz Mac mini remains on sale for $549, sav...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Apple refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
13″ 2.5GHz MacBook Pro offered for $100 off M...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Free GIMP Professional Grade Graphics App Ver...
The latest 2.8.14 version of the oddly-named GIMP (acronym for: GNU Image Manipulation Program) open source, high-end image editing and creation alternative to Adobe’s Photoshop and refuge from... Read more
Apple Announces Record Pre-orders for iPhone...
Apple has released metrics showing a record number of first day pre-orders of iPhone 6 and iPhone 6 Plus, with over four million sold in the first 24 hours. Demand for the new iPhones exceeds the... Read more
10% off iPhone 6 and 6 Plus Otterbox cases
Get 10% off on popular Otterbox iPhone 6 and iPhone 6 Plus cases at MacMall through September 19th. Use code OTTERBOX10 to see the discount. Read more
15-inch MacBook Pros on sale for up to $125 o...
Amazon has the new 2014 15″ Retina MacBook Pros on sale for up to $125 off MSRP including free shipping: - 15″ 2.2GHz Retina MacBook Pro: $1899.99 save $100 - 15″ 2.5GHz Retina MacBook Pro: $2374... Read more
27-inch 3.2GHz iMac on sale for $1698, $101 o...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
More To Making A Larger iPad Than Expanded Sc...
CNET’s Ross Rubin has posted a thoughtful analysis of prospects for a larger display iPad Pro, noting that Microsoft and Samsung currently have the large-display touchscreen tablet category to... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.