キーワードベースのヘルプの表示
ヘルプ システムのインターフェイス への移動
ヘルプ要求は、一般に、キーワードベースのヘルプかコンテキストベースのヘルプとしてヘルプ ビューアに送られます。キーワードベースの場合、ヘルプ ビューアは、特定の文字列に基づいてヘルプを表示するように要求されます。コンテキストベースの場合は、特定の数値識別子に基づいてヘルプを表示するように要求されます。
メモ： Windows の HTMLHelp ビューアを使用するアプリケーションでは、数値で表されるヘルプ コンテキストがヘルプ要求のデフォルト形式になっています。
System.HelpIntfs.ICustomHelpViewer インターフェイスの実装では、キーワードベースのヘルプ要求をサポートする必要があるのに対して、HelpIntfs.IExtendedHelpViewer の実装ではコンテキストベースのヘルプ要求をサポートする必要があります。
ICustomHelpViewer には、キーワードベースのヘルプを処理するためのメソッドが、以下のように、3 つあります。
UnderstandsKeyword(const HelpString: String): Integer
int UnderstandsKeyword(const UnicodeString HelpString)
- UnderstandsKeyword は、ヘルプ マネージャから呼び出される 3 つのメソッドのうちの最初のメソッドです。UnderstandsKeyword は、登録済みのヘルプ ビューアを同じ HelpString 文字列で 1 つずつ呼び出し、そのビューアがこの HelpString に対応するヘルプを提供できるかどうかを問い合わせていきます。UnderstandsKeyword は、このヘルプ要求に応答してヘルプ ビューアが表示できるヘルプ ページの数を示す整数を返すことになっています。
ICustomHelpViewer.GetHelpStrings(const HelpString: String): TStringList
Classes::TStringList*__fastcall ICustomHelpViewer::GetHelpStrings(const UnicodeString HelpString)
- GetHelpStrings は、指定された HelpString キーワードに基づいて複数のヘルプ ビューアがヘルプを提供できる場合に、ヘルプ マネージャから呼び出されます。ヘルプ ビューアは TStringList を返すことになっており、ヘルプ マネージャ側でそれを解放します。返されたこのリストに含まれている文字列は、HelpString キーワードに対応するヘルプ トピックにマッピングされる必要がありますが、そのマッピングの特性はヘルプ ビューアによって決まります。Windows の HTMLHelp ビューアの場合、この文字列リストには必ずエントリが 1 つだけ入っています。
ShowHelp(const HelpString: String)
void__fastcall ShowHelp(const UnicodeString HelpString)
- ShowHelp は、特定の HelpString キーワードに対応するヘルプをヘルプ ビューアに表示させる必要がある場合に、ヘルプ マネージャから呼び出されます。このメソッドは、一連の操作の最後に呼び出されるメソッドです。つまり、最初に UnderstandsKeyword が呼び出されない限り、このメソッドが呼び出されることはありません。