Mac OS 9
Data Structures | Macros | Typedefs | Enumerations | Functions
Balloons.h File Reference
System

Balloon Help Package Interfaces. More...

#include <MacTypes.h>
#include <Quickdraw.h>
#include <Menus.h>
#include <TextEdit.h>
#include <MacErrors.h>

Go to the source code of this file.

Data Structures

struct  HMStringResType
 
struct  HMMessageRecord
 

Macros

#define NewTipFunctionUPP(userRoutine)
 
#define DisposeTipFunctionUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeTipFunctionUPP(tip, structure, r, balloonVariant, userUPP)
 
#define NewTipFunctionProc(userRoutine)   NewTipFunctionUPP(userRoutine)
 
#define CallTipFunctionProc(userRoutine, tip, structure, r, balloonVariant)    InvokeTipFunctionUPP(tip, structure, r, balloonVariant, userRoutine)
 
#define HMGetHelpMenuRef   HMGetHelpMenuHandle
 

Typedefs

typedef SInt16 BalloonVariant
 
typedef struct HMStringResType HMStringResType
 
typedef struct HMMessageRecord HMMessageRecord
 
typedef HMMessageRecord * HMMessageRecPtr
 
typedef RgnHandle structure
 
typedef RgnHandle Rect * r
 
typedef RgnHandle Rect BalloonVariant * balloonVariant
 

Enumerations

enum  {
  kTopLeftTipPointsLeftVariant = 0 , kTopLeftTipPointsUpVariant = 1 , kTopRightTipPointsUpVariant = 2 , kTopRightTipPointsRightVariant = 3 ,
  kBottomRightTipPointsRightVariant = 4 , kBottomRightTipPointsDownVariant = 5 , kBottomLeftTipPointsDownVariant = 6 , kBottomLeftTipPointsLeftVariant = 7 ,
  kBalloonVariantCount = 8
}
 
enum  { hmBalloonHelpVersion = 0x0002 }
 
enum  { kHMHelpMenuID = -16490 , kHMAboutHelpItem = 1 , kHMShowBalloonsItem = 3 }
 
enum  { kHMHelpID , kBalloonWDEFID }
 
enum  { helpItem }
 
enum  {
  hmDefaultOptions = 0 , hmUseSubIDBit = 0 , hmAbsoluteCoordsBit = 1 , hmSaveBitsNoWindowBit = 2 ,
  hmSaveBitsWindowBit = 3 , hmMatchInTitleBit = 4 , hmUseSubIDMask , hmAbsoluteCoordsMask ,
  hmSaveBitsNoWindowMask , hmSaveBitsWindowMask , hmMatchInTitleMask
}
 
enum  {
  kHMStringItem = 1 , kHMPictItem = 2 , kHMStringResItem = 3 , kHMTEResItem ,
  kHMSTRResItem = 7 , kHMSkipItem = 256 , kHMCompareItem = 512 , kHMNamedResourceItem = 1024 ,
  kHMTrackCntlItem = 2048
}
 
enum  {
  khmmString = 1 , khmmPict = 2 , khmmStringRes , khmmTEHandle = 4 ,
  khmmPictHandle = 5 , khmmTERes , khmmSTRRes = 7 , kHMEnabledItem = 0
}
 
enum  { kHMTETextResType , kHMTEStyleResType }
 
enum  {
  kHMDisabledItem , kHMCheckedItem = 2 , kHMOtherItem = 3 , kHMRegularWindow = 0 ,
  kHMSaveBitsNoWindow = 1 , kHMSaveBitsWindow
}
 
enum  {
  kHMMenuResType , kHMDialogResType , kHMWindListResType , kHMRectListResType ,
  kHMOverrideResType , kHMFinderApplResType
}
 
enum  { uppTipFunctionProcInfo = 0x00003FE0 }
 

Functions

typedef CALLBACK_API (OSErr, TipFunctionProcPtr)(Point tip
 
typedef STACK_UPP_TYPE (TipFunctionProcPtr) TipFunctionUPP
 
TipFunctionUPP NewTipFunctionUPP (TipFunctionProcPtr userRoutine)
 
void DisposeTipFunctionUPP (TipFunctionUPP userUPP)
 
OSErr InvokeTipFunctionUPP (Point tip, RgnHandle structure, Rect *r, BalloonVariant *balloonVariant, TipFunctionUPP userUPP)
 
OSErr HMGetHelpMenuHandle (MenuRef *mh)
 
OSErr HMShowBalloon (const HMMessageRecord *inHelpMessage, Point inTip, Rect *inHotRect, TipFunctionUPP inTipProc, SInt16 inWindowProcID, BalloonVariant inBalloonVariant, SInt16 inMethod)
 
OSErr HMShowMenuBalloon (SInt16 itemNum, SInt16 itemMenuID, SInt32 itemFlags, SInt32 itemReserved, Point tip, Rect *alternateRect, TipFunctionUPP tipProc, SInt16 theProc, BalloonVariant balloonVariant)
 
OSErr HMRemoveBalloon (void)
 
OSErr HMGetIndHelpMsg (ResType inWhichResType, SInt16 inWhichResID, SInt16 inMessageIndex, SInt16 inMessageState, UInt32 *outOptions, Point *outTip, Rect *outHotRect, SInt16 *outWindowProcID, BalloonVariant *outBalloonVariant, HMMessageRecord *outHelpMessage, SInt16 *outMessageCount)
 
Boolean HMIsBalloon (void)
 
Boolean HMGetBalloons (void)
 Is Balloon Help on or off? More...
 
OSErr HMSetBalloons (Boolean flag)
 
OSErr HMSetFont (SInt16 font)
 
OSErr HMSetFontSize (UInt16 fontSize)
 
OSErr HMGetFont (SInt16 *font)
 
OSErr HMGetFontSize (UInt16 *fontSize)
 
OSErr HMSetDialogResID (SInt16 resID)
 
OSErr HMSetMenuResID (SInt16 menuID, SInt16 resID)
 
OSErr HMBalloonRect (const HMMessageRecord *inMessage, Rect *outRect)
 
OSErr HMBalloonPict (const HMMessageRecord *inMessage, PicHandle *outPict)
 
OSErr HMScanTemplateItems (SInt16 whichID, SInt16 whichResFile, ResType whichType)
 
OSErr HMExtractHelpMsg (ResType inType, SInt16 inResID, SInt16 inMessageIndex, SInt16 inMessageState, HMMessageRecord *outMessage)
 
OSErr HMGetDialogResID (SInt16 *resID)
 
OSErr HMGetMenuResID (SInt16 menuID, SInt16 *resID)
 
OSErr HMGetBalloonWindow (WindowRef *window)
 

Detailed Description

Balloon Help Package Interfaces.

Introduced In: System 7.0
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1990-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ InvokeTipFunctionUPP

#define InvokeTipFunctionUPP (   tip,
  structure,
  r,
  balloonVariant,
  userUPP 
)
Value:
(OSErr) CALL_FOUR_PARAMETER_UPP((userUPP), uppTipFunctionProcInfo, (tip), \
(structure), (r), (balloonVariant))
r
FrameRect & r
Lock a handle's data area (keep it from moving)
Definition: MacMemory.h:927
MacRegion
Definition: Quickdraw.h:306

◆ NewTipFunctionUPP

#define NewTipFunctionUPP (   userRoutine)
Value:
(TipFunctionUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppTipFunctionProcInfo, \
GetCurrentArchitecture())
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

Typedef Documentation

◆ BalloonVariant

typedef SInt16 BalloonVariant

Carbon clients should use MacHelp. The definitions below will NOT work for Carbon and are only defined for those files that need to build pre-Carbon applications.

Function Documentation

◆ DisposeTipFunctionUPP()

void DisposeTipFunctionUPP ( TipFunctionUPP  userUPP)

DisposeTipFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ HMBalloonPict()

OSErr HMBalloonPict ( const HMMessageRecord *  inMessage,
PicHandle *  outPict 
)

HMBalloonPict()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMBalloonRect()

OSErr HMBalloonRect ( const HMMessageRecord *  inMessage,
Rect *  outRect 
)

HMBalloonRect()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMExtractHelpMsg()

OSErr HMExtractHelpMsg ( ResType  inType,
SInt16  inResID,
SInt16  inMessageIndex,
SInt16  inMessageState,
HMMessageRecord *  outMessage 
)

HMExtractHelpMsg()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetBalloons()

Boolean HMGetBalloons ( void  )

Is Balloon Help on or off? 

Returns: The HMGetBalloons function returns TRUE if help is currently
enabled and FALSE if help is currently not enabled. Because this
function does not load the Help Manager package into memory, it is
a very fast way to determine whether help is enabled.
Note
If you only want to provide help balloons for the menus, alert boxes, and
dialog boxes of your application, you only need to create the resources
containing the descriptive information. Using the Help Manager and its
subsections give details on how to create these resources.
If help is not enabled, most Help Manager routines do nothing and return
the hmHelpDisabled result code.
The user turns Balloon Help assistance on by choosing Show Balloons
from the Help menu. You can use the HMGetBalloons function to
determine whether help is currently enabled. If you display your own help
balloons using the HMShowBalloon function, you should use the
HMGetBalloons function to determine whether help is enabled before
displaying a help balloon. If help is not enabled, you cannot display any help
balloons.
Copyright: THINK Reference © 1991-1992 Symantec Corporation
Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetBalloonWindow()

OSErr HMGetBalloonWindow ( WindowRef *  window)

HMGetBalloonWindow()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetDialogResID()

OSErr HMGetDialogResID ( SInt16 *  resID)

HMGetDialogResID()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetFont()

OSErr HMGetFont ( SInt16 *  font)

HMGetFont()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetFontSize()

OSErr HMGetFontSize ( UInt16 *  fontSize)

HMGetFontSize()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetHelpMenuHandle()

OSErr HMGetHelpMenuHandle ( MenuRef *  mh)

HMGetHelpMenuHandle()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetIndHelpMsg()

OSErr HMGetIndHelpMsg ( ResType  inWhichResType,
SInt16  inWhichResID,
SInt16  inMessageIndex,
SInt16  inMessageState,
UInt32 *  outOptions,
Point *  outTip,
Rect *  outHotRect,
SInt16 *  outWindowProcID,
BalloonVariant *  outBalloonVariant,
HMMessageRecord *  outHelpMessage,
SInt16 *  outMessageCount 
)

HMGetIndHelpMsg()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMGetMenuResID()

OSErr HMGetMenuResID ( SInt16  menuID,
SInt16 *  resID 
)

HMGetMenuResID()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMIsBalloon()

Boolean HMIsBalloon ( void  )

HMIsBalloon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMRemoveBalloon()

OSErr HMRemoveBalloon ( void  )

HMRemoveBalloon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMScanTemplateItems()

OSErr HMScanTemplateItems ( SInt16  whichID,
SInt16  whichResFile,
ResType  whichType 
)

HMScanTemplateItems()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMSetBalloons()

OSErr HMSetBalloons ( Boolean  flag)

HMSetBalloons()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMSetDialogResID()

OSErr HMSetDialogResID ( SInt16  resID)

HMSetDialogResID()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMSetFont()

OSErr HMSetFont ( SInt16  font)

HMSetFont()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMSetFontSize()

OSErr HMSetFontSize ( UInt16  fontSize)

HMSetFontSize()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMSetMenuResID()

OSErr HMSetMenuResID ( SInt16  menuID,
SInt16  resID 
)

HMSetMenuResID()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMShowBalloon()

OSErr HMShowBalloon ( const HMMessageRecord *  inHelpMessage,
Point  inTip,
Rect *  inHotRect,
TipFunctionUPP  inTipProc,
SInt16  inWindowProcID,
BalloonVariant  inBalloonVariant,
SInt16  inMethod 
)

HMShowBalloon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ HMShowMenuBalloon()

OSErr HMShowMenuBalloon ( SInt16  itemNum,
SInt16  itemMenuID,
SInt32  itemFlags,
SInt32  itemReserved,
Point  tip,
Rect *  alternateRect,
TipFunctionUPP  tipProc,
SInt16  theProc,
BalloonVariant  balloonVariant 
)

HMShowMenuBalloon()

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ InvokeTipFunctionUPP()

OSErr InvokeTipFunctionUPP ( Point  tip,
RgnHandle  structure,
Rect *  r,
BalloonVariant *  balloonVariant,
TipFunctionUPP  userUPP 
)

InvokeTipFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewTipFunctionUPP()

TipFunctionUPP NewTipFunctionUPP ( TipFunctionProcPtr  userRoutine)

NewTipFunctionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available