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
$524.94
Apple Inc.
+5.93
MSFT
$40.01
Microsoft Corpora
-0.39
GOOG
$536.10
Google Inc.
-20.44

MacTech Search:
Community Search:

Software Updates via MacUpdate

Tweetbot 1.5.1 - Popular iOS twitter cli...
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
Mac DVDRipper Pro 4.1.7 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
PDFpenPro 6.2 - Advanced PDF toolkit for...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Create... Read more
PDFpen 6.2 - Edit and annotate PDFs with...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
Monolingual 1.5.9 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. It requires a 64-bit capable Intel-based Mac and at least... Read more
Maya 2015 - 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
Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - 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
MYStuff Pro 2.0.16 - Create inventories...
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more

Latest Forum Discussions

See All

Have a Special Dead Trigger 2 Easter Bas...
Have a Special Dead Trigger 2 Easter Basket Full of Goodies, Courtesy of Madfinger Games Posted by Rob Rich on April 18th, 2014 [ permalink ] Dead Trigger 2 | Read more »
Zynga Launches Brand New Farmville Exper...
Zynga Launches Brand New Farmville Experience with Farmville 2: Country Escape Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
David. Review
David. Review By Cata Modorcea on April 18th, 2014 Our Rating: :: MINIMALISTIC IN A DIFFERENT WAYUniversal App - Designed for iPhone and iPad David is a minimalistic game wrapped inside of a soothing atmosphere in which the hero... | Read more »
Eyefi Unveils New Eyefi Cloud Service Th...
Eyefi Unveils New Eyefi Cloud Service That Allows Users to Share Media Across Personal Devices Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
Tales from the Dragon Mountain: The Lair...
Tales from the Dragon Mountain: The Lair Review By Jennifer Allen on April 18th, 2014 Our Rating: :: STEADY ADVENTURINGiPad Only App - Designed for the iPad Treading a safe path, Tales from the Dragon Mountain: The Lair is a... | Read more »
Yahoo Updates Flickr App with Advanced E...
Yahoo Updates Flickr App with Advanced Editing Features and More Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
My Incredible Body - A Kid's App to...
My Incredible Body - A Kid's App to Learn about the Human Body 1.1.00 Device: iOS Universal Category: Education Price: $2.99, Version: 1.1.00 (iTunes) Description: Wouldn’t it be cool to look inside yourself and see what was going on... | Read more »
Trials Frontier Review
Trials Frontier Review By Carter Dotson on April 18th, 2014 Our Rating: :: A ROUGH LANDINGUniversal App - Designed for iPhone and iPad Trials Frontier finally brings the famed stunt racing franchise to mobile, but how much does its... | Read more »
Evernote Business Notebook by Moleskin I...
Evernote Business Notebook by Moleskin Introduced – Support Available in Evernote for iOS Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
Sparkle Unleashed Review
Sparkle Unleashed Review By Jennifer Allen on April 18th, 2014 Our Rating: :: CLASSY MARBLE FLINGINGUniversal App - Designed for iPhone and iPad It’s a concept we’ve seen before, but Sparkle Unleashed is a solidly enjoyable orb... | Read more »

Price Scanner via MacPrices.net

iMacs on sale for up to $160 off MSRP this we...
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
iPad Airs on sale this weekend for up to $100...
Best Buy has WiFi iPad Airs on sale for $50 off MSRP and WiFi + Cellular iPad Airs on sale for $100 off MSRP on their online store for a limited time, with prices now starting at $449. Choose free... Read more
Apple restocks refurbished Mac minis starting...
The Apple Store has restocked Apple Certified Refurbished Mac minis for up to $150 off the cost of new models. Apple’s one-year warranty is included with each mini, and shipping is free: - 2.5GHz Mac... Read more
Hyundai Brings Apple CarPlay To The 2015 Sona...
Hyundai Motor America has announced it will bring Apple CarPlay functionality to the 2015 Sonata. CarPlay is pitched as a smarter, safer and easier way to use iPhone in the car and gives iPhone users... Read more
Updated iPads Coming Sooner Than We Had Thoug...
MacRumors, cites KGI securities analyst Ming Chi Kuo, well-respected as an Apple product prognisticator, saying that Apple will introduce an upgraded iPad Air and iPad mini in 2014/Q3, meaning the... Read more
Toshiba Unveils New High And Low End Laptop M...
Toshiba has announced new laptop models covering both the high-end and low-end of the notebook computer spectrum. Toshiba 4K Ultra HD Laptop Toshiba’s new Satellite P55t features one of the world’s... Read more
Save up to $270 with Apple refurbished 13-inc...
The Apple Store has Apple Certified Refurbished October 2013 13″ Retina MacBook Pros available starting at $1099, with models up to $270 off MSRP. Apple’s one-year warranty is standard, and shipping... Read more
Apple now offering refurbished iPad mini with...
The Apple Store has Certified Refurbished 2nd generation iPad minis with Retina Displays now available starting at $339. Apple’s one-year warranty is included with each model, and shipping is free.... Read more
Microsoft Blinks – Drops Microsoft Office 365...
Microsoft has dropped the annual subscription fee for Microsoft Office 365 Personal – which is needed in order to create and edit documents in Microsoft Office for iPad. However, Apple’s iOS and OS X... Read more
New AVG Vault Apps for iOS and Android Help K...
AVG Technologies N.V. an online security company for 177 million active users, has announced the launch of its latest mobile application, AVG Vault. The free app introduces an innovative user... Read more

Jobs Board

*Apple* Automotive Parts Department position...
Apple Automotive is one of the fastest growing dealer…and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we Read more
*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
*Apple* Retail - Manager - Holyoke - Apple I...
Job Summary Keeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you’re a master of them all. In the store’s fast-paced, Read more
*Apple* Retail - Manager - Apple (United Sta...
Job SummaryKeeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you're a master of them all. In the store's fast-paced, dynamic Read more
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.