Hilfesystem-Interfaces

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Hilfe in Anwendungen aktivieren

Das Hilfesystem ermöglicht über mehrere Interfaces die Kommunikation zwischen Anwendungen und in der Unit System.HelpIntfs definierten Hilfe-Viewern. HelpIntfs enthält auch die Implementierung des Hilfe-Managers. Im Folgenden sind die wichtigsten Interfaces aufgeführt:

  • System.HelpIntfs.ICustomHelpViewer unterstützt die Anzeige von mit String-Schlüsselwörtern angegebenen Hilfethemen sowie die Anzeige eines Inhaltsverzeichnisses, das alle in einem bestimmten Hilfe-Viewer verfügbaren Hilfethemen auflistet.
Achtung! Die Unit HelpIntfs stellt keine Implementierungen für die Interfaces System.HelpIntfs.ICustomHelpViewer, System.HelpIntfs.IExtendedHelpViewer und System.HelpIntfs.ISpecialWinHelpViewer bereit. Sie können für die Verwendung von Methoden dieser Interfaces der uses-Klausel Ihrer Anwendung die Unit Vcl.HtmlHelpViewer hinzufügen. Die Unit Vcl.HtmlHelpViewer stellt ein Delphi-Interface für die native HTMLHelp-Hilfebehandlungsfunktion von Windows bereit. Für C++ müssen Sie die Header-Datei Vcl.HtmlHelpViewer.hpp einbeziehen. Sie können für ICustomHelpViewer und andere Interfaces auch eine eigene Implementierung bereitstellen. Diese Implementierung sollte einen Delphi-Wrapper (oder einen C++-Wrapper) für den zu verwendenden externen Hilfe-Viewer enthalten.
  • System.HelpIntfs.IExtendedHelpViewer unterstützt die Anzeige von durch numerische Kontextbezeichner und durch Themennamen angegebenen Hilfethemen. In den meisten Hilfesystemen können Themennamen als Schlüsselwörter der oberen Ebene dienen (beispielsweise könnte "IntToStr" ein Schlüsselwort im Hilfesystem sein, während "Routinen für die String-Bearbeitung" der Name eines Themas sein könnte).
  • System.HelpIntfs.ISpecialWinHelpViewer stellt die Unterstützung für Antworten auf bestimmte HTMLHelp-Befehle bereit, die eine unter Windows ausgeführte Anwendung empfangen kann und die nicht einfach verallgemeinert werden können. In der Regel müssen nur Anwendungen in der Windows-Umgebung dieses Interface implementieren, und selbst dort wird es nur für Anwendungen benötigt, die viele nicht dem Standard entsprechende HTMLHelp-Befehle verwenden.
  • System.HelpIntfs.IHelpManager stellt einen Mechanismus für den Hilfe-Viewer bereit, über den der Viewer mit dem Hilfe-Manager der Anwendung kommunizieren und weitere Informationen anfordern kann. IHelpManager wird während des Aufrufs der Methode System.HelpIntfs.RegisterViewer, die den Hilfe-Viewer registriert, abgerufen.
  • System.HelpIntfs.IHelpSystem stellt einen Mechanismus bereit, über den TApplication Hilfeanforderungen an das Hilfesystem weitergibt. TApplication ruft eine Instanz des Objekts ab, das IHelpSystem und IHelpManager beim Laden der Anwendung implementiert und diese Instanz als Eigenschaft exportiert. So können bei Bedarf Hilfeanforderungen durch anderen Code in der Anwendung direkt gestellt werden.
IHelpSelector sollte einen Mechanismus bereitstellen, über den das Hilfesystem die Benutzeroberfläche aufrufen kann, um abzufragen, welcher Hilfe-Viewer verwendet werden soll, falls für eine schlüsselwortbasierte Hilfeanforderung oder eine Anforderung zur Anzeige des Inhaltsverzeichnisses mehrere Hilfe-Viewer zur Verfügung stehen.
Hinweis: Für das Interface IHelpSelector ist keine Implementierung vorgesehen. Zur Verwendung der Methoden dieses Interface müssen Sie eine eigene Implementierung bereitstellen.

Themen

Siehe auch