test

共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

簡易ヘルプ・ダイアログ

簡易ヘルプ・ダイアログ・ボックスは、オンライン・ヘルプの第一目標であるユーザができるだけ早く、またうまく作業に戻れることが達成されるように設計されています。このシンプルなユーザ・インタフェースにより、ユーザは情報に集中できます。ダイアログの情報は、ユーザが読んだ後に消してしまっても作業が続けられるように、便利なものでなければなりません。

図 9-2 標準ボタンが 4 つある簡易ヘルプ・ダイアログ

Graphic

簡易ヘルプ・ダイアログには 5 つのボタンがあり、そのうち 4 つが管理されています。残りのダイアログ・ボタンは構成可能なので、このボタンは希望に合わせて使用できます。しかし、その目的としては次の 2 つの方法のどちらかでヘルプへのパスを提供することです。

開発者用ツールキットには簡易関数 DtHelpQuickDialogGetChild() が含まれています。この関数は、どの簡易ヘルプ・ダイアログ・ボタンにも対応するウィジェット ID を決定します。

簡易ヘルプ・ダイアログを作成するには

  1. 適切なヘッダ・ファイルを指定します。 

       
#include <Help.h>
#include <HelpQuickD.h>

  2. 簡易ヘルプ・ダイアログ・ウィジェットのインスタンスを作成します。

    DtCreateHelpQuickDialog() 簡易関数

    または XtCreateManagedWidget() 関数を使用します。

  3. ダイアログ内で発生するハイパーリンク・イベントを処理するためのコールバックを追加します (詳細は、「ハイパーリンク・イベントへの応答」を参照してください)。

  4. [了解] ボタンを処理するためのクローズ・コールバックを追加します。

  5. 使用するダイアログ・ボタンを構成します。

    • アプリケーション定義のボタンを使用するには、ボタンを管理してアクティブ・コールバックを追加します。

    • 印刷を許可しないようにするには、[印刷] ボタンを管理しないでください。

    • ユーザが「ヘルプの使い方」を使用できるように、[ヘルプ] ボタンを管理してダイアログへのヘルプ・コールバックを追加します。

例

次のコード・セグメントは、簡易関数を使用して簡易ヘルプ・ダイアログを (parent の子として) 作成します。ダイアログは管理されていません。通常、ヘルプが要求された時点でアプリケーションのどこかで管理されます。この例では、アプリケーション定義のボタンが使用可能になっており、ヘルプをさらに要求するために使用します。

Widget   quickHelpDialog, moreButton, helpButton;
 ac = 0;
 XtSetArg (al[ac], XmNtitle,  "My Application - Help");  ac++;
 XtSetArg (al[ac], DtNhelpVolume,  "My Help Volume");  ac++;
 XtSetArg (al[ac], DtNlocationId,  "Getting Started");  ac++;
 XtSetArg (al[ac], DtNhelpType,  "DtHELP_TYPE_TOPIC"); ac++;


 quickHelpDialog =
   DtCreateHelpQuickDialog (parent,  "quickHelpDialog", al, ac);

次の 2 つの呼び出しは、ダイアログにハイパーリンクとクローズ・コールバックを追加します。通常、関数 HyperlinkCB() と CloseHelpCB() はアプリケーションのどこかで宣言されます。 

XtAddCallback (quickHelpDialog, DtNhyperLinkCallback,
				HyperlinkCB, (XtPointer)NULL);
XtAddCallback (quickHelpDialog, DtNcloseCallback,
                CloseHelpCB, (XtPointer)NULL);

ここでアプリケーション定義のボタンが管理され、アプリケーションの MoreHelpCB() 関数を起動する起動コールバックが割り当てられます。

moreButton = DtHelpQuickDialogGetChild (quickHelpDialog,
										DT_HELP_QUICK_MORE_BUTTON);
 XtManageChild (moreButton);
XtAddCallback (moreButton, XmNactivateCallback,
                MoreHelpCB, (XtPointer)NULL);

「ヘルプの使い方」を提供するために、ダイアログの [ヘルプ] ボタンが管理され、ダイアログにヘルプ・コールバックが追加されます。 

helpButton = DtHelpQuickDialogGetChild (quickHelpDialog,
										DT_HELP_QUICK_HELP_BUTTON);
 XtManageChild (helpButton);
XtAddCallback (quickHelpDialog,DtNhelpCallback,
                HelpRequestCB, USING_HELP);

他の OSF/Motif ダイアログと同様に、簡易ヘルプ・ダイアログにヘルプ・コールバックを追加すると、[F1] キーと [ヘルプ] ボタンのどちらからでも簡易ヘルプ・ダイアログが使用できます。

関連項目