TweetFollow Us on Twitter

External Windows 1
Volume Number:7
Issue Number:2
Column Tag:XCMD Corner

Related Info: Window Manager Event Manager

External Windows

By Donald Koscheka, Contributing Editor

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

External Windows

This month, we are going to take a comprehensive look at external window management in Hypercard 2.0. External windows are easy to work with and if you’ve been programming the Macintosh for any amount of time, you won’t have any trouble with them. If you’re a newcomer to the field, external windows are an excellent place to start as the core of an external window management system is the same as any Macintosh application -- the event loop.

Hypercard 2.0 supports external windows in a much more generous fashion than was available under Hypercard 1.x. For one thing, external windows can support callbacks so that you can interface the window directly to Hypercard which was not possible under Hypercard 1.x. External windows do not pre-empt the card, both Hypercard windows and external windows (let’s call them xwindoids) coexist quite nicely in HC2.0.

Windows in Hypercard 2.0 exist in one of two layers, the document layer and the floating layer. Palettes live in the floating layer. Windows in this layer never get activate events -- they are active at all times that they are visible. The toolbox call to Frontwindow() will always return a pointer to a floating window if any floating windows are visible. The frontmost document window will be reported throughout the Hypercard callback, FrontDocWindow().

The document layer is the standard Macintosh windowing environment. Documents behave like typical Macintosh windows, they respond to all standard Macintosh events as well as some Hypercard specific events.

Opening Windows

Listing 1, xwindoids.c, depicts an xcmd that creates a window in the document layer. The window is created by a call to the Hypercard callback, NewXWindow(). In order for Hypercard to add your window to its document or floating layer, you must open your window using this callback or its close cousin, GetNewXWindow() which opens a window from a resource template. You can still use NewWindow if you have some old xcmd that supports external windows, but windows created by directly calling the window manager will not get Hypercard events nor will they be able to make callbacks to Hypercard.

The prototype for these two new callbacks are:

/* 1 */

extern pascal WindowPtr NEWXWINDOW(XCmdPtr paramPtr, Rect *boundsRect, 
StringPtr title, Boolean visible, short procID, Boolean color, Boolean 

extern pascal WindowPtr GETNEWXWINDOW(XCmdPtr paramPtr, ResType templateType, 
short templateID, Boolean color, Boolean floating);

Both callbacks return a standard window manager WindowPtr so there is nothing new there. Being callbacks, both routines need to have the paramPtr passed in. Notice that Apple changed the name of the paramPtr struct form XCmdBlkPtr to XCmdPtr. The structure remains unchanged however.

For NewXWindow, the rectangle, title, visible and procID all correspond to the equivalent parameters in NewWindow(). Similarly, GetNewXWindow() gets passed the id of the resource window template. You have the option of opening color windows and of making them floating or document windows by assigning true or false for these parameters. Listing 1 opens a non-color document window.

XWindoids Events

The xcmd creates the window and does nothing more with the window for the time being. It returns to Hypercard which will subsequently call this very same xcmd with an xOpenEvt hypercard event. This is important because it represents a departure away from the way we are used to thinking about xcmds. When an xcmd creates a window, it is said to “own” that window. Any events that must be handled for that window will be sent to that xcmd. Thus, Hypercard will call upon the xcmd to handle events in a manner that is transparent to the rest of Hypercard.

We detect whether the xcmd is being sent an event by checking the paramCount field in the xcmd command block. By convention, if the number of parameters is less than 0, then we have an event. In this case, Hypercard passes us a pointer to a Hypercard event record in params[0] . The hypercard event record looks like this:

/* 2 */

typedef struct XWEventInfo *XWEventInfoPtr; 
struct XWEventInfo {
 EventRecord event;
 WindowPtr eventWindow;
 long eventParams[9];
 Handle eventResult;

The first field in the record is the standard Macintosh event manager event record. Its fields correspond to the normal usage of an event record. The next field is a pointer to the window that the event is meant for. This is provided for the case of xcmds that handle more than 1 window. Our xcmd handles only one window so we can use this field to point to that window rather than calling FrontWindow() which might return the wrong result (since it always passes a visible palette as the front window).

EventParams and eventResult are used to pass information about specific events to the xcmd. None of the events in xwindoids.c uses these fields so we’ll reserve their discussion for the future.

If paramCount is zero, we dispatch the parameter block to our event handler, in this case a routine called “HandleHCEvent”. HandleHCEvent must first dereference the hypercard event record so that all of its fields are accessible. Next, we set passFlag to true. I’m still trying to piece together the rules for this. It seems that you pass true back to hypercard to tell it to handle the event and false to tell it not to handle the event. If anyone can illuminate this better than that, I will be happy to publish your explanation as the use of this field in relation to events is only briefly discussed in the Hypercard 2.0 xcmd technical documentation. In the meantime, I’ve been using trial and error to get the value of passflag right for each event.

Once the event record is dereferenced, HandleHCEvent closely resembles the event processing switch of any generic Macintosh Application. This is good, you can port your code to Hypercard very quickly by using listing 1 as a template. There is no need to call getNextEvent or WaitNextEvent. Hypercard is taking each event and deciding in turn whether it needs to be dispatched to an external window. Keep in mind that in order for an xcmd to get events, it must have a window associated with it. This is not quite according to Hoyle but it will do. Rather than address each case in the switch, let’s follow the event processing in the order that the events will be called.

Upon opening a new window, the very first event to be called will be xOpenEvt. It is here that we allocate any private storage needed by the window. In the case of xwindoids.c, we will fill the window up with a text edit record just to show that we can do some editing in the window. We store the TextEdit record off the window’s refcon so that we can find it easily. Use any storage schema that you’re comfortable with. If you’re using Think C, A4 Globals will work okay here also, make sure that you set up A4 first. A quick sideline: Think compilers do an outstanding job of supporting the kinds of features that you’ll need to write non-A5 relative code. I use Think “C” or Think Pascal exclusively for writing xcmds because of the multi-segment support and the ability to set up my own environment based off register A4.

Note that I only show the window, which was created as invisible only after taking the xOpenEvt. I figure that it’s better not to show the window until Hypercard is ready to deal with it which is at xOpenEvt time. That way the window does stare back at me with that slack-jawed blank content region look while I’m waiting for Hypercard to tell me that it’s okay to start using it. We need to set passFlag to true on xOpenEvt to tell hypercard that we took the event. From here on out, we will get all events intended for this window.

The next event we get is the activateEvt. This is the standard event manager activate event and is only passed to Document windows. Floating windows are always active so they don’t get activate events. We first check to see if we’re going active or inactive. If the former, then we can activate our text edit record and advise Hypercard that our window now has the edit (or input) focus by calling BeginXWEdit. Once this callback is made, Hypercard will send all keydowns to us until one of two events occurs: our window becomes inactive or Hypercard tells us to give up edit by sending us the xGiveUpEditEvt event. In order to be Hypercard friendly, we need to be prepared to give up the edit focus at any time, Hypercard will tell us when, but we should be courteous and acknowledge the event if we have the edit focus.

Once we become the active window, we will get the update evt followed by any number of events until such time as our window is closed. If the user clicks on the goaway box, Hypercard will advise us that our window is closing. First, the window will go inactive. Next we will get the XWCloseEvt event. At this time, we should close down our internal data structures associated with the window (such as the TEHandle). In listing 1, I hide the window here also. There is no need to call closeWindow or otherwise deallocate the window structures, Hypercard will do that for you.

As you can see from listing 1, there are a lot of new Hypercard events to talk about and we will get to the rest of them in future columns. The rest of event handling is standard Macintosh stuff and seems to work just fine. Note that in the null event handler (default:) we need to adjust the cursor ourselves if the mouse is in the edit box. I found that unless you set passflag to false, Hypercard will set the cursor back to the arrow on you here resulting in a flickering cursor.

Handling mousedown events is little different than you might be accustomed to also. In the case of the goaway control, we do the usual tracking but instead of closing the window directly, we issue a callback, CLOSEXWINDOW, to hypercard in effect asking hypercard to close the window for us. Hypercard will respond that the window is ready to be closed by sending us back an XWCloseEvt at some time in the future. Between the CloseXWindow call and the XWCloseEvt event, the window is in limbo, it might make sense to hide the window here to give the user the sense that the window closed but I find that the latency between these events just isn’t long enough to worry about that.

Dragging the window seems to be handled directly by Hypercard so we don’t do anything with that event. I handle the incontent hits as if this were a normal application. It seems to work fine although you do need to set the passFlag to false after handling the mousedown or Hypercard will get confused.

Similarly, keyevents can be handled directly. Command keys are handled directly by Hypercard so there is no need to test to see if we have a menu key. Again, we set passflag to false to tell hypercard that we took this event. If we set passflag to true here, hypercard will try to handle the event going so far as to call us back with an XWGiveUpEdit event. That would be bad.

Listing 1 is by no means complete. It doesn’t handle scrolling or the grow box yet. You may want to begin your own investigations by adding these features to listing 1. In any event, happy hacking. If you discover anything that you would like to share with the rest of the Mac community, please drop me a line on AppleLink (D6845) or America On Line (AFC Donald).

Listing 1:

/* File: xwindoid.c*/
/* */
/* A sample XCMD for Hypercard*/
/* 2.0 that displays and handles*/
/* an external window.    */
/* */
/* Well-behaved XCMDs for HC2.0  */
/* will respond to the ! and ?*/
/* requests by returning version*/
/* and usage information  */
/* respectively. */
/* */
/* ----------------------------  */
/* ©1990, Donald Koscheka */
/* All Rights Reserved    */

 ANSI-A4-- standard “C” libraries assembled
 off of register A4
 HyperXLib-- Hypercard 2.0 callback library available from 
 Apple Computer, Inc.
 xwindoid.c (contents of listing 1)
 Set Project Type:
 Type == XCMD | XFCN
 Name == xwindoid
 id == -32768..32767
 xwindoid “?”
 xwindoid “!”
 put the result
 Put xwindoid( “?” )
 Put xwindoid( “!” )

#ifndef NIL
 #define NIL(void *)0L

#define ETX 0x03 
#define BS0x08   
#define TAB 0x09
#define LF0x0A
#define NEWLINE  0x0D
#define CR0x0D
#define LEFT_ARROW 0x1C
#define RIGHT_ARROW0x1D
#define UP_ARROW 0x1E
#define DOWN_ARROW 0x1F

/* Multifinder events and masks  */
#ifndef MouseMovedEvt

#ifndef SuspendResumeEvt
 #defineSuspendResumeEvt  0x01

#ifndef ResumeEvtMask

#ifndef ConvertScrapMask
 #defineConvertScrapMask  0x02

pascal void HandleHCEvent( XCmdPtr pp );

Handle  strToParam( str )
 char *str;
* Given a pointer to a string,
* copy that string into a handle
* and return the handle.
* The input and output strings
* are both null-terminated
 Handle outH = NIL;
 long len = 0;
 len = strlen( str );
 if( len )
 if( outH = NewHandle( len ) )
 BlockMove( str, *outH, len + 1 );
 return( outH );

pascal void main( pp )
 Handle answer = NIL;
 char   *str;
 long   len;
 TEHandle hTE;
 Rect   bounds;
 pp->returnValue = NIL;

 if( pp->paramCount < 0 ){
 HandleHCEvent( pp );
 if (pp->paramCount == 1){
 if ( **(pp->params[0]) == ‘!’ ){
 pp->returnValue = strToParam(“\pxwindoid XCMD, version 1.0, ©1990, Donald 
 if ( **(pp->params[0]) == ‘?’ ){
 pp->returnValue = strToParam(“\pSimple xwindoid handler.”);
 /* now open a window to play with */ = bounds.left = 0;
 bounds.bottom = 320;
 bounds.right = 500;
 wind = NEWXWINDOW( pp, &bounds, “\pSample Window”, FALSE, documentProc, 
 CenterWindow( wind );

pascal void HandleHCEvent( XCmdPtr pp )
* Handle events in our xWindows  
* returns true if the event was handled ok
 XWEventInfoPtr  ip= pp->params[0];
 short  windoPart;
 TEHandle hTE;
 Rect   bounds;
 Point  hit;
 char   theKey;
 short  extend;
 pp->passFlag = TRUE;/* seems to be more often the case */
 switch( ip->event.what ){
 case mouseDown:
 windoPart = FindWindow( ip->event.where, &whichWindow );
 if( whichWindow )
 switch ( windoPart ){
 case inGoAway:
 if (TrackGoAway( whichWindow, ip->event.where) ){
 CLOSEXWINDOW( pp,whichWindow );
 pp->passFlag = FALSE;

 case inDrag:
 /* handled by hypercard */
 case inGrow:
 case inContent:
 if (whichWindow == FrontWindow() ){
 GetPort( &oldPort );
 SetPort( ip->eventWindow );
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 hit = ip->event.where;
 GlobalToLocal( &hit );
 bounds = (*hTE)->viewRect;
 if( PtInRect( hit, &bounds ) ){
 extend = (short)ip->event.modifiers && shiftKey;
 TEClick( hit, extend, hTE);
 SetPort( oldPort );
 SelectWindow( whichWindow );

 pp->passFlag = FALSE;
 }/* window part */
 case mouseUp:
 case keyDown:
 case autoKey: 
 /* the command key will be handled by hypercard */
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 GetPort( &oldPort );
 SetPort( ip->eventWindow );
 theKey  = ip->event.message & 0xFF;
 switch( theKey ){
 case TAB:
 case ETX:
 case UP_ARROW:
 case BS:
 TEKey( theKey, hTE );
 }/* switch( theKey ) */
 SetPort( oldPort );
 pp->passFlag = FALSE;
 case activateEvt:
 if ( ip->event.modifiers & activeFlag ){
 BEGINXWEDIT( pp, ip->eventWindow );
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 TEActivate( hTE );
 ENDXWEDIT( pp, ip->eventWindow );
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 TEDeactivate( hTE );
 case updateEvt: 
 BeginUpdate( ip->eventWindow );
 DrawGrowIcon( ip->eventWindow );
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 bounds = (*hTE)->viewRect;
 TEUpdate( &bounds, hTE );
 EndUpdate( ip->eventWindow );
 case app4Evt:
 unsigned char *evtType = &(ip->event.message);
 switch( *evtType ){
 case MouseMovedEvt:
 case SuspendResumeEvt:

 case xOpenEvt:
 /* for illustrative purposes, we  */
 /* add a text edit field to the   */
 /* window*/
 SetPort( ip->eventWindow );
 bounds = ip->eventWindow->portRect; += 4;
 bounds.left +=4;
 bounds.bottom -= 16;
 bounds.right -= 16;
 hTE  = TENew( &bounds, &bounds );
 (*hTE)->txFont = courier;
 (*hTE)->txFace = 0;
 (*hTE)->txSize = 10;
 SetWRefCon( ip->eventWindow, (long)hTE );
 ShowWindow( ip->eventWindow );
 case xCloseEvt:
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 TEDispose( hTE );
 HideWindow( ip->eventWindow );
 case xGiveUpEditEvt:
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 TEDeactivate( hTE );

 case xEditUndo:
 case xEditCut:
 case xEditCopy:
 case xEditPaste:
 case xEditClear:
 GetPort( &oldPort );
 SetPort( ip->eventWindow );
 GetMouse( &hit );
 hTE    = (TEHandle)GetWRefCon( ip->eventWindow );
 bounds = (*hTE)->viewRect;
 if( PtInRect( hit, &bounds ) ){
 SetCursor( *GetCursor(iBeamCursor) );
 TEIdle( hTE );
 pp->passFlag = FALSE;
 SetPort( oldPort );
 }/* switch theEvent->what */

Community Search:
MacTech Search:

Software Updates via MacUpdate

AirPort Utility 6.3.6 - Set up and manag...
Note: Most recent release available only within OS X 10.11 El Capitan update. Use AirPort Utility to set up and manage your Wi-Fi network and AirPort base stations, including AirPort Express, AirPort... Read more
Quicksilver 1.3.1 - Application launcher...
Quicksilver is a light, fast and free Mac application that gives you the power to control your Mac with keystrokes alone. Quicksilver allows you to find what you need quickly and easily, then act... Read more
Tidy Up (Five Users) 4.1.5 - Find duplic...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more
Mellel 3.4.3 - The word processor of cho...
Mellel is the leading word processor for OS X and has been widely considered the industry standard since its inception. Mellel focuses on writers and scholars for technical writing and multilingual... Read more
Skype - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
Bookends 12.6.0 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Access the power of Bookends directly from Mellel, Nisus Writer Pro, or MS Word (... Read more
Apple iBooks Author 2.4 - Create and pub...
Apple iBooks Author helps you create and publish amazing Multi-Touch books for iPad. Now anyone can create stunning iBooks textbooks, cookbooks, history books, picture books, and more for iPad. All... Read more
Web Snapper 3.3.9 - Capture entire Web p...
Web Snapper lets you capture Web pages exactly as they appear in your browser. You can send them to a file as images or vector-based, multi-page PDFs. It captures the whole Web page - eliminating the... Read more
Tunnelblick 3.6beta10 - GUI for OpenVPN...
Tunnelblick is a free, open source graphic user interface for OpenVPN on OS X. It provides easy control of OpenVPN client and/or server connections. It comes as a ready-to-use application with all... Read more
EtreCheck 2.5.1 - For troubleshooting yo...
EtreCheck is a simple little app to display 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... Read more

Camel Up (Games)
Camel Up 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Martian: Bring Him Home (Games)
The Martian: Bring Him Home 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Based on the best selling novel and critically acclaimed film, THE MARTIAN tells the story of Astronaut Mark... | Read more »
This Week at 148Apps: September 21-30, 2...
Leap Into Fall With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above... | Read more »
Tweetbot 4 for Twitter (Social Networki...
Tweetbot 4 for Twitter 4.0 Device: iOS Universal Category: Social Networking Price: $4.99, Version: 4.0 (iTunes) Description: *** 50% off for a limited time. *** | Read more »
Mori (Games)
Mori 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Stop, rewind and unwind with Mori. Time is always running, take a moment to take control. Mori is an action puzzle game about infinitely... | Read more »
100 Years' War (Games)
100 Years' War 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Tower in the Sky (Games)
Tower in the Sky 0.0.60 Device: iOS Universal Category: Games Price: $1.99, Version: 0.0.60 (iTunes) Description: | Read more »
hocus. (Games)
hocus. 1.0.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0.0 (iTunes) Description: New, polished, mind-bending, minimal puzzle game with dozens of levels and extra-ordinary design Features:- Beautifully crafted... | Read more »
Mos Speedrun 2 (Games)
Mos Speedrun 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Mos is back, in her biggest and most exciting adventure ever! Wall-jump to victory through 30 mysterious, action packed levels... | Read more »
3D Touch could be a game-changer, but it...
Were you one of the lucky/financially secure enough ones to buy a new iPhone 6s or iPhone 6s Plus over the weekend? Yup, me too (I’m not convinced I was either of those two things, but let’s go with lucky for now), so I thought I’d delve into just... | Read more »

Price Scanner via

Apple offering refurbished 2015 13-inch Retin...
Apple is offering Certified Refurbished 2015 13″ Retina MacBook Pros for up to $270 (15%) off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: -... Read more
Apple refurbished 2015 MacBook Airs available...
Apple has Certified Refurbished 2015 11″ and 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and... Read more
Adobe Photoshop Elements 14 Gets Haze Removal...
The latest iteration of Adobe’s powerful consumer image editing appliction Photoshop Elements 14 analyzes your photo and removes background haze, so your shot looks sharp all the way to the horizon... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $100 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $1029.99 $70 off - 21″ 2.7GHz iMac: $1229 $70 off - 21″ 2.9GHz iMac: $... Read more
Bare Bones Software Releases TextWrangler 5.0...
Bare Bones Software has announced the release and immediate availability of TextWrangler 5.0, a major upgrade to its free, high performance, general purpose text editor for Mac OS X. Built on a new,... Read more
Apple refurbished iPad Air 2s available for u...
Apple has Certified Refurbished iPad Air 2s available for up to $140 off the price of new models. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB Wi-Fi iPad Air 2... Read more
Save up to $100 on Mac AppleCare Protection P...
Adorama has 3-Year AppleCare Warranties on sale for up to $100 off MSRP including free shipping plus NY & NJ sales tax only: - Mac Laptops 15″ and Above: $249 $100 off MSRP - Mac Laptops 13″ and... Read more
Updated Mac Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more
27-inch 3.5GHz 5K iMac on sale for $81 off MS...
Adorama has the 27″ 3.5GHz 5K iMac on sale for $2218.99, $81 off MSRP, including a free copy of Apple’s 3-Year AppleCare Protection Plan, plus a free external DVD/CD drive, and a copy of Corel... Read more

Jobs Board

Senior Payments Security Manager - *Apple*...
**Job Summary** Apple , Inc. is looking for a highly motivated, innovative and hands-on senior payments security manager to join the Apple Pay security team. You will Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Site Security Manager - Apple (Unite...
**Job Summary** The Site Security Manager is a high-profile security position at Apple . The Site Manager is the face of Apple Global Security (GS) and primary point Read more
*Apple* Fulfillment Operations Execution Ana...
**Job Summary** The AMR Apple Fulfillment Operations Team is seeking a talented team player to drive the Apple Online Store (AOS) fulfillment performance to ensure a Read more
*Apple* Distinguished Educator (ADE) Communi...
**Job Summary** Apple is seeking candidates for a new position on the Apple Distinguished Educator (ADE) Program team as ADE Community Support Manager. Join a team Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.