TweetFollow Us on Twitter

Sprocket Menus 4
Volume Number:11
Issue Number:8
Column Tag:Getting Started

Sprocket Menus, Part 4

By Dave Mark, MacTech Magazine Regular Contributing Author

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

Last month, we added code to our SprocketPicText project to implement the Style and most of the Size submenus that appear underneath the Text menu when a TTextWindow is the frontmost window. This month, we’re going to finish up the Size menu by implementing the Other... item. We’ll also add code to implement the Font submenu. Finally, we’ll add the code to the TPictureWindow to implement the two items in the Picture window that appears whenever a TPictureWindow is the frontmost window.

A DLOG and a DITL

We’ll start off by adding a single DLOG resource and its associated DITL resource to SprocketStarter.rsrc. The two resources will implement a dialog that prompts the user to type in a new font size. The dialog will be brought up when the user selects Other... from the Size menu.

• Start by duplicating last month’s SprocketStarter folder (be sure you remove objects first if you care about disk space).

Don’t duplicate the Sprocket folder, since it hasn’t changed from last month. Last month’s Sprocket-Starter folder was named “SprocketPicText.04/25/95”. Name the new copy “SprocketPicText.05/31/95”.

Open up your new Sprocket-Starter folder and launch either the 68K or PowerMac SprocketStarter project. When your project window appears, double-click on the file named SprocketStarter.rsrc to launch your favorite resource editor.

• Create a new DLOG with a resource ID of 1000, a top of 71, left of 97, bottom of 146, and a right of 363. Be sure you select the modal dialog window type.

• Create a DITL with a resource ID of 1000.

• Create a pushbutton (item#1) with the text OK, a top of 42, left of 184, bottom of 62, and a right of 253.

• Create a pushbutton (item#2) with the text Cancel, a top of 42, left of 99, bottom of 62, and a right of 168.

• Create a static text item (item#3) with the text Font size:, a top of 13, left of 13, bottom of 29, and a right of 81.

• Create an editable text item (item#4) with no text, a top of 13, left of 91, bottom of 29, and a right of 250.

Figure 1 shows the finished dialog, as displayed by Resorcerer.

Figure 1. The DLOG and DITL resources, as displayed by Resorcerer.

TextWindow.h

Quit your resource editor, saving your changes, and return to CodeWarrior. Now open the file TextWindow.h and make these changes:

• Add these lines to the top of the file, just before the enum:

#include <Fonts.h>

const longkCancelButtonPressed = 0L;
const short iNumberEditTextField = 4;
const short kGetNumberDialogResID = 1000;

• Add these member function declarations to the TTextWindow class:

 virtual long    DoNumberDialog( void );
 virtual void    SetOtherMenuItemString( void );
 virtual void    PascalStringCat( Str255 dest, Str255 source );
 virtual void    AdjustFontMenu( void );
 virtual Boolean DoMenuSelection( short menu, short item );

TextWindow.cp

Close TextWindow.h and open the file TextWindow.cp. Make these changes:

• Add to the file the member function

TTextWindow::DoNumberDialog()

Here’s the source code:

long
TTextWindow::DoNumberDialog( void )
{
 BooleandialogDone = false;
 Str255 text;
 Handle itemHandle;
 short  itemHit, itemType;
 Rect   itemRect;
 long   returnValue;
 DialogPtrdialog;
 
 dialog = GetNewDialog( kGetNumberDialogResID, NULL, 
 (WindowPtr)-1L );
 
 if ( dialog == NULL )
 return kCancelButtonPressed;
 
 SetDialogDefaultItem( dialog, ok );
 SetDialogCancelItem( dialog, cancel );
 
 NumToString( (long)fCurrentFontSize, text );
 
 GetDialogItem( dialog, iNumberEditTextField, &itemType,
 &itemHandle, &itemRect );
 SetDialogItemText( itemHandle, text );
 
 SelectDialogItemText( dialog, iNumberEditTextField, 0, 32767 );
 
 ShowWindow( dialog );
 
 do
 {
 ModalDialog( NULL, &itemHit );
 
 if ( itemHit == ok )
 {
 GetDialogItem( dialog, iNumberEditTextField, &itemType,
 &itemHandle, &itemRect );
 GetDialogItemText( itemHandle, text );
 
 StringToNum( text, &returnValue );
 
 if ( (returnValue < kMinimumFontSize) ||
 (returnValue > kMaximumFontSize) )
 {
 SysBeep( 20 );
 SelectDialogItemText( dialog, iNumberEditTextField,
  0, 32767 );
 itemHit = iNumberEditTextField;
 }
 else
 dialogDone = true;
 }
 else if ( itemHit == cancel )
 {
 returnValue = kCancelButtonPressed;
 dialogDone = true;
 }
 } while ( ! dialogDone );
 
 DisposeDialog( dialog );
 
 return returnValue;
}

This function implements the dialog box whose resources you created earlier. The dialog allows the reader to enter a new font size for the frontmost text window. The user must enter a size between kMinimumFontSize and kMaximumFontSize, otherwise we’ll beep and highlight the editable text field.

We’ll start off by converting the current text size, stored in the data member fCurrentFontSize, into a Str255 and we’ll place the Str255 version of the number in the dialog’s editable text field. We’ll then highlight the text field so if the user wants to type a new value, they don’t have to select the text first to replace it.

Inside the dialog loop, if the user presses the OK button, we’ll convert the text field to a long, then check to be sure it’s in range. If so, we’ll set dialogDone to true so we drop out of the loop.

If they hit the Cancel button, we’ll set the return value to kCancelButtonPressed, which has been pre-defined as 0L, which we know won’t be a legal font size.

Finally, once we drop out of the loop, we’ll dispose of the dialog and return returnValue.

• Add to the file the member function

TTextWindow::PascalStringCat()

Here’s the source code:

void
TTextWindow::PascalStringCat( Str255 dest, Str255 source )
{
 unsigned char i, destStringLength, sourceStringLength;
 
 destStringLength = dest[0];
 sourceStringLength = source[0];
 
 if ( sourceStringLength <= 0 )
 return;
 
 for ( i=1; i<=sourceStringLength; i++ )
 dest[i+destStringLength] = source[i];
 
 dest[0] += sourceStringLength;
}

Much like the function strcat(), this function appends the source pascal string on to the end of thepascal string already in dest. The length byte from source is deleted and the length byte of dest is incremented to reflect its new length.

This function is called by SetOtherMenuItemString() which we’ll add next.

• Add to the file the member function

TTextWindow::SetOtherMenuItemString() .

Here’s the source code:

void
TTextWindow::SetOtherMenuItemString( void )
{
 Str255 menuItemStr = "\pOther (";
 Str255 numberStr;
 
 NumToString( (long)fCurrentFontSize, numberStr );
 
 PascalStringCat( menuItemStr, numberStr );
 PascalStringCat( menuItemStr, "\p)..." );
 
 gMenuBar->SetItemString( cFontSizeOther, menuItemStr );
}

This function changes the Other... item in the Size menu to reflect the current text size. For example, if the current size is 37, the menu item should read Other (37).... Note that the Size menu we’ve implemented here is not my invention. It comes from the pages of Inside Macintosh and represents the standard you should use in your own applications.

SetOtherMenuItemString() starts off by defining a Str255 named menuItemStr with the text “Other (”. We’ll then convert the current size to a pascal string and append it to menuItemStr. Finally, we’ll append the pascal string “)...” to menuItemStr then call the TMenuBar member function SetItemString() to change the item associated with the command cFontSizeOther to menuItemStr.

• Add a call of SetOtherMenuItemString() to the end of the member function AdjustSizeMenu(). AdjustSizeMenu() gets called when a mousedown occurs in the menu bar.

• Add to the file the member function

TTextWindow::DoMenuSelection()

Here’s the source code:

Boolean
TTextWindow::DoMenuSelection( short menu, short item )
{
 Str255 itemString;
 short  fontNumber;
 
 if ( menu == mTextFont )
 {
 GetMenuItemText( fgFontSubMenu, item, itemString );
 GetFNum( itemString, &fontNumber );
 SetPort( fWindow );
 TextFont( fontNumber );
 InvalRect( &fWindow->portRect );
 return true;
 }
 else
 return false;
}

DoMenuSelection() gets called before any of the command dispatching functions, giving you a chance to handle menus that contain unregistered items. Since there is no way to construct a CMNU resource for the Font menu (how would we assign command numbers when we don’t know how many or which fonts are installed?), we’ll handle selections from the Font menu in this function.

Before you read on, take a look at the function this function overrides, TWindow::DoMenuSelection(). Note that it simply returns false. If DoMenuSelection() returns false, Sprocket converts the menu selection to a command number and handles it that way. If DoMenuSelection() returns true, Sprocket assumes the menu selection has been processed and does nothing more.

DoMenuSelection() first checks to be sure the selection was from the Font menu. If so, it converts the selected item to a font number, then calls TextFont() to set the font for the associated fWindow, forces a redraw, and returns true.

Next, we’re going to make some changes to the function DoMenuCommand(), our menu command dispatcher that gets called if DoMenuSelection() returns false.

• Add a declaration of the variable newSize at the top of TTextWindow::DoMenuCommand():

 long newSize;

• Still in TTextWindow::DoMenuCommand(), edit the cFontSizeOther case in the switch statement to read:

 case cFontSizeOther:
 newSize = DoNumberDialog();
 if ( newSize != kCancelButtonPressed )
 SetNewTextSize( newSize );
 return true;
 break;

This case gets executed when Other (xx)... is selected from the Size menu. We’ll start by calling DoNumberDialog() to prompt the user for a new size. If a new size was entered, we’ll call SetNewTextSize() to set the new size.

Now we need to add the code that places the check mark next to the current font in the Font menu.

• Add a call of the function AdjustFontMenu() to the member function TTextWindow::AdjustMenusBeforeMenuSelection(). Here’s the new version of TTextWindow::AdjustMenusBeforeMenuSelection():

void
TTextWindow::AdjustMenusBeforeMenuSelection( void )
{
 AdjustFontMenu();
 AdjustSizeMenu();
 AdjustStyleMenu();
}

• Add the member function TTextWindow::AdjustFontMenu() to the file. Here’s the source code:

void
TTextWindow::AdjustFontMenu( void )
{
 short  fontNumber, numFonts, i;
 Str255 fontName, itemName;
 
 fontNumber = fWindow->txFont;
 GetFontName( fontNumber, fontName );
 
 numFonts = CountMItems( fgFontSubMenu );
 
 for ( i=1; i<=numFonts; i++ )
 {
 GetMenuItemText( fgFontSubMenu, i, itemName );
 
 if ( EqualString( itemName, fontName, true, true ) )
 CheckItem( fgFontSubMenu, i, true);
 else
 CheckItem( fgFontSubMenu, i, false);
 }
}

AdjustFontMenu() turns the current font family id into its name. Next, CountMItems() is called to return the number of items in the Font menu. The for loop steps through each of the items, checking to see if the item is equal to the font name. If so, the item gets a check mark. If not, the item does not get a check mark.

PictureWindow.h

Our final task is to add the code that implements the two items in the Picture menu, Centered and Upper Left. Centered causes the picture to be drawn centered in the picture window and Upper Left causes the picture to be pressed against the upper-left corner of the window.

• Close TextWindow.cp and open the file PictureWindow.h.

• Add the declaration of the data member fIsPictureCentered to the TPictureWindow class declaration:

 BooleanfIsPictureCentered;

• Add the declarations of the member functions DoMenuCommand() and AdjustMenusBeforeMenuSelection() to the TPictureWindow class declaration:

 virtual Boolean DoMenuCommand( unsigned long menuCommand );
 virtual void    AdjustMenusBeforeMenuSelection( void );

PictureWindow.cp

Close PictureWindow.h and open the file PictureWindow.cp.

• Add the code that initializes fIsPictureCentered to the TPictureWindow constructor:

 fIsPictureCentered = true;

• In the function TPictureWindow::Draw(), edit the last two lines of code so Draw() looks like this:

void
TPictureWindow::Draw(void)
{
 PicHandlepic;
 Rect   r;
 
 r = fWindow->portRect;
 EraseRect( &r );
 
 if ( fDraggedPicHandle == nil )
 pic = this->LoadDefaultPicture();
 else
 pic = fDraggedPicHandle;

 if ( fIsPictureCentered )
 {
 this->CenterPict( pic, &r );
 }
 else
 {
 r = (**pic).picFrame;
 OffsetRect( &r, - r.left, - r.top );
 }
 
 DrawPicture( pic, &r );
}

Basically, we’ve made Draw() depend on fIsPictureCentered.

• Add the member function TPictureWindow::DoMenuCommand() to the file. Here’s the source code:

Boolean
TPictureWindow::DoMenuCommand( unsigned long menuCommand )
{
 switch ( menuCommand )
 {
 case cCentered:
 fIsPictureCentered = true;
 SetPort( fWindow );
 InvalRect( &fWindow->portRect );
 return true;
 break;
 
 case cUpperLeft:
 fIsPictureCentered = false;
 SetPort( fWindow );
 InvalRect( &fWindow->portRect );
 return true;
 break;
 }

 return false;
}

This code gets called in response to a selection from the Picture menu.

• Add the member function TPictureWindow::AdjustMenusBeforeMenuSelection() to the file. Here’s the source code:

void
TPictureWindow::AdjustMenusBeforeMenuSelection( void )
{
 if ( fIsPictureCentered )
 {
 gMenuBar->EnableAndCheckCommand( cCentered, true, true );
 gMenuBar->EnableAndCheckCommand( cUpperLeft, true, false );
 }
 else
 {
 gMenuBar->EnableAndCheckCommand( cCentered, true, false );
 gMenuBar->EnableAndCheckCommand( cUpperLeft, true, true );
 }
}

Depending on the value of fIsPictureCentered, this code places a check mark next to the appropriate item in the Picture menu.

SprocketStarter.cp

Several months ago, when we first started this program, we added code to the function HandleMenuCommand() in SprocketStarter.cp that beeped when either of the Picture items was selected. Since we now handle these two cases inside the file PictureWindow.cp (as it should be done), we need to delete the two commands from the case statement in HandleMenuCommand() inside SprocketStarter.cp.

• Close the file PictureWindow.cp and open the file SprocketStarter.cp.

• Find the function HandleMenuCommand(). Inside the switch statement, delete the cases (all the way down to the break) for cCentered and cUpperLeft.

Running SprocketStarter

Well, that’s about it. Now’s the time to test your new creation. Select Run from the Project menu. When it runs, SprocketStarter will create a new text window, and the Text menu will appear at the end of the menu bar. Click on the Text menu, then make a selection from the Font submenu (Figure 2). The font of the frontmost text window should change and, the next time you select from the Font submenu, the check mark should appear next to this new font.

Figure 2. The Font submenu, showing the checkmark by Geneva
with Chicago selected.

Next, select Other (18)... from the Size submenu (we set up18 as the default font size). The font size dialog will appear, with the number 18 in the editable text field. Type 0 and click the OK button. You’ll hear a beep and the 0 will be highlighted. Type 37 and click the OK button (Figure 3). This time, your new font size is accepted and the text in the text window is redrawn showing the new font size.

Figure 3. The font size dialog that appears when you select Other (xx)...
from the Size submenu.

Once again, pull down the Text menu and bring down the Size submenu. Notice that the last item now reads Other (37)... and that the check mark has moved to this item (Figure 4).

Figure 4. The Size submenu with the Other (37)... item selected and checked.

Finally, create a picture window, then select one of the two items from the Picture menu that appears. With each selection, the picture in the picture window should be redrawn to match the selection and the check mark should appear next to the last selected item.

Figure 5. The Picture menu.

About the only thing left to do with this code is to make the sizes in the Size menu appear in outline font if they are available on the current machine or in regular font if that size is not available. Take some time to add this code. A good place to add the code is in the function TTextWindow::SetUpStaticMenu(), after you set up the static member fgSizeSubMenu. You’ll need to use the functions SetItemStyle() and RealFont() for each of the 6 sizes in the menu.

What’s Next

I hope the last few columns have given you an appreciation for the complexity and coolness of a framework. One thing I’ve grown to appreciate is the incredible amount of work it must have been for Dave Falkenburg to build Sprocket. Way to go, Dave!

I’m not sure what topic we’ll be tackling next month. I’ve been thinking about building a small PowerPlant project, just to explore the differences between Sprocket and PowerPlant. On the other hand, I’ve really got a hankering to build a tool palette using Sprocket. And there’s this cool OpenDoc part I’ve been fiddling with. Any preferences? Send some email my way...

See you next month!

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Whitethorn Games combines two completely...
If you have ever gone fishing then you know that it is a lesson in patience, sitting around waiting for a bite that may never come. Well, that's because you have been doing it wrong, since as Whitehorn Games now demonstrates in new release Skate... | Read more »
Call of Duty Warzone is a Waiting Simula...
It's always fun when a splashy multiplayer game comes to mobile because they are few and far between, so I was excited to see the notification about Call of Duty: Warzone Mobile (finally) launching last week and wanted to try it out. As someone who... | Read more »
Albion Online introduces some massive ne...
Sandbox Interactive has announced an upcoming update to its flagship MMORPG Albion Online, containing massive updates to its existing guild Vs guild systems. Someone clearly rewatched the Helms Deep battle in Lord of the Rings and spent the next... | Read more »
Chucklefish announces launch date of the...
Chucklefish, the indie London-based team we probably all know from developing Terraria or their stint publishing Stardew Valley, has revealed the mobile release date for roguelike deck-builder Wildfrost. Developed by Gaziter and Deadpan Games, the... | Read more »
Netmarble opens pre-registration for act...
It has been close to three years since Netmarble announced they would be adapting the smash series Solo Leveling into a video game, and at last, they have announced the opening of pre-orders for Solo Leveling: Arise. [Read more] | Read more »
PUBG Mobile celebrates sixth anniversary...
For the past six years, PUBG Mobile has been one of the most popular shooters you can play in the palm of your hand, and Krafton is celebrating this milestone and many years of ups by teaming up with hit music man JVKE to create a special song for... | Read more »
ASTRA: Knights of Veda refuse to pump th...
In perhaps the most recent example of being incredibly eager, ASTRA: Knights of Veda has dropped its second collaboration with South Korean boyband Seventeen, named so as it consists of exactly thirteen members and a video collaboration with Lee... | Read more »
Collect all your cats and caterpillars a...
If you are growing tired of trying to build a town with your phone by using it as a tiny, ineffectual shover then fear no longer, as Independent Arts Software has announced the upcoming release of Construction Simulator 4, from the critically... | Read more »
Backbone complete its lineup of 2nd Gene...
With all the ports of big AAA games that have been coming to mobile, it is becoming more convenient than ever to own a good controller, and to help with this Backbone has announced the completion of their 2nd generation product lineup with their... | Read more »
Zenless Zone Zero opens entries for its...
miHoYo, aka HoYoverse, has become such a big name in mobile gaming that it's hard to believe that arguably their flagship title, Genshin Impact, is only three and a half years old. Now, they continue the road to the next title in their world, with... | Read more »

Price Scanner via MacPrices.net

B&H has Apple’s 13-inch M2 MacBook Airs o...
B&H Photo has 13″ MacBook Airs with M2 CPUs and 256GB of storage in stock and on sale for up to $150 off Apple’s new MSRP, starting at only $849. Free 1-2 day delivery is available to most US... Read more
M2 Mac minis on sale for $100-$200 off MSRP,...
B&H Photo has Apple’s M2-powered Mac minis back in stock and on sale today for $100-$200 off MSRP. Free 1-2 day shipping is available for most US addresses: – Mac mini M2/256GB SSD: $499, save $... Read more
Mac Studios with M2 Max and M2 Ultra CPUs on...
B&H Photo has standard-configuration Mac Studios with Apple’s M2 Max & Ultra CPUs in stock today and on Easter sale for $200 off MSRP. Their prices are the lowest available for these models... Read more
Deal Alert! B&H Photo has Apple’s 14-inch...
B&H Photo has new Gray and Black 14″ M3, M3 Pro, and M3 Max MacBook Pros on sale for $200-$300 off MSRP, starting at only $1399. B&H offers free 1-2 day delivery to most US addresses: – 14″ 8... Read more
Department Of Justice Sets Sights On Apple In...
NEWS – The ball has finally dropped on the big Apple. The ball (metaphorically speaking) — an antitrust lawsuit filed in the U.S. on March 21 by the Department of Justice (DOJ) — came down following... Read more
New 13-inch M3 MacBook Air on sale for $999,...
Amazon has Apple’s new 13″ M3 MacBook Air on sale for $100 off MSRP for the first time, now just $999 shipped. Shipping is free: – 13″ MacBook Air (8GB RAM/256GB SSD/Space Gray): $999 $100 off MSRP... Read more
Amazon has Apple’s 9th-generation WiFi iPads...
Amazon has Apple’s 9th generation 10.2″ WiFi iPads on sale for $80-$100 off MSRP, starting only $249. Their prices are the lowest available for new iPads anywhere: – 10″ 64GB WiFi iPad (Space Gray or... Read more
Discounted 14-inch M3 MacBook Pros with 16GB...
Apple retailer Expercom has 14″ MacBook Pros with M3 CPUs and 16GB of standard memory discounted by up to $120 off Apple’s MSRP: – 14″ M3 MacBook Pro (16GB RAM/256GB SSD): $1691.06 $108 off MSRP – 14... Read more
Clearance 15-inch M2 MacBook Airs on sale for...
B&H Photo has Apple’s 15″ MacBook Airs with M2 CPUs (8GB RAM/256GB SSD) in stock today and on clearance sale for $999 in all four colors. Free 1-2 delivery is available to most US addresses.... Read more
Clearance 13-inch M1 MacBook Airs drop to onl...
B&H has Apple’s base 13″ M1 MacBook Air (Space Gray, Silver, & Gold) in stock and on clearance sale today for $300 off MSRP, only $699. Free 1-2 day shipping is available to most addresses in... Read more

Jobs Board

Medical Assistant - Surgical Oncology- *Apple...
Medical Assistant - Surgical Oncology- Apple Hill Location: WellSpan Medical Group, York, PA Schedule: Full Time Sign-On Bonus Eligible Remote/Hybrid Regular Apply Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
Operations Associate - *Apple* Blossom Mall...
Operations Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Business Analyst | *Apple* Pay - Banco Popu...
Business Analyst | Apple PayApply now " Apply now + Apply Now + Start applying with LinkedIn Start + Please wait Date:Mar 19, 2024 Location: San Juan-Cupey, PR Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.