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

Capto 1.2.9 - $29.99
Capto (was Voila) is an easy-to-use app that takes capturing, recording, video and image editing to the next level. With an intelligent file manager and quick sharing options, Capto is perfect for... Read more
Opera 51.0.2830.40 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
GarageSale 7.0.13 - Create outstanding e...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more
1Password 6.8.7 - Powerful password mana...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
Evernote 7.0.1 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
MacUpdate Desktop 6.2.0 - $20.00
MacUpdate Desktop brings seamless 1-click app installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on... Read more
HoudahSpot 4.3.5 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more
EtreCheck 4.0.4 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
WhatsApp 0.2.8361 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
iClock 4.2 - Customize your menubar cloc...
iClock is a menu-bar replacement for Apple's default clock but with 100x features. Have your Apple or Google calendar in the menubar. Have the day, date, and time in different fonts and colors in the... Read more

Latest Forum Discussions

See All

The best games like Florence
Florence is a great little game about relationships that we absolutely adored. The only problem with it is it's over a little too soon. If you want some other games with some emotional range like Florence, check out these suggestions: [Read more] | Read more »
Angry Birds Champions adds cash prizes t...
Collaborating with developer Rovio Entertainment, GSN Games has released a twist on the Angry Birds formula. Angry Birds Champions features the same bird-flinging gameplay, but now you can catapult Red and co for cash. | Read more »
Around the Empire: What have you missed...
148Apps is part of a family. A big family of sites that make sure you're always up to date with all the portable gaming news. Just like a real family, I guess. I don't know, my mum never told me anything about Candy Crush to be fair. [Read more] | Read more »
The Battle of Polytopia Guide - Tips for...
The addition of multiplayer to The Battle of Polytopia has catapulted the game from a fun enough time waster to a fully-fledged 4X experience on your phone. We've been playing quite a few matches over the past week or so, and we've put together a... | Read more »
All the best games on sale for iPhone an...
Hi there, and welcome to our round up of all the best games that are on sale for iOS at the moment. It's not a vintage week in terms of numbers, but I'm pretty sure that every single one of these is worth picking up if you haven't already played... | Read more »
Disc Drivin' 2 Guide - Tips for the...
We're all still playing quite a bit of Disc Drivin' 2 over here at 148Apps, and we've gotten pretty good at it. Now that we've spent some more time with the game and unlocked more powerups, check out some of these more advanced tips: | Read more »
Alto's Odyssey Guide - How to Tackl...
Alto’s Odyssey is a completely stunning and serene runner, but it can also be a bit tricky. Check out these to try and keep your cool while playing this endless runner: Don’t focus too much on tasks [Read more] | Read more »
Here's everything you need to know...
Alto's Odyssey is a really, really good game. If you don't believe me, you should definitely check out our review by clicking this link right here. It takes the ideas from the original Alto's Adventure, then subtly builds on them, creating... | Read more »
Alto's Odyssey (Games)
Alto's Odyssey 1.0.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: Just beyond the horizon sits a majestic desert, vast and unexplored. Join Alto and his friends and set off on an endless... | Read more »
Vainglory 5v5: Everything you need to kn...
Vainglory just got bigger. [Read more] | Read more »

Price Scanner via MacPrices.net

Use your Apple Education discount and save up...
Purchase a new Mac using Apple’s Education discount, and take up to $400 off MSRP. All teachers, students, and staff of any educational institution with a .edu email address qualify for the discount... Read more
Apple Canada offers 2017 21″ and 27″ iMacs fo...
 Canadian shoppers can save up to $470 on the purchase of a 2017 current-generation 21″ or 27″ iMac with Certified Refurbished models at Apple Canada. Apple’s refurbished prices are the lowest... Read more
9″ iPads available online at Walmart for $50...
Walmart has 9.7″ Apple iPads on sale for $50 off MSRP for a limited time. Sale prices are for online orders only, in-store prices may vary: – 9″ 32GB iPad: $279.99 $50 off – 9″ 128GB iPad: $379.99 $... Read more
15″ Apple MacBook Pros, Certified Refurbished...
Save $360-$420 on the purchase of a 2017 15″ MacBook Pro with Certified Refurbished models at Apple. Apple’s refurbished prices are the lowest available for each model from any reseller. An standard... Read more
Amazon restocks MacBook Pros with models avai...
Amazon has restocked 15″ and 13″ Apple MacBook Pros with models on sale for up to $251 off MSRP. Shipping is free. Note that stock of some Macs may come and go (and some sell out quickly), so check... Read more
Lowest price of the year: 15″ 2.8GHz Apple Ma...
Amazon has the 2017 Space Gray 15″ 2.8GHz MacBook Pro on sale today for $251 off MSRP. Shipping is free: – 15″ 2.8GHz Touch Bar MacBook Pro Space Gray (MPTR2LL/A): $2148, $251 off MSRP Their price is... Read more
Apple restocks full line of Certified Refurbi...
Apple has restocked a full line of Apple Certified Refurbished 2017 13″ MacBook Pros for $200-$300 off MSRP. A standard Apple one-year warranty is included with each MacBook, and shipping is free.... Read more
Lowest sale price available for 13″ 1.8GHz Ma...
Focus Camera has the 2017 13″ 1.8GHz/128GB Apple MacBook Air on sale today for $829 including free shipping. Their price is $170 off MSRP, and it’s the lowest price available for a current 13″... Read more
21-inch 2.3GHz iMac on sale for $999, $100 of...
B&H Photo has the 2017 21″ 2.3GHz iMac (MMQA2LL/A) in stock and on sale for $999 including free shipping plus NY & NJ tax only. Their price is $100 off MSRP. Read more
Apple refurbished Mac minis in stock again st...
Apple has restocked Certified Refurbished Mac minis starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: – 1.4GHz Mac mini: $419 $80 off MSRP – 2.6GHz Mac... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 113523441 Orange, CA, California, United States Posted: 21-Feb-2018 Weekly Hours: 40.00 **Job Summary** Are you passionate Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.