TweetFollow Us on Twitter

Sep 01 Programming

Volume Number: 17 (2001)
Issue Number: 09
Column Tag: Programming Techniques

The Under-used UserPane

by Spec Bowers

Presenting a Whole Slew of Nifty Controls

Introduction

Could you use a QuickTime control, an MLTE control, an HTML Renderer control, a StoneTable control, a WASTE control, a Color Picker control? They're all here - made out of a UserPane.

Of all the controls Apple has created in recent years, the most flexible is the UserPane. It is also the hardest to use. Most of us probably just write special–purpose code in our update handlers or mouse–down handlers rather than bother with the intricacies of a UserPane.

With a simple wrapper class, the UserPane is very easy to use - and it makes other packages easier to use. We have made UserPane controls for QuickTime, MLTE, HTML Rendering, the Color Picker, the StoneTable list manager replacement, and the WASTE text engine. These packages are easier to use thanks to the UserPane.


Figure 1. Four kinds of UserPane

Wrapping a UserPane control around QuickTime, MLTE, or other packages makes the code easy to reuse and greatly simplifies your event handling code. The QuickTime control is almost as simple as a standard pushbutton; the MLTE control is easier than TextEdit.

Your event loop already has code for HandleControlClick, HandleControlKey, SetKeyboardFocus, Activate/DeactivateControl, Hide/ShowControl, and IdleControls. When you wrap a UserPane control around a package like QuickTime, it automatically responds to your existing control handling code. You can put controls for QuickTime, MLTE, HTML Rendering, etc. in a window, a dialog, inside a tab panel - anywhere you put a standard control - and it just works.

This article:

  • describes the functions of a UserPane;
  • presents a C++ wrapper class that makes it easy to use a UserPane;
  • presents several examples of UserPanes;
  • shows how to handle a UserPane in a window or dialog

UserPane Functions

Apple defines several callback functions for a UserPane control:

  • A DrawProc draws the content of your control. It might be called to draw a part of the control but usually draws the entire control.
  • A HitTestProc returns the part code of the control where the mouse–down occurred. We usually just detect a mouse–down anywhere in the control and return a partcode which represents the entire control.
  • A TrackingProc tracks a control while the user holds down the mouse button.
  • An IdleProc performs idle processing.
  • A KeyDownProc handles keyboard events.
  • An ActivateProc handles activate and deactivate events.
  • A FocusProc handles keyboard focus - e.g. for Set/AdvanceKeyboardFocus.
  • A BackgroundProc sets the background color or pattern for embedded controls.

To install a callback you first create a UPP, then pass it to the control via SetControlData. Later, to prevent a memory leak, you should dispose the UPP. Alternatively, you can adopt a "create once and reuse" protocol. Whatever way you do it, installing a callback is a nuisance. The AMUserPane makes it very simple to install a callback.

The AMUserPane Class

The AMUserPane class provides functions for easily installing callbacks and for disposing of UPPs when the control is discarded, provides some standard callback functions, and provides some utility functions to simplify using a UserPane.

To install a DrawProc, just call "SetDrawProc ()":

//—————
void   AMUserPane::SetDrawProc ()
{
   mDrawUPP = NewControlUserPaneDrawUPP (StaticDrawProc);
   ::SetControlData (mControl,
                kControlNoPart,
                kControlUserPaneDrawProcTag,
                sizeof (mDrawUPP),
                (Ptr)&mDrawUPP);
}
There are similar functions for installing a TrackingProc, KeyDownProc, ActivateProc, etc.
AMUserPane declares data members for each callback function:
   ControlUserPaneDrawUPP            mDrawUPP;
   ControlUserPaneHitTestUPP         mHitTestUPP;
   ControlUserPaneTrackingUPP      mTrackingUPP;
   ControlUserPaneIdleUPP            mIdleUPP;
   ControlUserPaneKeyDownUPP         mKeyDownUPP;
   ControlUserPaneActivateUPP      mActivateUPP;
   ControlUserPaneFocusUPP            mFocusUPP;
   ControlUserPaneBackgroundUPP      mBackgroundUPP;
Its constructor initializes each UPP to nil, and its destructor disposes each (non–nil) UPP:
//—————
AMUserPane::AMUserPane ()
{
   mDrawUPP = nil;
   mHitTestUPP = nil;
   mTrackingUPP = nil;
   mIdleUPP = nil;
   mKeyDownUPP = nil;
   mActivateUPP = nil;
   mFocusUPP = nil;
   mBackgroundUPP = nil;
}

//—————
AMUserPane::~AMUserPane ()
{
   if (mDrawUPP != nil) {
      DisposeControlUserPaneDrawUPP (mDrawUPP);
   }
   if (mHitTestUPP != nil) {
      DisposeControlUserPaneHitTestUPP (mHitTestUPP);
   }
   if (mTrackingUPP != nil) {
      DisposeControlUserPaneTrackingUPP (mTrackingUPP);
   }
   if (mIdleUPP != nil) {
      DisposeControlUserPaneIdleUPP (mIdleUPP);
   }
   if (mKeyDownUPP != nil) {
      DisposeControlUserPaneKeyDownUPP (mKeyDownUPP);
   }
   if (mActivateUPP != nil) {
      DisposeControlUserPaneActivateUPP (mActivateUPP);
   }
   if (mFocusUPP != nil) {
      DisposeControlUserPaneFocusUPP (mFocusUPP);
   }
   if (mBackgroundUPP != nil) {
      DisposeControlUserPaneBackgroundUPP (mBackgroundUPP);
   }
}

Look back at SetDrawProc and you'll see that it installs a callback to a function named "StaticDrawProc". AMUserPane provides a member function, DoDraw, which is overridden in each subclass. The StaticDrawProc is a glue function which dispatches to the particular DoDraw of the subclass - the QuickTime DoDraw, or the MLTE DoDraw, for example. During initialization we store a pointer to a specific instance of AMUserPane in the control's RefCon. In each callback we retrieve the control's RefCon, cast it to an AMUserPane pointer, then call the member function.

//—————
void   AMUserPane::Initialize (
   ControlHandle      inControl)
{
   mControl = inControl;
   ::SetControlReference (mControl, (SInt32)this);
}

//—————
pascal void      AMUserPane::StaticDrawProc (
   ControlHandle   control,
   SInt16               part)
{
   AMUserPane*      pane = (AMUserPane*)::GetControlReference (control);

   pane->DoDraw (part);
}

//—————
void   AMUserPane::DoDraw (
   SInt16      part)
{
   // override in each subclass
}

AMUserPane is a base class; it provides common code for a wide variety of UserPane controls. We have made half a dozen subclasses. Let's take a look at some of them.

A ColorSwatch UserPane

Our simplest UserPane is a wrapper around the Color Picker. It paints the control's rectangle with a color. If the user clicks the UserPane, it invokes the Color Picker, then redraws the rectangle with the selected color. We overrode DoDraw and DoTracking. The Initialize function calls SetDrawProc and SetTrackingProc to install callbacks.

//—————
void   AMColorSwatch::DoDraw (
   SInt16         /* part */ )
{
   RGBColor      saveColor;
   Rect            rect;

   ::GetForeColor (&saveColor);
   ::RGBForeColor (&mSwatchColor);
   GetControlRect (&rect);
   ::PaintRect (&rect);
   ::RGBForeColor (&saveColor);
}

//—————
ControlPartCode      AMColorSwatch::DoTracking (
   Point            startPt,
   ControlActionUPP   actionProc)
{
   ControlPartCode      result = 0;
   Point            dialogPos = {0, 0};
   Str255            prompt = "\p";
   RGBColor         outColor;

   if (::GetColor (dialogPos, prompt, &mSwatchColor, &outColor)) {
      mSwatchColor = outColor;
      DoDraw (0);
      result = 99;   // any non-zero code
   }

   return result;
}

//—————
void   AMColorSwatch::Initialize (
   ControlHandle      inControl)
{
   AMUserPane::Initialize (inControl);

   SetDrawProc ();
   SetTrackingProc ();
}

An HTML Pane - Glitches and Solutions

The HTML pane is only slightly more complex but illustrates two glitches. The first time we put it inside a Tab control it worked pretty well. Clicking a tab results in HideControl/ShowControl of the panels. Each panel is a simple UserPane with embedded controls. When we hide or show a panel, the Control Manager hides or shows any embedded controls, including our custom UserPane controls. (This by the way is one of the advantages of turning QuickTime, MLTE, etc. into UserPane controls - HideControl, ShowControl and other Control Manager functions work the same as with standard controls.)

There was a glitch, though. When we deactivated the window, suddenly one of our hidden UserPane controls drew something. The Control Manager doesn't call the DrawProc of a hidden control but it may call the ActivateProc. We added a simple "IsVisible" call to test for visibility inside any of our callback functions that might draw anything.

//—————
void   AMHTMLPane::DoActivate (
   Boolean      activating)
{
   Rect         cntlRect;

   if (IsVisible ()) {
      if (activating) {
         HRActivate (mHTMLRec);
      } else {
         HRDeactivate (mHTMLRec);
      }
   }
}

This didn't completely solve the problem, however. We saw the HTMLPane's scrollbars even when the pane was hidden. This was because the scrollbars were not properly embedded within the HTML UserPane. The HTML Rendering Lib creates scrollbars on the fly as needed. Those scrollbars end up embedded in the root control. Because they are not embedded in the HTML UserPane they are not hidden/shown along with the pane. Our solution is to look for newly created controls in the root control and embed them in our UserPane control.

Before we call any function that might create other controls we call CountRootControls. Afterwards, we call EmbedNewControls. If there are more controls afterwards than before, those new controls should be embedded in our UserPane, not in the root control.

//—————
UInt16      AMUserPane::CountRootControls ()
{
   UInt16            numControls = 0;
   WindowRef      theWindow;
   ControlRef      root;

   theWindow = GetOwnerWindow ();
   ::GetRootControl (theWindow, &root);
   ::CountSubControls (root, &numControls);

   return numControls;
}

//—————
void   AMUserPane::EmbedNewControls (
   UInt16         inBeforeNum)
{
   WindowRef      theWindow;
   ControlRef      root;
   UInt16            afterNum;
   UInt16            i;
   ControlRef      child;

   theWindow = GetOwnerWindow ();
   ::GetRootControl (theWindow, &root);
   ::CountSubControls (root, &afterNum);
   for (i = afterNum; i > inBeforeNum; i—) {
      ::GetIndexedSubControl (root, i, &child);
      ::EmbedControl (child, mControl);
   }
}

In most of our UserPanes' Initialize functions we call CountNewControls and EmbedNewControls just in case subcontrols are created. The HTMLPane's Initialize is typical. We get a "before" count of root controls, create a new HRReference, then set its bounds to the UserPane control's bounds. We install a DrawProc, TrackingProc, and ActivateProc. Finally, we embed the newly created controls (scrollbars) in the UserPane.

//—————
void   AMHTMLPane::Initialize (
   ControlHandle      inControl)
{
   AMUserPane::Initialize (inControl);

   OSErr         err = noErr;
   UInt16         beforeNum;
   Rect            cntlRect;
   GrafPtr      ownerPort;

   beforeNum = CountRootControls ();

   GetControlRect (&cntlRect);

   ownerPort = (GrafPtr) GetWindowPort (GetOwnerWindow ());
   err = HRNewReference (&mHTMLRec, kHRRendererHTML32Type, ownerPort);

   if (err == noErr) {
      HRSetRenderingRect (mHTMLRec, &cntlRect);
      HRSetDrawBorder (mHTMLRec, true);

      SetDrawProc ();
      SetTrackingProc ();
      SetActivateProc ();
   }

   EmbedNewControls (beforeNum);
}

The HTMLPane was now working well - until we viewed an HTML file that had a frameset. Suddenly, there were two new scrollbars and they were not embedded properly. So we added CountRootControls and EmbedNewControls to the DoDraw function. Other than that, the DoDraw is very simple.

//—————
void   AMHTMLPane::DoDraw (
   SInt16         part)
{
   UInt16         beforeNum;
   Rect            cntlRect;

   beforeNum = CountRootControls ();

   GetControlRect (&cntlRect);
   HRSetRenderingRect (mHTMLRec, &cntlRect);

   RectRgn (mHTMLRgn, &cntlRect),
   HRDraw (mHTMLRec, mHTMLRgn);

   EmbedNewControls (beforeNum);
      // in case last click created new scroll bars
}

The DoTracking function is very simple. About all it does is ask the HTML Rendering library to handle the event. We could have synthesized a mouse–down event from the Start Point but instead we call an external function to get the current event record from our main event–handling code.

//—————
ControlPartCode      AMHTMLPane::DoTracking (
   Point            startPt,
   ControlActionUPP   actionProc)
{
   WindowRef      owner = GetOwnerWindow ();

   ::SetPortWindowPort (owner);
   ::HRIsHREvent (GetCurrentEventRecord ());

   return 99;   // any non-zero code
}

Using a UserPane

Okay, so we have written a UserPane class. How do we use it? That's the easy part. First, create a UserPane control resource. For a window or a dialog, create a CNTL with procID 256 and initial value 318. This value turns on feature bits for SupportsEmbedding, SupportsFocus, WantsIdle, WantsActivate, HandlesTracking, and GetsFocusOnClick. For a dialog, in its DITL resource create an item of type Control and set its ID to the resource ID of the CNTL resource.

Wherever you declare the variables (data members) for your window or dialog, declare an instance of the UserPane class. We find it convenient also to declare a ControlHandle. You'll also have to #include the UserPane class's header.

#include "AMColorSwatch.h"
   ControlHandle   mSwatchHandle;
   AMColorSwatch   mSwatchPane;

When you create a window, get a ControlHandle to the UserPane control, then initialize the instance of the UserPane class.

   mSwatchHandle = ::GetNewControl (CNTL_Swatch, window);
   mSwatchPane.Initialize (mSwatchHandle);

In your window's event handling code for a mouse–down, call the usual FindControl. If the click is in the UserPane control, call the usual TrackControl or HandleControlClick.

   if (whichControl == mSwatchHandle) {
      if (HandleControlClick (mSwatchHandle, where, curEvent.modifiers, nil) != 0) {
      }
   } else if (mSwatchPane.ClickSubControl (whichControl, where)) {
      // ClickedSwatch ();
   }

What is "ClickSubControl"? If the UserPane has any subcontrols, e.g. scrollbars, then FindControl may find that the click was in the scrollbar. ClickSubControl checks to see if the click was in one of the UserPane's subcontrols. If it was, then ClickSubControl passes the click along to the UserPane class's DoTracking method and returns true. If the click was not in a subcontrol, then ClickSubControl returns false.

//—————
Boolean      AMUserPane::ClickSubControl (
   ControlRef      inControl,
   Point            inWhere)
{
   UInt16            numSubs;
   UInt16            i;
   ControlRef      sub;

   ::CountSubControls (mControl, &numSubs);
   for (i = 1; i <= numSubs; i++) {
      ::GetIndexedSubControl (mControl, i, &sub);
      if (inControl == sub) {
         DoTracking (inWhere, nil);
            // treat it as a click in the userPane
         return true;
      }
   }
   return false;
}

The example application doesn't have any UserPanes in a dialog but it's easy to do. After creating the dialog, call GetDialogItemAsControl to get a ControlHandle to the UserPane. Then Initialize the UserPane instance with the control handle. The Control Manager and Dialog Manager will take care of almost everything. You just add a case to your dialog's switch statement.

There is one other piece of code you will have to add if your UserPane has subcontrols. You'll have to add a Filter function because the Dialog Manager doesn't know anything about the subcontrols. The Filter function will have code like this:

      if (mQuickTimePane.FilterSubControls (ioEvent)) {
         *outItemHit = kQuickTimePane;
         return true;
      }

FilterSubControls checks to see if the event is a mouse–down. If it is, then FilterSubControls calls FindWindow and FindControl, then calls ClickSubControl, which we saw earlier.

//—————
// if the event is for one of our subcontrols
// then process it as if it were for us;
// pass back true to tell Dialog Manager
// that event has been processed
//
Boolean      AMUserPane::FilterSubControls (
   EventRecord      *ioEvent)
{
   Boolean         filtered = false;
   UInt16         numControls = 0;
   WindowPtr      whichWindow;
   ControlHandle   whichControl;
   Point         localWhere;
   short         partCode;
   UInt16         i;
   ControlRef      sub;

   ::CountSubControls (mControl, &numControls);
   if (numControls > 0) {
      if ((ioEvent->what == mouseDown)
      && (FindWindow (ioEvent->where, &whichWindow) == inContent)) {
         SetPortWindowPort (whichWindow);
         localWhere = ioEvent->where;
         GlobalToLocal (&localWhere);
         FindControl (localWhere, whichWindow, &whichControl);
         if (ClickSubControl (whichControl, localWhere)) {
            return true;
               // => click was for this userPane
         }
      }
   }
   return filtered;
}

Summary

We've described two of our UserPanes - the Color Picker and the HTML Renderer. The other four UserPanes - for QuickTime, MLTE, StoneTable, and WASTE - are similar. The AMUserPane class, all six UserPane classes, and the example application are available as source code. The controls are useful and easy to use. If you use any of them we would be interested in hearing from you.

A Plug

These UserPane classes are part of the AppMaker library. The example was created using AppMaker, which generated both the resources and the source code. Whether you use AppMaker or you do it by hand, I think you will find that these UserPanes are very useful widgets to have in your toolbox.


Spec Bowers is the founder, cook, and chief bottle washer at Bowers Development. He has been developing programming tools for most of his career. You can contact him at bowersdev@aol.com or see the web page at http://members.aol.com/bowersdev.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

5 slither.io mash-ups we'd love to...
If there's one thing that slither.io has proved, it's that the addictive gameplay of Agar.io can be transplanted onto basically anything and it will still be good fun. It wouldn't be surprising if we saw other developers jumping on the bandwagon,... | Read more »
How to navigate the terrain in Sky Charm...
Sky Charms is a whimsical match-'em up adventure that uses creative level design to really ramp up the difficulty. [Read more] | Read more »
Victorious Knight (Games)
Victorious Knight 1.3 Device: iOS Universal Category: Games Price: $1.99, Version: 1.3 (iTunes) Description: New challenges awaits you! Experience fresh RPG experience with a unique combat mechanic, packed with high quality 3D... | Read more »
Agent Gumball - Roguelike Spy Game (Gam...
Agent Gumball - Roguelike Spy Game 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Someone’s been spying on Gumball. What the what?! Two can play at that game! GO UNDERCOVERSneak past enemy... | Read more »
Runaway Toad (Games)
Runaway Toad 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: It ain’t easy bein’ green! Tap, hold, and swipe to help Toad hop to safety in this gorgeous new action game from the creators of... | Read more »
PsyCard (Games)
PsyCard 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers och Card City Nights, Progress To 100 and Ittle Dew PSYCARD is a minesweeper-like game set in a cozy cyberpunk... | Read more »
Sago Mini Robot Party (Education)
Sago Mini Robot Party 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: -- Children's Technology Review Editor's Choice -- | Read more »
How to get a high score in every level o...
Sky Charms is an adorable match three puzzler that provides a decent challenge thanks to its creative level design. It regularly presents something new, forcing you to think on your feet. [Read more] | Read more »
Apestorm: Full Bananas (Games)
Apestorm: Full Bananas 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: ***Launch sale – limited time only!*** Fugitive Apes have taken to the skies in search of revenge after humans have... | Read more »
How to create bigger words in Spellspire
Words have power. At least they do in Spellspire,a game about blasting out magical attacks by making words out of a jumble of letters. And it's a lot of fun. But if you want to be the best, you're going to have to think tactically when you start... | Read more »

Price Scanner via MacPrices.net

15-inch 2.2GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.2GHz Retina MacBook Pro on sale for $1699.99 including free shipping. Their price is $300 off MSRP, and it’s the lowest price available for this model from any reseller (and... Read more
Apple Beats Microsoft at Own Game; Amazon Pri...
First quarter seasonality combined with an overall disinterested customer base led to an annual decline of 14.7% in worldwide tablet shipments during the first quarter of 2016 (1Q16). Worldwide... Read more
Aleratec Releases Mac Software Upgrade for 1...
California based Aleratec Inc., designer, developer and manufacturer of Portable Device Management (PDM) charge/sync products for mobile devices and professional-grade duplicators for hard disk... Read more
Sale! Amazon offers 27-inch iMac, 13-inch 2.9...
Amazon has the 27″ 3.2GHz 5K iMac and the 13″ 3.9GHz Retina MacBook Pro on sale for $300 off MSRP, each including free shipping, for a limited time: - 27″ 3.2GHz/1TB HD 5K iMac (model MK462LL/A): $... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
13-inch 2.7GHz/128GB Retina MacBook Pro on sa...
Take $200 off MSRP on the price of a new 13″ 2.7GHz/128GB Retina MacBook Pro (model MF839LL/A) at Amazon. Shipping is free: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099.99 $200 off MSRP Act now if... Read more
Apple refurbished clearance 15-inch Retina Ma...
Apple has Certified Refurbished 2014 15″ 2.2GHz Retina MacBook Pros available for $1609, $390 off original MSRP. Apple’s one-year warranty is included, and shipping is free. They have refurbished 15... Read more
27-inch 5K iMacs on sale for up to $150 off M...
B&H Photo has 27″ 5K iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2199 $100 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $1849.99 $150... Read more
What Does The Refreshed 12-Inch MacBook Tell...
A lot of commentators are complaining that Apple’s update of the 12-Inch MacBook last week is a bit of a damp squib. I don’t know what they were expecting, since it would be very unlike Apple to do a... Read more
Free Wittify Keyboard Now Available On The Ap...
A team of Harvard Business School students have announced that the Wittify Keyboard, a new app utility for iOS devices, is now available on the Apple App Store. The Wittify keyboard and application... 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* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 48260200 Phoenix, Arizona, United States Posted: Apr. 22, 2016 Weekly Hours: 40.00 **Job Summary** As an Apple Solutions Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the largest premier retailer of Apple products in the nation. In order to support our growing customer base, we are currently looking for a driven 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.