ヘルプ システムのインターフェイス

提供: RAD Studio
移動先: 案内検索

アプリケーションでのヘルプの有効化 への移動

ヘルプ システムを使用すると、System.HelpIntfs ユニットで定義された一連のインターフェイスを介して、アプリケーションとヘルプ ビューアの間の通信を行うことができます。HelpIntfs ではヘルプ マネージャの実装も提供されています。重要なインターフェイスには次のものがあります。

  • System.HelpIntfs.ICustomHelpViewer では、文字列型のキーワードで指定したヘルプ トピックを表示したり、特定のヘルプ ビューアに表示可能なすべてのヘルプ トピックの目次を表示することができます。
注意: HelpIntfs ユニットでは、System.HelpIntfs.ICustomHelpViewerSystem.HelpIntfs.IExtendedHelpViewer、および System.HelpIntfs.ISpecialWinHelpViewer のインターフェイスの実装を提供していません。これらのインターフェイスのメソッドを使用するには、アプリケーションの uses 句に Vcl.HtmlHelpViewer ユニットを追加してください。Vcl.HtmlHelpViewer ユニットには、Windows のネイティブ ヘルプ処理関数 HTMLHelp に対する Delphi インターフェイスが用意されています。C++ の場合は、Vcl.HtmlHelpViewer.hpp ヘッダー ファイルをインクルードする必要があります また、ICustomHelpViewer などのインターフェイスを独自に実装することもできます。その実装では、使用する外部ヘルプ ビューアの Delphi(または C++)ラッパーを提供しなければなりません。
  • System.HelpIntfs.IExtendedHelpViewer では、コンテキスト ID(数値)やトピック名で指定したヘルプ トピックを表示することができます。ほとんどのヘルプ システムでは、トピック名を高レベルのキーワードとして使うことができます(たとえば "IntToStr" はヘルプ システムのキーワードですが、"文字列操作ルーチン" はトピック名になります)。
  • System.HelpIntfs.ISpecialWinHelpViewer では、Windows で動作しているアプリケーションが受け取る可能性がある HTMLHelp コマンドのうち、簡単に一般化できない特別なコマンドに応答することができます。通常、このインターフェイスを実装する必要があるのは、Windows 環境で動作するアプリケーションで、かつ、標準以外の HTMLHelp コマンドを広く使用しているものだけです。
  • System.HelpIntfs.IHelpManager では、ヘルプ ビューアからアプリケーションのヘルプ マネージャへ通信を行って追加の情報を要求するためのメカニズムを提供しています。IHelpManager は、ヘルプ ビューア自体を登録する System.HelpIntfs.RegisterViewer の呼び出しの際に取得されます。
  • System.HelpIntfs.IHelpSystem では、TApplication がヘルプ システムにヘルプ要求を渡すためのメカニズムを提供しています。TApplication は、アプリケーションの読み込み時に IHelpSystemIHelpManager の両方を実装したオブジェクトのインスタンスを取得し、そのインスタンスをプロパティとしてエクスポートします。それを使うことで、アプリケーション内の他のコードから、必要に応じて直接にヘルプ要求を出すことができます。
IHelpSelector では、キーワードベースのヘルプ要求を処理できるヘルプ ビューアが複数ある場合にどれを使うべきかを尋ねたり、目次を表示したりするためのユーザー インターフェイスを、ヘルプ システムが呼び出せるようにするメカニズムを提供します。
メモ: IHelpSelector インターフェイスの実装は提供されていません。このインターフェイスのメソッドを使用するには、独自に実装する必要があります。

関連トピック

関連項目