TweetFollow Us on Twitter

PowerPlant
Volume Number:11
Issue Number:9
Column Tag:Getting Started

PowerPlant

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 take a look at PowerPlant, the framework included on every CodeWarrior CD. If you own Symantec C++, take heart: we’ll get to the TCL in a future column. In the meantime, follow along anyway. Who knows, you might find yourself making the switch to PowerPlant someday.

This Month’s Program

I don’t know about you but, after four month’s straight of menus, I’m ready for something else. So instead of talking about PowerPlant and menu handling (we’ll do that in a future column), this month’s program will introduce PowerPlant’s messaging system.

As you design your PowerPlant programs, you’ll work with objects called broadcasters and listeners. A broadcaster sends a message and a listener receives that message. In this month’s program, we’ll create a window containing a button. Each time the button is clicked, it will send a message to any objects registered as listeners to it. Basically, this means that the broadcasting objects’ BroadcastMessage() member function calls the listening object’s ListenToMessage() member function.

This mechanism is simpler than it sounds. As we build our project, just remember that the button is a broadcaster, and that the class CDashboardApp will be the listener.

If you have the CW6 documentation, you might want to read the section named LBroadcaster & LListener in the PowerPlant manual (chapter 8, page 93).

As is usually the case when working with a framework, we’ll take an existing PowerPlant example and modify it to suit our needs.

• Duplicate the folder “CodeWarrior6:Metrowerks PowerPlant:More PowerPlant Examples:Dashboard Starter”.

If you run one of the projects in this folder (either Dashboard68K.µ or DashboardPPC.µ), you’ll see the window shown in Figure 1. To quit the program, select Quit from the File menu. As you can see, Quit is the only item in the File menu. In a future column, we’ll add some menus and items to a PowerPlant program. For now, let’s add a button to the Dashboard window.

Figure 1. The Dashboard Starter window, before our modifications.

Editing Dashboard.PPob

CodeWarrior comes with a ResEdit-like program, named Contructor, that lets you create and edit PowerPlant-specific resources. The resource we’re interested in in this column is the PPob resource. A PPob resource is like a combination of a DLOG and DITL, but for any PowerPlant view including windows and dialogs. We’ll use Constructor to add a button to the Dashboard window.

CodeWarrior 6 ships with two different versions of Constructor. Though both will do the job, Constructor 2.0a16 is far newer than Constructor 1.0.1 and seems pretty stable for an alpha release. The screen shots and instructions in this column were all based on 2.0a16. You’ll find both versions in the CodeWarrior 6 folder, inside the Metrowerks PowerPlant subfolder.

• Launch Constructor 2.0a16 and open the file Dashboard.PPob (it’s in the same folder as the two Dashboard project files).

As you can see by the Constructor window shown in Figure 2, the file Dashboard.PPob already contains a resource. This PPob resource represents the main Dashboard window. It has a resource ID of 200 and represents an object belonging to the class LWindow.

Figure 2. The Constructor window listing the view resources in Dashboard.PPob.

Our next step is to edit this PPob resource.

• Double-click on the LWindow PPob with an id of 200.

When you double-click on PPob 200, a PPob editing window will appear (see Figure 3) showing the object view hierarchy defined by this PPob. Right now, the PPob consists of a single window.

Figure 3. A Constructor window showing PPob 200.

If you click on the window view and select Pane Information... from the Pane menu (or just double-click on the window view), a pane info window will appear (see Figure 4) allowing you to edit the selected view. In this case, the selected view describes a document window with a zoom box, no close box, positioned automatically in the Alert position on the main screen, etc. Feel free to edit this view if you like. To test your changes, quit Constructor, saving your changes, then use CodeWarrior to rerun the project.

Figure 4. The Pane Info window describing the Dashboard window.

Figure 5. The items you can place in a window using Constructor.

With the PPob 200 window in front, you should notice a palette window listing all the items you can place in a PPob view. The palette, shown in Figure 5, works just like ResEdit’s DITL palette. To add an item to a view, drag the item off the palette into the PPob window.

Here’s where we’ll add the button to the window.

• Drag an LStdButton off of the palette into the window view in the PPob 200 window.

• Double-click on the button that appears and edit the info window to match the one shown in Figure 6.

Figure 6. The info window for the LStdButton we added to our window view.

There are three important changes to make in the LStdButton info window. First, change the Pane ID: field to read 1000 (be sure the Text ID checkbox is unchecked before you change the ID). The Pane ID serves to identify the button pane from all the other panes in the PPob resource. By convention, number your panes starting at 1000 and moving upwards from there. For example, if you added three items to the Dashboard window represented by PPob 200, you’d set their Pane IDs to 1000, 1001, and 1002.

The second change to make to the LStdButton info window is to fill in the Button Title: field. Since we want our button to beep, the word Beep will make a fine button title.

The third change is to the Value Message: field. This field contains the message that will get sent when the button is clicked. The message is an integer constant that will be passed as a parameter to any objects registered as listeners to the broadcasting button. Again, by convention, we’ll number our messages starting at 1000.

That’s it. Save your changes and quit Constructor.

Dashboard68K.µ or DashboardPPC.µ

If you haven’t already, open up one of the Dashboard projects (either Dashboard68K.µ or DashboardPPC.µ). Since we want to add a button to our window, we’ll need to add the files that contain the PowerPlant classes that implement push buttons: LControl.cp and LStdControl.cp.

• In the project window, click on the triangle to the left of the group named Pane. When we add the two files, we want to add them to this group.

• Add the files LControl.cp and LStdControl.cp to the project. You’ll find them in the folder “CodeWarrior 6:Metrowerks C/C++:PowerPlant Libraries:Pane Classes”

CDashboardApp.h

• Open the file CDashboardApp.h.

• Add this line after the #include of <LApplication.h>:

#include <LListener.h>

• Change the first line of the CDashboardApp class to look like this:

class CDashboardApp : public LApplication, public LListener {

To convert the CDashboardApp class into a listener, we have to make sure it is derived from the class LListener. Deriving a class from more than one class is perfectly acceptable in C++ and is known as multiple inheritence.

Another step in making the CDashboardApp class a listener is to add a member function named ListenToMessage(). ListenToMessage() will get called when any broadcaster it is listening to broadcasts a message.

• Add this line after the definition of the member function FindCommandStatus():

 virtual void    ListenToMessage(MessageT inMessage, void *ioParam);

• Close CDashboardApp.h and save your changes.

CDashboardApp.cp

Here’s where all the action is. Take some time to look through the file and read all the comments (don’t worry, the file isn’t that long). Notice that main() defines a CDashboardApp object and then calls the member function Run() which was inherited from the LApplication class.

• Add this line after all the other #include files:

#include <LStdControl.h>

Notice that even though we added the files LStdControl.cp and LControl.cp to the project, we don’t include the file <LControl.h>. <LControl.h> is included by <LStdControl.h>.

• In the constructor, find the call of the static function URegister::RegisterClass() and add this line right below it:

 URegistrar::RegisterClass(LStdButton::class_ID,
 LStdButton::CreateStdButtonStream);

This line tells PowerPlant which function to call (LStdButton::CreateStdButtonStream()) when an object of type LStdButton is created based on a PPob resource. Before we came along, this program only needed to register the LWindow class. Since we added an LStdButton object to the PPob resource, we’ll need to register that class as well.

• Also in the constructor, just before the call of mDisplayWindow->Show(), add these lines:

 LStdButton *theButton =
 (LStdButton *)mDisplayWindow->FindPaneByID( 1000 );
 theButton->AddListener( this );

The first line searches the window mDisplayWindow for the pane with the id 1000. Now you know why we entered the number 1000 in the LStdButton’s Pane ID: field.

The second line registers the current object (the CDashboardApp object, known here as this) as a listener of the button we just found.

• At the end of the file, add the member function CDashboardApp::ListenToMessage():

// ----------------------------------------------------------
// • ListenToMessage
// ----------------------------------------------------------
// Respond to message 1000 broadcast by pushbutton

void
CDashboardApp::ListenToMessage(MessageT inMessage, void *ioParam)
{
 if ( inMessage == 1000 )
 SysBeep( 20 );
}

This function will get called whenever the button is clicked. The message 1000 will be passed in as the parameter inMessage.

Figure 7. The Dashboard window. This time it has a button in it.

Running the Program

That’s about it. Save your changes and run the program. The usual Dashboard window will appear, but this time with a button smack-dab in the middle of it. Press the button and, guess what, your Mac will beep at you.

Till Next Month

Obviously, this month’s program gives you only a brief glimpse into the PowerPlant framework. On the other hand, it’s a pretty solid glimpse. Try your hand at adding some other panes to the Dashboard window containment hierarchy. Start by adding a second button with its own pane ID and its own message ID. Next, try to add some other controls.

What part of PowerPlant would you like to learn about next? Should I get into other control types? How about (shudder) menus? Send email. I’ll be waiting to hear from you. See you next month...

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links... | Read more »
Price of Glory unleashes its 1.4 Alpha u...
As much as we all probably dislike Maths as a subject, we do have to hand it to geometry for giving us the good old Hexgrid, home of some of the best strategy games. One such example, Price of Glory, has dropped its 1.4 Alpha update, stocked full... | Read more »
The SLC 2025 kicks off this month to cro...
Ever since the Solo Leveling: Arise Championship 2025 was announced, I have been looking forward to it. The promotional clip they released a month or two back showed crowds going absolutely nuts for the previous competitions, so imagine the... | Read more »
Dive into some early Magicpunk fun as Cr...
Excellent news for fans of steampunk and magic; the Precursor Test for Magicpunk MMORPG Crystal of Atlan opens today. This rather fancy way of saying beta test will remain open until March 5th and is available for PC - boo - and Android devices -... | Read more »
Prepare to get your mind melted as Evang...
If you are a fan of sci-fi shooters and incredibly weird, mind-bending anime series, then you are in for a treat, as Goddess of Victory: Nikke is gearing up for its second collaboration with Evangelion. We were also treated to an upcoming... | Read more »
Square Enix gives with one hand and slap...
We have something of a mixed bag coming over from Square Enix HQ today. Two of their mobile games are revelling in life with new events keeping them alive, whilst another has been thrown onto the ever-growing discard pile Square is building. I... | Read more »
Let the world burn as you have some fest...
It is time to leave the world burning once again as you take a much-needed break from that whole “hero” lark and enjoy some celebrations in Genshin Impact. Version 5.4, Moonlight Amidst Dreams, will see you in Inazuma to attend the Mikawa Flower... | Read more »
Full Moon Over the Abyssal Sea lands on...
Aether Gazer has announced its latest major update, and it is one of the loveliest event names I have ever heard. Full Moon Over the Abyssal Sea is an amazing name, and it comes loaded with two side stories, a new S-grade Modifier, and some fancy... | Read more »
Open your own eatery for all the forest...
Very important question; when you read the title Zoo Restaurant, do you also immediately think of running a restaurant in which you cook Zoo animals as the course? I will just assume yes. Anyway, come June 23rd we will all be able to start up our... | Read more »
Crystal of Atlan opens registration for...
Nuverse was prominently featured in the last month for all the wrong reasons with the USA TikTok debacle, but now it is putting all that behind it and preparing for the Crystal of Atlan beta test. Taking place between February 18th and March 5th,... | Read more »

Price Scanner via MacPrices.net

AT&T is offering a 65% discount on the ne...
AT&T is offering the new iPhone 16e for up to 65% off their monthly finance fee with 36-months of service. No trade-in is required. Discount is applied via monthly bill credits over the 36 month... Read more
Use this code to get a free iPhone 13 at Visi...
For a limited time, use code SWEETDEAL to get a free 128GB iPhone 13 Visible, Verizon’s low-cost wireless cell service, Visible. Deal is valid when you purchase the Visible+ annual plan. Free... Read more
M4 Mac minis on sale for $50-$80 off MSRP at...
B&H Photo has M4 Mac minis in stock and on sale right now for $50 to $80 off Apple’s MSRP, each including free 1-2 day shipping to most US addresses: – M4 Mac mini (16GB/256GB): $549, $50 off... Read more
Buy an iPhone 16 at Boost Mobile and get one...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering one year of free Unlimited service with the purchase of any iPhone 16. Purchase the iPhone at standard MSRP, and then choose... Read more
Get an iPhone 15 for only $299 at Boost Mobil...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering the 128GB iPhone 15 for $299.99 including service with their Unlimited Premium plan (50GB of premium data, $60/month), or $20... Read more
Unreal Mobile is offering $100 off any new iP...
Unreal Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering a $100 discount on any new iPhone with service. This includes new iPhone 16 models as well as iPhone 15, 14, 13, and SE... Read more
Apple drops prices on clearance iPhone 14 mod...
With today’s introduction of the new iPhone 16e, Apple has discontinued the iPhone 14, 14 Pro, and SE. In response, Apple has dropped prices on unlocked, Certified Refurbished, iPhone 14 models to a... Read more
B&H has 16-inch M4 Max MacBook Pros on sa...
B&H Photo is offering a $360-$410 discount on new 16-inch MacBook Pros with M4 Max CPUs right now. B&H offers free 1-2 day shipping to most US addresses: – 16″ M4 Max MacBook Pro (36GB/1TB/... Read more
Amazon is offering a $100 discount on the M4...
Amazon has the M4 Pro Mac mini discounted $100 off MSRP right now. Shipping is free. Their price is the lowest currently available for this popular mini: – Mac mini M4 Pro (24GB/512GB): $1299, $100... Read more
B&H continues to offer $150-$220 discount...
B&H Photo has 14-inch M4 MacBook Pros on sale for $150-$220 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – 14″ M4 MacBook Pro (16GB/512GB): $1449, $150 off MSRP – 14″ M4... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.