HELPINIT(3A) HELPINIT(3A)
NAME
HelpInit, PopupHelpAndWait - standard Atari Help
presentation for OSF/Motif
SYNOPSIS
int HelpInit (name)
char *name;
char *PopupHelpAndWait (w,msg)
Widget w;
int msg;
DESCRIPTION
HelpInit initializes the help routines. This should be
called after loading the first application shell and before
initializing the Atari alert routines. See AlertInit(3a)
for details. The name is used to prefix the help box title
in the title bar of the help box. It must be in space that
will remain available, even through subsequent FmCatGetS
calls. It will not be modified by the help routines.
HelpInit returns zero on success and -1 on failure. The
application should exit if -1 is returned.
PopupHelpAndWait presents a help window immediately near the
widget w. The left edges of the widget and the help window
are aligned. The msg indicates the message number of the
help text and title. They have the same message number in
different sets. The set number for help titles is
HELP_TITLE_SET and the set number for help text is
HELP_TEXT_SET. Both are defined in the file
<Atari/libgls.h>. See AtariLib(3A) for details.
If help is continued in another window, the message should
end in a form feed (\f) followed by the message number. The
title is not changed in subsequent help messages. Also, if
a message follows in this way, a Next button is added to the
window, and this button becomes the default button.
Otherwise, the Close button is the default button.
Page 1 (printed 9/3/91)
HELPINIT(3A) HELPINIT(3A)
Second and subsequent windows also have a Previous button to
go backwards to the previous screen. This button is never
the default button.
XFACEMAKER NOTES
AtariLibInit attaches the function PopupHelpAndWait so it
may be called from XFaceMaker scripts.
SEE ALSO
AlertInit(3A), AtariLib(3A), xfm(1A)
Page 2 (printed 9/3/91)