Vcl.WinHelpViewer
Implementiert den Wrapper für die WinHelp-Funktions-API. Die Unit WinHelpViewer ist veraltet – bitte verwenden Sie stattdessen Vcl.HtmlHelpViewer.
| Package | vcl250.bpl |
|---|
Klassen
| IWinHelpTester | Methoden dieses Interface unterstützen die Verwaltung und Analyse von Hilfedateien und Schlüsselwortlisten, ALinks, Kontext-IDs und Hilfethemen, die in Anforderungen der Windows-API-Hilfefunktion WinHelp verwendet werden können. Die VCL stellt keine Implementierung dieses Interface bereit. Zur Unterstützung der Funktionen dieses Interface müssen Sie IWinHelpTester in Ihre Anwendung implementieren. |
Variablen
| ViewerName | In der Variable ViewerName wird ein String gespeichert, mit dem der Hilfemanager diesen Viewer unter anderen registrierten Viewern identifizieren und auswählen kann. |
| WinHelpTester | In der Variable WinHelpTester wird das erstellte Objekt mit dem Typ IWinHelpTester gespeichert. |
Inhaltsverzeichnis
Beschreibung
Die Unit WinHelpViewer implementiert die Kapselung für die WinHelp-Funktions-API von Windows. Microsoft unterstützt WinHelp nicht mehr. WinHelp wird nicht mit Windows Vista oder Windows 7 ausgeliefert. Deshalb ist die Unit WinHelpViewer veraltet! Verwenden Sie stattdessen Vcl.HtmlHelpViewer.
WinHelpViewer kapselt die WinHelp-API-Funktionen in der TWinHelpViewer-Klasse, die im Abschnitt implementation als "private" deklariert wird. Die Klasse TWinHelpViewer implementiert Hilfe-Interfaces, die in der Unit System.HelpIntfs deklariert sind. HelpIntfs stellt die Interfaces bereit, über die das Hilfesystem Hilfeanforderungen zwischen Anwendungen und einem externen Hilfe-Viewer, wie HTMLHelp oder WinHelp, weitergeben kann.
Um auf Methoden der als private deklarierten TWinHelpViewer-Klasse aus anderen Units zuzugreifen, wird im Abschnitt initialization dieser Unit das HelpViewer-Objekt dieser Klasse erstellt und die globale Funktion System.HelpIntfs.RegisterViewer zum Registrieren des Hilfe-Managers aufgerufen. Mit der globalen Funktion System.HelpIntfs.GetHelpSystem aus der Unit HelpIntfs können Hilfesystemobjekte des registrierten HelpViewer abgerufen werden. Mit Code aus anderen Units kann dann auf Methoden der abgerufenen Hilfesystemobjekte zugegriffen werden.
Beziehen Sie die Unit WinHelpViewer in den uses-Abschnitt der Unit "main" (oder in eine andere geeignete Unit) Ihrer Anwendung ein, um den WinHelp-Hilfe-Viewer in Ihrer Anwendung zu verwenden. Weil Microsoft den WinHelp-Viewer aber nicht mehr unterstützt, wird stattdessen die Verwendung des Vcl.HtmlHelpViewer empfohlen.
initialization-Abschnitt
Der initialization-Abschnitt der Unit WinHelpViewer enthält die folgende Initialisierung:
HelpViewer := TWinHelpViewer.Create; HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
Folgendes wird im obigen Code ausgeführt:
- Durch den Konstruktor TWinHelpViewer.Create in der ersten Zeile wird das Hilfe-Viewer-Objekt
HelpViewerIntfder Klasse TWinHelpViewer intern erstellt und in der Variable HelpViewer gespeichert. - In der zweiten Zeile wird die globale Funktion System.HelpIntfs.RegisterViewer zum Registrieren des erstellen Hilfe-Viewers aufgerufen.
Die globale Funktion System.HelpIntfs.GetHelpSystem kann in anderen Units für den Zugriff auf Methoden des Hilfesystems aus dem registrierten Hilfe-Viewer aufgerufen werden.