NAME

SYNOPSIS

Include File:

#include <Xmt/HelpBox.h>

Constructor:

XmtCreateHelpBox(), XmtCreateHelpDialog()

Class Name:

XmtHelpBox

Class Pointer:

xmtHelpBoxWidgetClass

Class Hierarchy:

Core → XmManager → XmBulletinBoard → XmtLayout → XmtHelpBox

DESCRIPTION

RESOURCES

The HelpBox widget inherits the resources of the XmtLayout class, and defines the following new resources:

XmtNhelpBackground

The background color of the help text display area.

XmtNhelpFontList

The XmFontList used to display the help text. If multi-font text is to be used, then this font list should contain each of the fonts. Note that this resource may not be queried.

XmtNhelpForeground

The foreground color of the help text.

XmtNhelpPixmap

A pixmap to be displayed in the upper left corner of the widget.

XmtNhelpText

The string to display in the help region of the widget. This string will be converted to an XmString by XmtCreateXmString(), and so can use any of the font changing escape codes supported by that function. Note that this resource may not be queried.

XmtNhelpTitle

A string to display as the title of the displayed text. It will be converted to an XmString by XmtCreateXmString(), and displayed using the XmFontList speci fied by the XmtNtitleFontList resource. Note that this resource may not be queried.

XmtNtitleFontList

The XmFontList used to display the help title. This resource is simply a synonym for the XmtNfontList resource of the XmtLayout superclass.

XmtNtitleForeground

The color that the title should be drawn in.

XmtNvisibleLines

The number of lines of help text that should appear in the widget at one time. Any lines of text beyond this number will be available via a scrollbar.

TRANSLATIONS

The HelpBox widget does not define any translations of its own, because it never takes the keyboard focus itself. It does, however install accelerators for its XmScrolledWindow child onto its XmPushButton child. Because the push button is the only child of the HelpBox that takes the keyboard focus, these accelerators allow the user to scroll the displayed text up and down from the keyboard. Note that these accelerators bind the default Motif scrolling keys, but also allow paging up and down using the standard bindings for the more pager and the emacs text editor.

SEE ALSO