DESIGN (xvutils) functions
LIBRARY ROUTINE
xvu_help_wait - display help file or help directory
LIBRARY CALL
int xvu_help_wait(
char *path,
char *label)
INPUT
- path - the path of the (single) file to be displayed,
or the directory containing the (multiple) files
to be displayed in the help object.
The path may include a '~' if desired, or may contain
a reference to $TOOLBOX.
- label - short label for top of help object;
NULL gives default of "Help".
OUTPUT
none
RETURN VALUE
TRUE on success, FALSE on failure
DESCRIPTION
Create a large read-only text object in which one or
more ascii files may be displayed.
If the path specified is to a single file, that
file is displayed. If the path specified is a directory,
the text object will have one button at the top labeled
with the name of each file in the directory. Clicking
on such a button will cause the contents of the file labeled
to appear in the text object. In either case, the on-line
help object will be displayed until the user clicks on the
"Quit" button. This utility will not grab events from the
application program.
ADDITIONAL INFORMATION
none
EXAMPLES
none
SIDE EFFECTS
none
RESTRICTIONS
none
MODIFICATION
Converted from Khoros 1.0 (DA)
FILES
$DESIGN/objects/library/xvutils/src/help.c
SEE ALSO
xvutils(3)
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.