hyperhelp - Create and manipulate a hyperhelp widget

INHERITANCE

STANDARD OPTIONS

activeBackground cursor highlightThickness insertOnTime relief selectBorderWidth

background exportSelection insertBackground insertWidth repeatDelay selectForeground

borderWidth foreground insertBorderWidth padX repeatInterval setGrid

closecmd highlightColor insertOffTime padY selectBackground

See the "options" manual entry for details on the standard options.

ASSOCIATED OPTIONS

hscrollmode fontsize width unknownimage

vscrollmode fixedfont height

textbackground link state

fontname linkhighlight wrap

See the "scrolledhtml" widget manual entry for details on the above associated options.

INHERITED OPTIONS

modality

title

See the "shell" manual entry for details on the above inherited options.

WIDGET-SPECIFIC OPTIONS

Name:                   topics
Class:                  Topics
Command-Line Switch:    -topics

Specifies a list of help topics in the form {?topic? ... }. Topic may either be a topic name, in which case the document associated with the topic should be in the file helpdir/topic.html, or it may be of the form {name file}. In the latter case, name is displayed in the topic menu, and selecting the name loads file. If file has a relative path, it is assumed to be relative to helpdir.

Name:                   helpdir
Class:                  Directory
Command-Line Switch:    -helpdir

Specifies the directory where help files are located.

Name:                   closeCmd
Class:                  CloseCmd
Command-Line Switch:    -closecmd

Specifies the tcl command to be executed when the close option is selected from the topics menu.

Name:                   maxHistory
Class:                  MaxHistory
Command-Line Switch:    -maxhistory

Specifies the maximum number of entries stored in the history list

Name:                   beforelink
Class:                  BeforeLink
Command-Line Switch:    -beforelink

Specifies a command to be eval'ed before a new link is displayed. The path of the link to be displayed is appended before evaling the command. A suggested use might be to busy the widget while a new page is being displayed.

Name:                   afterlink
Class:                  AfterLink
Command-Line Switch:    -afterlink

Specifies a command to be eval'ed after a new link is completely displayed. The path of the link that was displayed is appended before evaling the command.

DESCRIPTION

The hyperhelp command creates a shell window with a pulldown menu showing a list of topics. The topics are displayed by importing a HTML formatted file named helpdir/topic.html. For a list of supported HTML tags, see scrolledhtml(n).

METHODS

The hyperhelp command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?

INHERITED METHODS

activate

center

childsite

deactivate

See the "shell" manual entry for details on the above inherited methods.

WIDGET-SPECIFIC METHODS