TweetFollow Us on Twitter

Help in a Balloon
Volume Number:5
Issue Number:6
Column Tag:System 7 Workshop

Related Info: Help Manager

Help Comes in a Balloon

By John R. Powers, III, Monte Sereno, CA

[John’s profession is to help people use and understand interactive multimedia. He, in turn, has the help of friends who include a wife, five sons, a dog, a cat, and two horses. No wonder he enjoys it so much. You can contact him on AppleLink at “JohnPowers”.]

Introduction

How many users really read the User’s Guide before using a computer program? While there are probably a few, I suspect that most are itching to get their hands on the software and don’t bother to read the instructions. The user stumbles along learning by trial and error and, when they absolutely have to, refer to the manual or on-line help. In the meantime they browse the interface asking “What is this?”, “What does it do?”, and “What happens when I click it?” Fortunately, Apple’s System 7.0 Balloon Help™ software program has come along to provide a way to answer the user’s questions.

Balloon Help, when properly implemented, allows users to browse the interface and discover an application’s functionality. It’s build into the System 7.0 Help Manager and is available to all applications. The System 7.0 Finder™ operating system software will already have Balloon Help available with over a thousand balloons. Thanks to some ingenious design, Apple has made it easy for you to add Balloon Help to your own application.

There are three ways that Balloon Help can be used in an application. The first is automatically provided by the Help Manager. When the user chooses “Show Balloons” from the always-present help icon, the Help Manager will display default balloons for the standard interface elements of your application. It will explain the close box, the zoom box, and other generic interface elements. This is the default and always provided when “Show Balloons” is active.

The second way is driven by help resources that you have stored in your application resource fork. The Help Manager scans the help resources and displays balloons for your menu items, windows, and dialogs. You decide which interface elements are supported and what is displayed for each. It is all resource driven so you don’t need to recompile your application. Localization is simplified because only the resources need to be changed. A new tool, BalloonWriter™ software program, has been provided by Apple to aid you in writing balloons for any application.

The third way is driven by procedure calls in your code. These are custom balloons. You track the mouse and make a call to the Help Manager to display a balloon. It is this third method that we will focus on.

Custom Balloons

I am going to use HyperCard® software program examples for a variety of reasons. First, it’s easy to create the interface elements in HyperCard. Second, using balloons to explain a card’s interface elements is extremely helpful to a user (you’ll become a believer once you add balloons to your stack - it really helps!) Second, default and standard balloons are not available for fields and buttons in a stack so custom balloons are the only solution. Balloon Help should be built into HyperCard but it isn’t, until it is we’ll just have to use a XFCN extension.

Our goals for adding Balloon Help to a stack are as follows:

1. Give the HyperTalk® scripting language full control over balloons. The script should be able to turn Balloon Help on and off, put any text into a balloon, and display the balloon at any card location.

2. Use the build-in features of the Help Manager to reduce the HyperTalk scripting burden.

3. Preserve the interface of Balloon Help so that the user makes a seamless transition from using Balloons outside the stack to within the stack.

Our approach is to use a command-driven XFCN to do the following:

• Turn Balloon Help on and off

• Show and remove balloons

• Optionally let the Help Manager track our cursor

To make our use of Balloon Help seamless we follow these rules:

• Balloons cannot be displayed unless Balloon Help is turned on. This can be done by the user’s choosing “Show Balloons” in the help menu or with a XFCN command. The appearance of a balloon should not surprise the user. They should always have control over whether or not balloons can be displayed.

• Removing balloons is done if any one of the following events happens: (1) the cursor leaves the object of interest, (2) Balloon Help is turned off, (3) the Help Manager displays another balloon.

Invoking Our Balloon

Here is an example of a balloon explaining a button:

The button script looks like this:

--1

on mouseEnter
 ShowABalloon “Click on this”¬
 && “button to see the version”¬
 && “identification of the XFCN.”¬
end mouseEnter

on mouseLeave
  RemoveABalloon
end mouseLeave

on mouseUp
 put Help(“!”) into msg box
end mouseUp

The button script invokes the handlers “ShowABalloon” and “RemoveABalloon”.

--2

on ShowABalloon helpMessage
 put Help(“ShowBalloon”,¬
 helpMessage, prettyTip())¬
 into cd fld “helpResult”
 Be853Free helpMessage,¬
 prettyTip()
end ShowABalloon

on RemoveABalloon
 put Help(“RemoveBalloon”)¬
 into cd fld “helpResult”
end RemoveABalloon

The workhorses are ShowABalloon and RemoveABalloon, but to make things just perfect, we add two more handlers, “prettyTip” and “Be853Free”.

--3

function prettyTip
 -- Create a pretty location
 -- for the balloon tip.
 -- Use lower-right corner of
 -- button with a wee tweak.
 put the rect of the target¬
 into targetRect
 put item 3 of targetRect¬
 & “,” & item 4 of targetRect¬
 into tip
 subtract 10 from item 1 of tip
 subtract 10 from item 2 of tip
 return tip
end prettyTip

on Be853Free helpMessage, tip
 -- a -853 means that the
 --Help Manager detected a
 -- rapid cursor movement and,
 -- thinking that the cursor
 -- was just ‘passing thru’,
 -- did not display the balloon.
 -- We try again until successful.
 repeat until “-853”¬
 is not in cd fld “helpResult”
 put Help(“ShowBalloon”,¬
 helpMessage, tip)¬
 into cd fld “helpResult”
 end repeat
end Be853Free

PrettyTip calculates a location for the balloon tip that looks nice. This function can be made as sophisticated as you want, but the idea is to put the tip in a place that will not obscure the object.

Be853Free is one of those “gotchas” that you don’t discover until you actually use the Help Manager. It seems that the Help Manager is always tracking the cursor, just in case you move over a default or standard object and a balloon needs to be displayed. This is always happening. However, the Help Manager won’t display a balloon if you move across a hot spot too quickly. The assumption is that you will linger on a stop for a few milliseconds if you want some help otherwise you are just “passing thru”. As a result, the Help Manager is looking at the velocity of the cursor to determine if you are lingering or passing thru. If the velocity is too fast, it assumes that you don’t want a balloon flashing up and restrains itself. This process came about from a lot of careful tweaking and user studies. However, this can work against you when you are tracking the cursor yourself and putting up balloons. Our example above uses the “mouseWithin” message to indicate that the cursor is within the object. We invoke Balloon Help thru our XFCN. In the milliseconds that pass during this process, the cursor is probably still moving and the Help Manager may abort the balloon display. If it does, it returns a -853 result code. Our Be853Free handler persistently re-invokes the Help Manager until the balloon is finally displayed. In practice, this happens a lot, but only takes a few hundredths of a second. The user is never aware of a delay.

We could have solved the -853 result code issue in the XFCN by having the XFCN code persistently call the Help Manager until the -853 result code disappears. In the interest of giving the HyperTalk scripter more control, I elected to handle it in HyperTalk.

Into the Code

The actual code to invoke the Help Manager is fairly simple and is described in chapter 11 of Inside Macintosh Volume VI. Rather than load down this article with a lengthy code listing, I’ll walk you thru the process with an description, pseudo-code, and code snippets.

The first thing we do upon entry into the XFCN is to check for the “!” and “?” commands. This has become a fairly standard way for HyperTalk scripters to query the XFCN to determine version (!) and syntax (?).

Balloon Help obviously needs the Help Manager so we’ll need to use the Gestalt test for the Help Manager. To be really safe, we need to check for the Gestalt Manager first. The XFCN may be in a stack running on a pre-7.0 system and we don’t want any “unimplemented traps” crashes. The Compatibility chapter of Inside Macintosh Volume VI describes some simple tests for the Gestalt trap and how to test for the Help Manager.

We previously set some rules about when balloons can and cannot be displayed. From these rules we can make a decision table which describes the action to be taken for each of our four commands as follows:

Balloon Help

Command On Off

“On” -- turn on

“Off” turn off --

“ShowBalloon” show --

“RemoveBalloon” remove --

We use HMGetBalloons() to get the current state of Balloon Help. If Balloon Help is already off and we received a “ShowBalloon” or “RemoveBalloon” command then we ignore the command and return to HyperCard. If an “On” or “Off” command is received, then we use HMSetBalloons() to change the state.

The first test can be done as follows:

/* 4 */

if(!HMGetBalloons()
 && (cmpStr(cmd,”ShowBalloon”)
 ||cmpStr(cmd,”RemoveBalloon”)))
 {
 paramPtr->returnValue = nil;
 return;
 }

We return an empty result because, according to our rules, this is not an error condition.

The “On” and “Off” commands can be processed with a simple instruction like the following:

/* 5 */

if((turnOn=cmpStr(cmd, “On”))
 || cmpStr(cmd, “Off”))
 err = HMSetBalloons(turnOn);

The variable “turnOn” get set to true if the command was “On” and false if it wasn’t. If either command was present, the new state of Balloon Help is set to the value of “turnOn”.

We save the biggest job for last - the processing of the “ShowBalloon” command. The call to the appropriate Help Manager routine is easy, but the overhead in translating the HyperCard parameters to something suitable for the Help Manager requires some work.

The first parameter is the command, “ShowBalloon”. The two additional parameters are the balloon text and the tip location.

A Pascal string is only one possibility for balloon content. Balloon Help will also accept PICT resource IDs, STR# resource IDs, TextEdit handles, picture handles, stylized text resource IDs, and STR resource IDs. We took the easy route and just passed a Pascal string.

The HMShowBalloon procedure requires a HMMessageRecord consisting of a message type identifier and the message string, handle, or ID depending on the type. In our case the message type identifier is “khmmString” and the message string is a Str255 Pascal string. We create our Pascal string by copying the HyperCard parameter handle into a Str255 as follows:

/* 6 */

HLock(paramPtr->params[1]);
strcpy((char *) str,
 paramPtr->params[1]);
HUnlock(paramPtr->params[1]);
c2pstr(str);

The preparation of the tip location is a bit harder because it is passed from HyperCard as a string containing the horizontal and vertical coordinates separated by a comma. We need to parse the string to separate the elements and form them into a type “Point”. The new extended XCMD interface provided with HyperCard 2.0 includes a callback to perform this chore for you. Its Pascal definition is as follows:

{7}

PROCEDURE StrToPoint(
 paramPtr: XcmdPtr;
 str: Str255;
 VAR pt: Point);

Once we have the text string and the tip location, we can set the defaults for the other parameters and call HMShowBalloon. The complete Pascal definition is as follows:

{8}

FUNCTION HMShowBalloon(
 message: HMMessageRecord;
 tip: Point;
 alternativeRect: RectPtr;
 tipProc: Ptr;
 theProc: Integer;
 varCode: Integer;
 method: Integer): OSErr;

The “message” and “tip” are the text string and the tip location. The remaining parameters provide opportunities to customize the balloons. You can change the relationship of the tip to the balloon, the shape and appearance of the balloon, and the handling of the screen bits beneath the balloon. HMShowBalloon has provided a great deal of flexibility to allow you to add your own personality to Balloon Help. The values used in our example are as follows:

message khmmString and
 the text from HyperCard
tipthe point from HyperCard
alternativeRect  see below
tipProc nil
theProc 0
varCode 0
method  kHMRegularWindow

The use of these parameters is described in the Help Manager chapter in Inside Macintosh Volume VI. The “alternativeRect” parameter has a dual function and an interesting “gotcha” so we’ll look at that further.

Using the “alternativeRect”

“alternativeRect” is used to define a “hot rectangle” for the Help Manager to use in tracking the cursor. If the cursor leaves the hot rectangle while the balloon is showing, the Help Manager will automatically remove the balloon. Removing a balloon when the cursor leaves the relevant area is the standard interface for Balloon Help. Our example earlier in this article used the “mouseLeave” handler to perform this operation for us. If we pass the rectangle of the object to the Help Manager, the Help Manager will do it for us automatically. This is one less thing that the HyperCard handlers need to do and it conforms to our rules for Balloon Help operation.

“alternativeRect” also has an interesting dual function. If we send a “ShowBalloon” for a tip location in which the resulting balloon will be off-screen, then the Help Manager will attempt to relocate the balloon. The Help Manager uses the “alternativeRect” to define the area where we want the tip of the balloon and attempts to move the balloon so that all of the balloon is on-screen. The “alternativeRect” need not be the same rectangle as our object. If we make “alternativeRect” smaller than our object, then we have a better chance of having the Help Manager fit the balloon on screen. If we make “alternativeRect” larger than our object, then we have a better change of not having our object obscured. There is a lot of flexibility in using “alternativeRect” and, fortunately, it is fairly easy in HyperCard to define object rectangles and try them out with the XFCN. Experimentation is recommended.

The “gotcha” in using the “alternativeRect” is that HMShowBalloon requires a pointer to the “alternativeRect”, but does not copy the rect into its own data structures. This requires the calling program to preserve the rect so that the pointer remains valid. Remember, the Help Manager is tracking the cursor and the “alternativeRect” after the HMShowBalloon call is executed. It needs the “alternativeRect” for an indefinite period until the cursor leaves the “alternativeRect”. Since HMShowBalloon does not copy or preserve “alternativeRect”, we must. In a standard application, we would probably put the “alternativeRect” in a global or other persistent data structure. However, we don’t have that luxury in a XFCN. No globals are allowed. To solve this problem, we must create a handle in the heap and save it between XFCN calls. All this is required because HMShowBalloon does not copy our “alternativeRect”.

To make it even dicier, the pointer containing the “alternativeRect” must remain available until HMShowBalloon is through with it. And it has to remained in a “locked” state. We really don’t know when HMShowBalloon is through with the “alternativeRect” pointer because we can’t test for the existence of specific balloons. In other words, once we create storage for the “alternativeRect” it can never go away unless Balloon Help is turned off. Fortunately, since the Help Manager allows only one balloon to be shown at a time, we need only one stash for “alternativeRect”. Having this tiny structure locked in the heap imposes some risk of fragmentation, but I’ve never observed any problems with this. How to save a smidgen of data between XCMD calls has been described in previous articles. Essentially, it involves allocating some storage on the application heap, locking it, storing the “alternativeRect”, converting the handle reference to ASCII, and storing the ASCII form in a HyperCard global. See the bibliography for articles describing this process ad nauseam.

In addition to the difficulties in saving the “alternativeRect”, the rect has to be converted from a HyperCard rect stored as a string of comma-separated values (left, top, right, bottom) to a QuickDraw rect stored as a Macintosh® computer rect structure (top, left, bottom, right). And, if all that wasn’t enough, the QuickDraw rect must be converted from HyperCard’s Local coordinates to Global coordinates. This requires two LocalToGlobal calls, one for each corner (top-left and bottom-right). There is no need to save the GrafPort or set the GrafPort since the Local coordinate system is already HyperCard’s. The Extended XCMD Interface includes a callback to convert a Pascal string passed by HyperCard into a Rect.

The “varCode”

Another interesting parameter is “varCode”. This parameter lets you specify the arrangement of the tip on the balloon. You have eight choices, from 0 to 7, representing two variants of the tip from each of four possible corners. This is very useful for placing the tip and balloon in a location that will not obscure the object being described. The following diagram shows the best variant for each direction of entry into the object.

To determine direction, you will need to either calculate the relative location of the tip in the “alternativeRect” or track cursor movement. The former will probably yield more consistent results and the latter more attractive results, the choice is yours.

Summary

Balloon Help is going to bring a new and enormously useful method of helping the user understand how to use your application or stack. You can either add balloons by creating balloon resources (“standard” balloons) or call the Help Manager directly (“custom” balloons). We have shown some basic techniques in adding custom balloons to HyperCard by using an XFCN. The basic model can turn Balloon Help on, turn it off, show a balloon, and remove a balloon. Extensions include adding hot rects, variants on the balloon shape and tip location, custom tips, custom balloon window definitions, and using PICTs, STR#, and other types of resources.

Adding balloons to your application or stack, even if they are only the standard balloons, will make it a lot easier for your user. It helps you explain your interface elements and your application’s functionality. It puts more control in the hands of your user and that’s what we are here for.

Finally, writing balloons will help you. It should be required duty in Macintosh programming boot camp. It an excellent exercise in user-oriented thinking and clarity. Go ahead. Write some balloons and send them to a friend today.

Bibliography

Inside Macintosh Volume VI. Chapter 3, Compatibility.

Inside Macintosh Volume VI. Chapter 11, The Help Manager.

Palmer, Jim. Interface Issues for Balloon Help. Apple Direct, December 1990, p.15ff.

Powers, John R. Mac To Mainframe with HyperCard. MacTutor, June 1990, p.10ff.

Powers, John R. Communicating With HyperCard. MacTech Quarterly, Spring 1990, p.36ff.

Acknowledgement

Thanks to Randy Carr, the creator of the System 7.0 Help Manager, for his counsel.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Pack a magnifying glass and practice you...
Somehow it has already been a year since Torchlight: Infinite launched, and XD Games is celebrating by blending in what sounds like a truly fantastic new update. Fans of Cthulhu rejoice, as Whispering Mist brings some horror elements, and tests... | Read more »
Summon your guild and prepare for war in...
Netmarble is making some pretty big moves with their latest update for Seven Knights Idle Adventure, with a bunch of interesting additions. Two new heroes enter the battle, there are events and bosses abound, and perhaps most interesting, a huge... | Read more »
Make the passage of time your plaything...
While some of us are still waiting for a chance to get our hands on Ash Prime - yes, don’t remind me I could currently buy him this month I’m barely hanging on - Digital Extremes has announced its next anticipated Prime Form for Warframe. Starting... | Read more »
If you can find it and fit through the d...
The holy trinity of amazing company names have come together, to release their equally amazing and adorable mobile game, Hamster Inn. Published by HyperBeard Games, and co-developed by Mum Not Proud and Little Sasquatch Studios, it's time to... | Read more »
Amikin Survival opens for pre-orders on...
Join me on the wonderful trip down the inspiration rabbit hole; much as Palworld seemingly “borrowed” many aspects from the hit Pokemon franchise, it is time for the heavily armed animal survival to also spawn some illegitimate children as Helio... | Read more »
PUBG Mobile teams up with global phenome...
Since launching in 2019, SpyxFamily has exploded to damn near catastrophic popularity, so it was only a matter of time before a mobile game snapped up a collaboration. Enter PUBG Mobile. Until May 12th, players will be able to collect a host of... | Read more »
Embark into the frozen tundra of certain...
Chucklefish, developers of hit action-adventure sandbox game Starbound and owner of one of the cutest logos in gaming, has released their roguelike deck-builder Wildfrost. Created alongside developers Gaziter and Deadpan Games, Wildfrost will... | Read more »
MoreFun Studios has announced Season 4,...
Tension has escalated in the ever-volatile world of Arena Breakout, as your old pal Randall Fisher and bosses Fred and Perrero continue to lob insults and explosives at each other, bringing us to a new phase of warfare. Season 4, Into The Fog of... | Read more »
Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links below... | Read more »
Marvel Future Fight celebrates nine year...
Announced alongside an advertising image I can only assume was aimed squarely at myself with the prominent Deadpool and Odin featured on it, Netmarble has revealed their celebrations for the 9th anniversary of Marvel Future Fight. The Countdown... | Read more »

Price Scanner via MacPrices.net

Every model of Apple’s 13-inch M3 MacBook Air...
Best Buy has Apple 13″ MacBook Airs with M3 CPUs in stock and on sale today for $100 off MSRP. Prices start at $999. Their prices are the lowest currently available for new 13″ M3 MacBook Airs among... Read more
Sunday Sale: Apple iPad Magic Keyboards for 1...
Walmart has Apple Magic Keyboards for 12.9″ iPad Pros, in Black, on sale for $150 off MSRP on their online store. Sale price for online orders only, in-store price may vary. Order online and choose... Read more
Apple Watch Ultra 2 now available at Apple fo...
Apple has, for the first time, begun offering Certified Refurbished Apple Watch Ultra 2 models in their online store for $679, or $120 off MSRP. Each Watch includes Apple’s standard one-year warranty... Read more
AT&T has the iPhone 14 on sale for only $...
AT&T has the 128GB Apple iPhone 14 available for only $5.99 per month for new and existing customers when you activate unlimited service and use AT&T’s 36 month installment plan. The fine... Read more
Amazon is offering a $100 discount on every M...
Amazon is offering a $100 instant discount on each configuration of Apple’s new 13″ M3 MacBook Air, in Midnight, this weekend. These are the lowest prices currently available for new 13″ M3 MacBook... Read more
You can save $300-$480 on a 14-inch M3 Pro/Ma...
Apple has 14″ M3 Pro and M3 Max MacBook Pros in stock today and available, Certified Refurbished, starting at $1699 and ranging up to $480 off MSRP. Each model features a new outer case, shipping is... Read more
24-inch M1 iMacs available at Apple starting...
Apple has clearance M1 iMacs available in their Certified Refurbished store starting at $1049 and ranging up to $300 off original MSRP. Each iMac is in like-new condition and comes with Apple’s... Read more
Walmart continues to offer $699 13-inch M1 Ma...
Walmart continues to offer new Apple 13″ M1 MacBook Airs (8GB RAM, 256GB SSD) online for $699, $300 off original MSRP, in Space Gray, Silver, and Gold colors. These are new MacBook for sale by... Read more
B&H has 13-inch M2 MacBook Airs with 16GB...
B&H Photo has 13″ MacBook Airs with M2 CPUs, 16GB of memory, and 256GB of storage in stock and on sale for $1099, $100 off Apple’s MSRP for this configuration. Free 1-2 day delivery is available... Read more
14-inch M3 MacBook Pro with 16GB of RAM avail...
Apple has the 14″ M3 MacBook Pro with 16GB of RAM and 1TB of storage, Certified Refurbished, available for $300 off MSRP. Each MacBook Pro features a new outer case, shipping is free, and an Apple 1-... Read more

Jobs Board

*Apple* Systems Administrator - JAMF - Activ...
…**Public Trust/Other Required:** None **Job Family:** Systems Administration **Skills:** Apple Platforms,Computer Servers,Jamf Pro **Experience:** 3 + years of Read more
IT Systems Engineer ( *Apple* Platforms) - S...
IT Systems Engineer ( Apple Platforms) at SpaceX Hawthorne, CA SpaceX was founded under the belief that a future where humanity is out exploring the stars is Read more
Nurse Anesthetist - *Apple* Hill Surgery Ce...
Nurse Anesthetist - Apple Hill Surgery Center Location: WellSpan Medical Group, York, PA Schedule: Full Time Sign-On Bonus Eligible Remote/Hybrid Regular Apply Now Read more
Housekeeper, *Apple* Valley Village - Cassi...
Apple Valley Village Health Care Center, a senior care campus, is hiring a Part-Time Housekeeper to join our team! We will train you for this position! In this role, Read more
Sublease Associate Optometrist- *Apple* Val...
Sublease Associate Optometrist- Apple Valley, CA- Target Optical Date: Apr 20, 2024 Brand: Target Optical Location: Apple Valley, CA, US, 92307 **Requisition Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.