Vcl.WinHelpViewer
WinHelp 関数 API のラッパーが実装されています。WinHelpViewer ユニットは非推奨になっています。Vcl.HtmlHelpViewer を代わりに使用してください。
| パッケージ | vcl240.bpl |
|---|
クラス
| IWinHelpTester |
このインターフェイスのメソッドを使用して、Windows WinHelp ヘルプ API 関数への要求に使用できる、ヘルプ ファイルやキーワード リスト、ALink、コンテキスト ID、ヘルプ トピックを保守し分析することができます。 |
型
| _di_IWinHelpTester |
C++ で宣言されている DelphiInterface 型で、Delphi の IWinHelpTester インターフェイスに対応するものです。 |
変数
| ViewerName |
ViewerName 変数には、登録ビューアの中からこのビューアを特定するためにヘルプ マネージャが使用できる文字列が格納されます。 |
| WinHelpTester |
WinHelpTester 変数には、作成された IWinHelpTester 型のオブジェクトが格納されます。 |
説明
WinHelpViewer ユニットには、Windows WinHelp 関数 API のラッパーが実装されています。WinHelp は Microsoft により非推奨になりました。WinHelp は Windows Vista または Windows 7 には付属していません。そのため、WinHelpViewer ユニットが非推奨になっているのです。代わりに、Vcl.HtmlHelpViewer を使用します。
WinHelpViewer では、implementation セクションで宣言されている private クラス TWinHelpViewer に WinHelp API 機能がラップされています。TWinHelpViewer クラスでは、System.HelpIntfs ユニットで宣言されているヘルプ インターフェイスを実装しています。HelpIntfs には一連のインターフェイスが用意されており、これらを通じて、ヘルプ システムはアプリケーションにおけるヘルプ要求と HTMLHelp や WinHelp などの外部ヘルプ ビューアの間でやり取りすることができます。
他のユニットから private クラス TWinHelpViewer のメソッドにアクセスするために、このユニットの initialization セクションでは、このクラスの HelpViewer オブジェクトを作成し、グローバル関数 System.HelpIntfs.RegisterViewer を呼び出してヘルプ ビューアを登録しています。HelpIntfs ユニットに含まれているグローバル関数 System.HelpIntfs.GetHelpSystem を使用すれば、登録した HelpViewer のヘルプ システム オブジェクトを取得できます。その結果、他のユニットのコードで、取得したヘルプ システム オブジェクトのメソッドにアクセスできます。
アプリケーションで WinHelp ヘルプ ビューアを使用するには、アプリケーションのメイン ユニット（または別の適切なユニット）の uses セクションに WinHelpViewer ユニットを含めます。ただし、Microsoft により WinHelp ビューアは非推奨になったため、Vcl.HtmlHelpViewer を代わりに使用することをお勧めします。
initialization セクション
WinHelpViewer ユニットの initialization セクションでは、次のような初期化を行っています。
HelpViewer := TWinHelpViewer.Create; HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
ここで行われていることは以下のとおりです。
- 1 行目の TWinHelpViewer.Create コンストラクタでは、TWinHelpViewer クラスのヘルプ ビューア オブジェクト
HelpViewerIntfを内部的に作成し、それを HelpViewer 変数に格納しています。 - 2 行目では、グローバル関数 System.HelpIntfs.RegisterViewer を呼び出して、作成したヘルプ ビューアを登録しています。
グローバル関数 System.HelpIntfs.GetHelpSystem を他のユニットから呼び出して、登録されたヘルプ ビューアのヘルプ システムのメソッド群にアクセスすることができます。