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


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,
                sizeof (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;


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 or see the web page at


Community Search:
MacTech Search:

Software Updates via MacUpdate

Gopogo guide - How to bounce like the be...
Nitrome just launched a new game and, as to be expected, it's a lot of addictive fun. It's called Gopogo, and it challenges you to hoparound a bunch of platforms, avoiding enemies and picking up shiny stuff. It's not easy though - just like the... | Read more »
Sago Mini Superhero (Education)
Sago Mini Superhero 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: KAPOW! Jack the rabbit bursts into the sky as the Sago Mini Superhero! Fly with Jack as he lifts impossible weights,... | Read more »
Star Wars: Galaxy of Heroes guide - How...
Star Wars: Galaxy of Heroes is all about collecting heroes, powering them up, and using them together to defeat your foes. It's pretty straightforward stuff for the most part, but increasing your characters' stats can be a bit confusing because it... | Read more »
The best cooking apps (just in time for...
It’s that time of year again, where you’ll be gathering around the dinner table with your family and a huge feast in front of you. [Read more] | Read more »
Square Rave guide - How to grab those te...
Square Rave is an awesome little music-oriented puzzle game that smacks of games like Lumines, but with its own unique sense of gameplay. To help wrap your head around the game, keep the following tips and tricks in mind. [Read more] | Read more »
Snowboard Party 2 (Games)
Snowboard Party 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Crowned the best snowboarding game available on the market, Snowboard Party is back to fulfill all your adrenaline needs in... | Read more »
One Button Travel (Games)
One Button Travel 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: “To cut a long story short, If you like interactive fiction, just go buy this one.” - “Oozes the polish that... | Read more »
Light Apprentice Volume 1 (Games)
Light Apprentice Volume 1 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Light Apprentice Volume 1 includes Chapters 1 to 4, all gathered in a new exclusive game. When life in the world of... | Read more »
The best games like Animal Crossing on m...
Animal Crossing amiibo Festival is out right now for the Wii U, reminding us of just how much fun that world can be. Or at least to go back and check in on our villages once in a while. [Read more] | Read more »
Between 2 Taps - Tap for Tap interview M...
Hello, and welcome back to Between 2 Taps, Tap for Tap’s Indie Dev interview series. [Read more] | Read more »

Price Scanner via

iMobie Releases its Ace iOS Cleaner PhoneClea...
iMobie Inc. has announced the new update of PhoneClean 4, its iOS cleaner designed to reclaim wasted space on iPhone/iPad for use and keep the device fast. Alongside, iMobie hosts a 3-day giveaway of... Read more
Black Friday deals on the Apple Watch and App...
Apple resellers are offering discounts and bundles with the purchase of an Apple Watch this Black Friday weekend. Below is a roundup of the deals being offered by authorized Watch resellers: Apple... Read more
Early Black Friday sale at B&H Photo, up...
B&H Photo has all new Macs on sale for up to $500 off MSRP as part of their early Black Friday sale including free shipping plus NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1699 $300 off... Read more
NewerTech/OWC/MacSales Black Friday Deals 201... • Free Shipping available on nearly EVERYTHING on orders $35.00 & up within USA + • International Delivery Specials from $2.99+ Special Purolator... Read more
Walmart Black Friday deals: $100 off select i...
Walmart has released their Black Friday deals for 2015, now available online. Choose free shipping or free local store pickup (if available): - 16GB iPad Air 2: $399, $100 off MSRP - 16GB iPad Air: $... Read more
Photo Cleaner 1.0 Reclaims iPhone Storage Spa...
Seoul, Korea based mix1009 has announced the release and immediate availability of Photo Cleaner 1.0, their handy iPhone app that deletes the video portion of Live Photos, in order to reclaim space... Read more
Black Friday and Holiday sales on our price t...
Scan our Mac Price Trackers for the latest Black Friday and Holiday season information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the... Read more
Best Buy Black Friday deals: Up to $200 off M...
Best Buy has posted their Black Friday sale prices for 2015. Save on MacBook Pros, MacBooks, MacBook Airs, iMacs, iPads, and Apple Watches. Choose free shipping or free local store pickup (if... Read more
Save $30-$40 on new Apple TVs after rebate
Adorama has new Apple TVs on sale for up to $40 off MSRP after mail-in rebate, good through December 15th. Shipping is free, and Adorama charges NY & NJ sales tax only: - 32GB Apple TV: $119.99... Read more
13-Inch Haswell MacBook Air At Two Years – Th...
The 13-inch mid-2013 “Haswell” MacBook Air I ordered in Apple’s November 2013 Black Friday sale was my first new Mac in four and a half years — the longest interval I’ve gone between system upgrades... Read more

Jobs Board

Storefront Operations Coordinator, *Apple* -...
# Storefront Operations Coordinator, Apple -Latin America Job Number: 43587750 Miami, Florida, United States Posted: Oct. 16, 2015 Weekly Hours: 40.00 **Job Summary** The Read more
*Apple* Enterprise / Government Professional...
# Apple Enterprise / Gove ment Professional Services Engineer Job Number: 42292976 Reston, Virginia, United States Posted: Aug. 18, 2015 Weekly Hours: 40.00 **Job Read more
iOS Wallet & *Apple* Pay Engineer - App...
# iOS Wallet & Apple Pay Engineer Job Number: 40586801 Santa Clara Valley, Califo ia, United States Posted: Nov. 16, 2015 Weekly Hours: 40.00 **Job Summary** The iOS Read more
Software Engineer, *Apple* Watch - Clock Fa...
# Software Engineer, Apple Watch - Clock Face Team Job Number: 44368761 Santa Clara Valley, Califo ia, United States Posted: Nov. 14, 2015 Weekly Hours: 40.00 **Job Read more
Administrative Assistant, *Apple* Online St...
# Administrative Assistant, Apple Online Store Job Number: 43992352 Santa Clara Valley, Califo ia, United States Posted: Nov. 9, 2015 Weekly Hours: 40.00 **Job Summary** Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.