SaShortHelp(3tlib)

SaShortHelp: SaShortHelpCB, SaShortHelpMenuOptions, SaShortHelpSetState, SaShortHelpGetState, SaShortHelpLoad, SaShortHelpStore -- SCO Visual Tcl interface for graphical point (short) help

Synopsis

SaShortHelpCB cbs
SaShortHelpMenuOptions menu
SaShortHelpSetState state
SaShortHelpGetState
SaShortHelpLoad client
SaShortHelpStore client

Description

SaShortHelp provides a complete interface for graphical point help when used in conjunction with a status bar. Point help, also referred to as ``short help,'' presents the user with short, helpful descriptions of menu options, push buttons, input fields, lists and other widgets when appropriate. Point help may be disabled when the user no longer finds the text necessary or desirable.

SaShortHelp must be used with SaStatusBar.

SaShortHelpCB

standard point help callback. This may passed to any number of SCO Visual Tcl widget calls and library interfaces that require a point help callback. The application must also create a status bar on at least the main form using SaStatusBar(3tlib). The status bar is the graphical display area for point help text. When invoked, SaShortHelpCB can identify the current form dialog, locate the status bar and display/clear the point help text string.

SaShortHelpMenuOptions

attach standard point help menu options to specified pulldown menu widget. Currently, this is a single menu item, a toggle button for enabling/disabling point help:

   * Point Help

SaShortHelpSetState

enable/disable point help. While the application may change state explicitly, this is typically done by the user via the short help menu options. State changes made via the menu options are transparent to the application.

SaShortHelpGetState

determine the current state of point help.

SaShortHelpLoad

SaShortHelpStore

load/store user configurable point help state so that settings can persist across multiple invocations. These use the SaScreenPolicy interface.

SaShortHelpLoad must be performed before the call to SaShortHelpMenuOptions so that the menu option toggle button is properly in sync with the actual point help state.

SaShortHelpStore is typically used in the application's exit function after the user's last opportunity to change state.

Arguments

menu: application menu where point help options will appear.
state: boolean for enabled (1) or disabled (0).
client: string that uniquely identifies application used for storing/loading refresh parameters in a common file. Must conform to the rules for Stanza section names.
cbs: SCO Visual Tcl callback structure. When used as a callback for a widget, the cbs will be automatically generated and passed by SCO Visual Tcl.

Diagnostics

The Load and Store procedures may throw errors from the underlying SaScreenPolicy interfaces and should be handled with ErrorCatch.

References

SaStatusBar(3tlib), SaScreenPolicy(3tlib).