Common Desktop Environment: Help System Author's and Programmer's Guide
11 Handling Events in Help Dialogs
Contents of Chapter:
- Supporting Help Dialog Events
-
- Hyperlink Events
-
- When Dialogs Are Dismissed
-
- Quick Help Buttons
-
- Responding to Hyperlink Events
-
To Provide a Hyperlink Callback-
- Detecting When Help Dialogs Are Dismissed
-
- Using the Application-Configured Button
-
- To Enable the Application-Configured Button
-
This chapter describes several Help dialog events that an application must be equipped to handle.
Like other widgets within your application, help windows have some behavior that must be supported by the application.
Hyperlink Events
Most standard hyperlink events are handled internally by the Help System. However, there are four types of hyperlinks that your application is responsible for handling:
- Jump-new-view hyperlinks--Your application must create a new help dialog to honor the author's request for a topic to be displayed in a new help window.
- Man page links
--Your application must create a new quick help dialog (or get one from your cache) to display a man page. Typically, the size of man page windows is different from all other help windows.
- Application-defined links
--Your application must interpret the data associated with these links. Application-defined links exist only if you and the author have collaborated to create them.
- Text file links--Your application must create a quick help dialog (or get one from you cache) to display the text file.
When Dialogs Are Dismissed
When the user closes a help dialog, your application needs to know so it can store the dialog in its cache, or destroy it. The general help dialog supports a help closed callback. To detect when a quick dialog is dismissed, add a callback to its Close button.
Quick Help Buttons
The behavior for some of the buttons in quick help dialogs must be handled by your application. These buttons can be managed and unmanaged as needed. You add behavior just like any other push button: using an activate callback.
See Also
- "Creating Hyperlinks" describes the types of links supported by the Help System and explains how to create them.
Your application needs to provide support only for the types of hyperlinks used within the help volume to be displayed. In general, it is recommended that you provide support for all link types.
For your application to be notified when a hyperlink is chosen, it must add a hyperlink callback
to the help dialog. You must write a callback function that handles the hyperlink appropriately.
To Provide a Hyperlink Callback
- Add a hyperlink callback to each help dialog as shown:
XtAddCallback (helpDialog, DtNhyperlLinkCallback,
HyperlinkCB, (XtPointer)NULL);
Where helpDialog is the widget ID of the help dialog and HyperlinkCB is the name of the callback function for handling hyperlinks.
- Write the HyperlinkCB function to handle the hyperlink events that can occur within the dialog.
Within the hyperlink callback, you have access to the following callback structure (which is declared in <Dt/Help.h>):
typedef struct
{
int reason;
XEvent *event;
char *locationId;
char *helpVolume;
char *specification;
int hyperType;
int windowHint;
} DtHelpDialogCallbackStruct;
The hyperType
element indicates which type of link was executed. Its possible values are: DtHELP_LINK_TOPIC
,
DtHELP_LINK_MAN_PAGE
,
DtHELP_LINK_APP_DEFINE
, or DtHELP_LINK_TEXT_FILE
. For a description of which structure elements are valid for different types refer to the DtHelpDialog(3)
man page.
The windowHint element indicates a window type. Its possible values are: DtHELP_CURRENT_WINDOW, DtHELP_POPUP_WINDOW, or DtHELP_NEW_WINDOW.
Example
The following function, HyperlinkCB(), illustrates the general structure needed to handle hyperlink callbacks.
XtCallbackProc
HyperlinkCB (widget, clientData, callData)
Widget widget;
XtPointer clientData;
XtPointer callData;
{
DtHelpDialogCallbackStruct *hyperData =
(DtHelpDialogCallbackStruct *) callData;
switch ((int)hyperData-> hyperType)
{
case DtHELP_LINK_TOPIC:
/* Handles "jump new view"hyperlinks. */
break;
case DtHELP_LINK_MAN_PAGE:
/* Handles "man page" hyperlinks. */
break;
case DtHELP_LINK_APP_DEFINE:
/* Handles ``application-defined" hyperlinks. */
break;
case DtHELP_LINK_TEXT_FILE:
/* Handles ``text file" hyperlinks. */
break;
default:
break;
}
To detect when a general help dialog is closed, add the following callback to the dialog:
XtAddCallback (helpDialog, DtNcloseCallback,
HelpCloseCB, (XtPointer)NULL);
Where helpDialog is the widget ID for the help dialog and HelpCloseCB is the name of the callback procedure you've written to handle closing dialogs.
To detect when a quick help dialog is closed, add the following callback to the dialog's OK button:
XtAddCallback (DtHelpQuickDialogGetChild (helpDialog,
DtHELP_QUICK_OK_BUTTON), XmNactivateCallback, HelpCloseCB, (XtPointer)NULL);
Where helpDialog is the widget ID for the help dialog and HelpCloseCB is the name of the callback procedure you've written to handle closing dialogs.
The quick help dialog's application-configured button lets you add custom behavior to any quick help dialog. This button can be used for anything you want, but its intended purpose is to provide a path to more help in one of these two ways:
- Lets the user progressively ask for more information. This is sometimes called progressive disclosure. In this case, the default button label (More) is appropriate.
- Lets the user open a general help dialog for general browsing of the application's help volume. In this case, Browse... is the most appropriate button label.
- Get the button's ID.
- Add an activate callback to the button.
- Manage the button.
Example
The following code segment gets the button's ID, assigns a callback, and manages the button. It assumes that quickHelpDialog was just created.
Widget moreButton;
moreButton = DtHelpQuickDialogGetChild (quickHelpDialog,
DtHELP_QUICK_MORE_BUTTON);
XtAddCallback (moreButton, XmNactivateCallback,
MoreHelpCB, NULL);
XtManageChild (moreButton);
See Also
Generated with CERN WebMaker