NAME

DXmCreateHelpDialog − Creates the Help widget with a dialog box. 

SYNOPSIS

Widget DXmCreateHelpDialog (parent, name, arglist, argcount)
        Widget   parent;
        char     *name;
        Arglist  arglist;
        int      argcount;

PARAMETERS

The identifier (widget ID) of the parent widget.  The name of the created widget.  The application argument list.  An integer that represents the number of arguments in the application argument list. 

DESCRIPTION

The DXmCreateHelpDialog routine creates a help widget that includes its own dialog box.  The help widget is a modeless widget that enables the application to display appropriate user assistance information in response to a user request.  When the user requests help, the help widget displays an initial help topic, then gives the user the ability to view additional help topics. 

The DXmNfirstTopic resource allows the application to provide context-sensitive help by selecting a specific topic based on implicit or explicit cues from the user. 

After the widget has been created, you can change the help topic by specifying a new DXmNfirstTopic (using the Intrinsic routine XtSetValues), and then managing the widget (using the Intrinsic routine XtManageChild) to display the help window. 

When the user exits from a help session, the widget is automatically unmanaged. 

Resource Information

The help widget does not support children. 

You can set the following widget-specific resources in the arglist:

XmString       DXmNaddtopicLabel; XmString       DXmNapplicationName; XmString       DXmNbadFrameMessage; XmString       DXmNbadlibMessage; Boolean        DXmNcacheHelpLibrary; XmString       DXmNcloseLabel; int            DXmNcols; XmString       DXmNcopyLabel; KeySym         DXmNcopyLabelMnem; XmString       DXmNcopyLabelMnemCS; Boolean        DXmNdefaultPosition; XmString       DXmNdismissLabel; XmString       DXmNeditLabel; KeySym         DXmNeditLabelMnem; XmString       DXmNeditLabelMnemCS; XmString       DXmNerroropenMessage; XmString       DXmNexitLabel; KeySym         DXmNexitLabelMnem; XmString       DXmNexitLabelMnemCS; XmString       DXmNfileLabel; KeySym         DXmNfileLabelMnem; XmString       DXmNfileLabelMnemCS; XmString       DXmNfirstTopic; XmString       DXmNglossaryTopic; XmString       DXmNgobackLabel; KeySym         DXmNgobackLabelMnem; XmString       DXmNgobackLabelMnemCS; XmString       DXmNgobacktopicLabel; XmString       DXmNgooverLabel; KeySym         DXmNgooverLabelMnem; XmString       DXmNgooverLabelMnemCS; XmString       DXmNgotoLabel; XmString       DXmNgototopicLabel; KeySym         DXmNgototopicLabelMnem; XmString       DXmNgototopicLabelMnemCS; XmString       DXmNhelpAcknowledgeLabel; XmString       DXmNhelphelpLabel; KeySym         DXmNhelphelpLabelMnem; XmString       DXmNhelphelpLabelMnemCS; XmString       DXmNhelpLabel; KeySym         DXmNhelpLabelMnem; XmString       DXmNhelpLabelMnemCS; XmString       DXmNhelpOnHelpTitle; XmString       DXmNhelpontitleLabel; XmString       DXmNhelptitleLabel; XmString       DXmNhistoryboxLabel; XmString       DXmNhistoryLabel; KeySym         DXmNhistoryLabelMnem; XmString       DXmNhistoryLabelMnemCS; XmString       DXmNkeywordLabel; KeySym         DXmNkeywordLabelMnem; XmString       DXmNkeywordLabelMnemCS; XmString       DXmNkeywordsLabel; XmString       DXmNlibrarySpec; unsigned int   DXmNlibraryType; XmString       DXmNnokeywordMessage; XmString       DXmNnotitleMessage; XmString       DXmNnulllibMessage; XmString       DXmNoverviewTopic; int            DXmNrows; XmString       DXmNsaveasLabel; KeySym         DXmNsaveasLabelMnem; XmString       DXmNsaveasLabelMnemCS; XmString       DXmNsearchapplyLabel; XmString       DXmNsearchkeywordboxLabel; XmString       DXmNsearchLabel; KeySym         DXmNsearchLabelMnem; XmString       DXmNsearchLabelMnemCS; XmString       DXmNsearchtitleboxLabel; XmString       DXmNselectallLabel; KeySym         DXmNselectallLabelMnem; XmString       DXmNselectallLabelMnemCS; XmString       DXmNtitleLabel; KeySym         DXmNtitleLabelMnem; XmString       DXmNtitleLabelMnemCS; XmString       DXmNtitlesLabel; XmString       DXmNtopictitlesLabel; XmString       DXmNviewLabel; KeySym         DXmNviewLabelMnem; XmString       DXmNviewLabelMnemCS; XmString       DXmNvisitglosLabel; KeySym         DXmNvisitglosLabelMnem; XmString       DXmNvisitglosLabelMnemCS; XmString       DXmNvisitLabel; XmString       DXmNvisittopicLabel; KeySym         DXmNvisittopicLabelMnem; XmString       DXmNvisittopicLabelMnemCS; XtCallbackList XmNmapCallback; XtCallbackList XmNunmapCallback;

Resources

The label indicating additional topics for help.  The default is "Additional topics".  Access is CSG.  The application name to be used in the widget title bar.  The default is Null.  Access is CSG.  The message displayed when a frame could not be found.  The default is "Couldn’t find frame !CS".  Access is CSG.  The message displayed when a requested library could not be found.  The default is "Couldn’t open library !CS".  Access is CSG.  A Boolean resource that specifies whether the text of the help library is stored in the help widget’s cache memory.  When True, the text is stored in cache memory; when False, the text is not stored in cache memory.  The default is False.  Access is CSG.  The label for the Exit push button in the help widget window.  The default is "Exit".  Access is CSG.  The width, in characters, of the help text window.  The default is language dependent; the American English default is 55.  Access is CSG.  The label for the Copy menu item in the Edit menu.  The default is "Copy".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Copy menu item in the Edit menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Copy menu label.  The default is an underscore (_) inserted beneath the letter "C", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Copy menu label that corresponds to the key the user can press (as defined by the DXmNcopyLabelMnem resource) to activate the Copy menu item.  The default character set is ISO8859-1.  Access is CG.  A Boolean resource that, when True, causes the core resources x and y to be ignored in favor of the default widget position.  The default widget position is centered in the parent window.  When False, the specified x and y resources are used to position the widget.  The default is True.  Access is CSG.  The label for the push button used to dismiss a help widget dialog box (for example, Search History, Search Title, Search Keyword boxes).  The default is "Dismiss".  Access is CSG.  The label for the Edit pull-down menu.  The default is "Edit".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Edit pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Edit pull-down menu label.  The default is an underscore (_) inserted beneath the letter "E", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Edit pull-down menu label that corresponds to the key the user can press (as defined by the DXmNeditLabelMnem resource) to activate the Edit pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The error message displayed when a file cannot be opened.  The default is "Error opening file !CS".  Access is CSG.  The label for the exit menu item in the File pull-down menu.  The default is "Exit".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Exit menu item in the File pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Exit menu label.  The default is an underscore (_) inserted beneath the letter "E", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Exit menu label that corresponds to the key the user can press (as defined by the DXmNexitLabelMnem resource) to activate the Exit menu item in the File pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the File pull-down menu.  The default is "File".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the File pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the File pull-down menu label.  The default is an underscore (_) inserted beneath the letter "F", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the File pull-down menu label that corresponds to the key the user can press (as defined by the DXmNfileLabelMnem resource) to activate the File pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The first help topic to be displayed.  If a null string is passed, a list of level one topics is displayed.  The default is Null.  Access is CSG.  The application glossary topic.  If a null string is provided, the Visit Glossary menu item does not appear in the View pull-down menu.  The default is Null.  Access is CSG.  The label for the Go Back menu item in the View pull-down menu.  The default is "Go Back".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Go Back menu item in the View pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Go Back menu label.  The default is an underscore (_) inserted beneath the letter "B", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Go Back menu label that corresponds to the key the user can press (as defined by the DXmNgobackLabelMnem resource) to activate the Go Back menu item in the View pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Go Back push button in the help widget window.  The default is "Go Back".  Access is CSG.  The label for the Go To Overview item in the View pull-down menu.  The default is "Go To Overview".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Go To Overview item in the View pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Go To Overview menu label.  The default is an underscore (_) inserted beneath the letter "O", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Go To Overview menu label that corresponds to the key the user can press (as defined by the DXmNgooverLabelMnem resource) to activate the Go To Overview item in the View pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Go To push button in the help widget’s dialog boxes.  The default is "Go To".  Access is CSG.  The label for the Go To Topic menu item in the View pull-down menu.  The default is "Go To Topic".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Go To Topic menu item in the View pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Go To Topic menu label.  The default is an underscore (_) inserted beneath the letter "T", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Go To Topic menu label that corresponds to the key the user can press (as defined by the DXmNgototopicLabelMnem resource) to activate the Go To Topic menu item in the View pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Acknowledge push button in the error message box.  The default is "OK".  Access is CSG.  The label for the Overview menu item in the Using Help pull-down menu.  The default is "On Window...".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Overview menu item in the Using Help pull-down menu. This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Overview menu label.  The default is an underscore (_) inserted beneath the letter "W", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Overview menu label that corresponds to the key the user can press (as defined by the DXmNhelphelpLabelMnem resource) to activate the Overview menu item in the Using Help pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Help pull-down menu.  The default is "Using Help".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Help pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Help pull-down menu label.  The default is an underscore (_) inserted beneath the letter "U", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Help pull-down menu label that corresponds to the key the user can press (as defined by the DXmNhelpLabelMnem resource) to activate the Help pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the title bar in the Help-on-Help help subwidget.  The default is "Using Help".  Access is CSG.  The label for the help widget title bar used in conjunction with the application name.  The default is "Help On".  Access is CSG.  The label for the help widget title bar when no application name is specified.  The default is "Help".  Access is CSG.  The label for the history dialog box.  The default is "Search Topic History".  Access is CSG.  The label for the History... menu item in the Search pull-down menu.  The default is "History...".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the History... menu item in the Search pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the History... menu label.  The default is an underscore (_) inserted beneath the letter "H", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the History... menu label that corresponds to the key the user can press (as defined by the DXmNhistoryLabelMnem resource) to activate the History... menu item in the Search pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Keyword... menu item in the Search pull-down menu.  The default is "Keyword...".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Keyword... menu item in the Search pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Keyword... menu label.  The default is an underscore (_) inserted beneath the letter "K", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Keyword... menu label that corresponds to the key the user can press (as defined by the DXmNkeywordLabelMnem resource) to activate the Keyword... menu item in the Search pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label used in a Search Topic Keyword box to identify the text entry field.  The default is "Keyword".  Access is CSG.  A host system file specification that identifies the help topic library.  The default is Null.  Access is CG.  The type of help topic library specified by the DXmNlibrarySpec resource.  The predefined value for this resource is DXmTextLibrary, which is a type of UNIX help directory.  Access is CG.  The message displayed when a requested keyword cannot be found.  The default is "Couldn’t find keyword !CS".  Access is CSG.  The message displayed when a requested title cannot be found.  The default is "No title to match string !CS".  Access is CSG.  The text for the message displayed when no library has been specified.  The default is "No library specified".  Access is CSG.  The application overview topic. The default is Null.  Access is CSG.  Height, in characters, of the help text window.  The default is language dependent; the American English default is 20.  Access is CSG.  The label for the Save As... item in a File pull-down menu.  The default is "Save As...".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Save As... item in a File pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Save As... menu label.  The default is an underscore (_) inserted beneath the letter "A", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Save As... menu label that corresponds to the key the user can press (as defined by the DXmNsaveasLabelMnem resource) to activate the Save As... item in a File pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the push button used to initiate a search action in a Search dialog box.  The default is "Apply".  Access is CSG.  The label for a Search Topic Keywords dialog box.  The default is "Search Topic Keywords".  Access is CSG.  The label for the Search pull-down menu.  The default is "Search".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Search pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Search pull-down menu label.  The default is an underscore (_) inserted beneath the letter "S", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Search pull-down menu label that corresponds to the key the user can press (as defined by the DXmNsearchLabelMnem resource) to activate the Search pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The title of a Search Topic Titles box.  The default is "Search Topic Titles".  Access is CSG.  The label for the Select All item on the Edit pull-down menu.  The default is "Select All".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Select All item on the Edit pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Select All menu label.  The default is an underscore (_) inserted beneath the letter "S", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Select All menu label that corresponds to the key the user can press (as defined by the DXmNselectLabelMnem resource) to activate the Select All item on the Edit pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Title... item in the Search pull-down menu.  The default is "Title...".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Title... item in the Search pull-down menu. This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Title... menu label.  The default is an underscore (_) inserted beneath the letter "T", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Title... menu label that corresponds to the key the user can press (as defined by the DXmNtitleLabelMnem resource) to activate the Title... item in the Search pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label identifying the text entry field on the Search Topic Titles box.  The default is "Title".  Access is CSG.  The label used to identify topics found as a result of a title search in a Search Topic Titles box.  The default is "Topic Titles".  Access is CSG.  The label for the View menu.  The default is "View".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the View menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the View menu label.  The default is an underscore (_) inserted beneath the letter "V", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the View menu label that corresponds to the key the user can press (as defined by the DXmNviewLabelMnem resource) to activate the View menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Visit Glossary item in the View pull-down menu. The default is "Visit Glossary".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Visit Glossary item in the View pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Visit Glossary menu label.  The default is an underscore (_) inserted beneath the letter "G", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Visit Glossary menu label that corresponds to the key the user can press (as defined by the DXmNvisitglosLabelMnem resource) to activate the Visit Glossary item in the View pull-down menu.  The default character set is ISO8859-1.  Access is CG.  The label for the Visit push button in the help widget’s dialog boxes.  The default is "Visit".  Access is CSG.  The label for the Visit Topic menu item in the View pull-down menu. The default is "Visit Topic".  Access is CSG.  Specifies which key the user can press (instead of clicking MB1) to activate the Visit Topic menu item in the View pull-down menu.  This resource defines the key on the keyboard and visually identifies that key for the user by inserting an underscore (_) beneath the designated letter in the Visit Topic menu label.  The default is an underscore (_) inserted beneath the letter "V", with the corresponding key defined on the keyboard.  Access is CG.  Establishes the character set used when identifying the letter in the Visit Topic menu label that corresponds to the key the user can press (as defined by the DXmNvisittopicLabelMnem resource) to activate the Visit Topic menu item in the View pull-down menu.  The default character set is ISO8859-1.  Access is CSG.  Callback (or callbacks) made when the help widget is mapped.  The callback reason is XmCR_MAP.  The default is Null.  Access is C.  Callback (or callbacks) made when the help widget is unmapped. The callback reason is XmCR_UNMAP.  The default is Null.  Access is C. 

Resource Information

The resources XmNwidth and XmNheight are supported differently by DXmCreateHelpDialog in that they cannot be set by the caller.  These values are calculated by the widget, based on the size of the text window (XmNcols and XmNrows). 

Resource Information

typedef struct {
      int     reason;
      XEvent  *event; } XmAnyCallbackStruct;

Callback Field Descriptions

An integer set to the callback reason.  See the Callback Reasons section for the values that are valid for this widget.  A pointer to the X event structure describing the event that generated this callback. 

Callback Reasons

The help window was just mapped.  The help window was just unmapped. 

Resource Information

The help widget does not support children. 

Resizing

The help widget sizes itself at creation, based on XmNrows and XmNcols. 

Resizing

Inherited Resources

DXmCreateHelpDialog inherits behaviour and resources from the following superclasses:

Core Resource Set Composite Resource Set Constraint Resource Set XmManager Resource Set DXmHelpDialog Resource Set

RETURN VALUES

The identifier (widget ID) of the created Help widget.