Help Object Library: 2.3 Adding Help to Your Application: Bringing Up Help on the Fly

| Up: GEOS SDK TechDocs | Up | Prev: 2.2 Adding Default Normal Help | Next: 3 Customizing Help 
 HelpSendHelpNotification()

The Help Controller library provides a routine to bring up a help context, or to switch to a help context, at any time. This routine, HelpSendHelpNotification() , generates the proper notification event using the values you pass, then sends that notification to the help control object you've selected. This routine is detailed in the routines reference manual.

This routine becomes most useful when, for example, you want help on visible objects in a GenView or in a document. To call up a help viewer with a specific help file and context, you would have the visible object intercept both your special "help key" (e.g. the user clicks the middle mouse button) and MSG_META_BRING_UP_HELP , then call HelpSendHelpNotification() . In the handler for the input event, the object should not call the superclass. One example of this could be a special diagram of a floorplan, with each room a visible object; each "room" would bring up a different help context describing the characteristics of the room.

| Up: GEOS SDK TechDocs | Up | Prev: 2.2 Adding Default Normal Help | Next: 3 Customizing Help