HMRemoveBalloon

Remove any balloon that is currently visible

#include <Balloons.h> Help Manager

The HMRemoveBalloon function removes any balloon that is

currently visible-unless the user is using Close View and is pressing

the Shift key. This action keeps the help balloon on screen even while

the user moves away from the hot rectangle under Close View. The

HMRemoveBalloon function returns a result code of

hmCloseViewActive in this case.

Returns: an Error Code.

noErr (0) No error or the help balloon was removed

hmHelpDisabled (-850) Help balloons are not enabled

hmNoBalloonUp (-862) No balloon showing

hmCloseViewActive (-863) User using Close View will not let you remove

balloon

Notes: The Help Manager automatically tracks the cursor and removes the help

balloon (when the user moves the cursor outside of the hot rectangle) for

balloons defined in 'hmnu', 'hdlg', and 'hrct' resources. Your application

does not need to remove help balloons created by these resources.

If you use the HMShowMenuBalloon function to display help balloons,

you can either let the Help Manager track the cursor and remove the help

balloon when the cursor moves out of the hot rectangle, or your application

can track the cursor and determine when to remove the balloon. To let the

Help Manager track the cursor and remove the help balloon when using

the HMShowMenuBalloon function, specify a rectangle in the

alternateRect parameter. If you want your application to track the cursor

and remove the help balloon when using the HMShowMenuBalloon

function, specify NIL in the alternateRect parameter. You must then use the

HMRemoveBalloon function to remove the balloon when the user moves

the cursor outside of the rectangle.

If you use the HMShowMenuBalloon function to display help balloons,

you must always track the cursor and use the HMRemoveBalloon function

to remove the help balloon when the cursor moves out of the hot rectangle.

Warning: The HMRemoveBalloon function removes any

help balloon that is currently visible, regardless of the

application that displayed it. You should only call

HMRemoveBalloon when the cursor is in the content area of

your application window but not in a hot rectangle, and you

should never call it when your application is in the

background.

If you use your own menu bar definition procedure, you should call

HMRemoveBalloon when your procedure receives the Save bits and

Restore bits messages before you save or restore any bits. (The Save

and Restore bits messages are described in the Menu Manager.)

Referenced by (9):