Vcl.WinHelpViewer

De RAD Studio API Documentation
Aller à : navigation, rechercher

Implémente le wrapper pour la fonction API WinHelp. L'unité WinHelpViewer est obsolète, veuillez utiliser à la place Vcl.HtmlHelpViewer.

Package vcl.bpl

Classes

IWinHelpTesterLes méthodes de cette interface aident au maintien et à l'analyse des fichiers d'aide et des listes de mots clés, des ALinks, des IDs de contexte et des rubriques d'aide, qui peuvent être utilisés dans les requêtes à la fonction API de l'aide WinHelp de Windows.
La VCL ne fournit pas l'implémentation de cette interface. Si vous devez supporter ses fonctionnalités, vous devez implémenter IWinHelpTester dans votre application.

Variables

ViewerNameLa variable ViewerName stocke une chaîne que le Gestionnaire d'aide peut utiliser pour identifier cette visionneuse à choisir parmi les visionneuses recensées.
WinHelpTesterLa variable WinHelpTester stocke l'objet créé du type IWinHelpTester.


Description

L'unité WinHelpViewer implémente le wrapper pour la fonction API WinHelp de Windows. Microsoft a désapprouvé WinHelp. WinHelp n'est pas fourni avec Windows Vista ou Windows 7. Par conséquent, l'unité WinHelpViewer est obsolète. Utilisez à la place Vcl.HtmlHelpViewer.

WinHelpViewer encapsule les fonctionnalités de l'API WinHelp dans la classe TWinHelpViewer privée, déclarée dans la section implementation. La classe TWinHelpViewer implémente les interfaces d'aide déclarées dans l'unité System.HelpIntfs. HelpIntfs fournit la série d'interfaces qui permet au système d'aide de communiquer entre les requêtes d'aide de votre application et une visionneuse d'aide externe telle que HTMLHelp ou WinHelp.

Pour accéder aux méthodes de la classe privée TWinHelpViewer depuis les autres unités, la section initialization de cette unité crée l'objet HelpViewer de cette classe et appelle la fonction System.HelpIntfs.RegisterViewer globale pour recenser le Gestionnaire d'aide. La fonction globale System.HelpIntfs.GetHelpSystem, de l'unité HelpIntfs, peut récupérer les objets système d'aide du HelpViewer recensé. Le code des autres unités peut ensuite accéder aux méthodes des objets du système d'aide récupérés.

Pour utiliser la visionneuse d'aide WinHelp dans votre application, incluez l'unité WinHelpViewer dans la section uses de l'unité main (ou dans une autre unité adéquate) de votre application. Toutefois, puisque Microsoft a désapprouvé la visionneuse WinHelp, nous vous recommandons d'utiliser à la place Vcl.HtmlHelpViewer.

Section initialization

La section initialization de l'unité WinHelpViewer fournit l'initialisation suivante :

 HelpViewer := TWinHelpViewer.Create;
 HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);

Ici :

  • Le constructeur TWinHelpViewer.Create de la première ligne crée en interne l'objet visionneuse d'aide HelpViewerIntf de la classe TWinHelpViewer et le stocke dans la variable HelpViewer.
  • La deuxième ligne appelle la fonction globale System.HelpIntfs.RegisterViewer qui recense la visionneuse d'aide créée.

La fonction globale System.HelpIntfs.GetHelpSystem peut être appelée à partir d'autres unités pour accéder aux méthodes des systèmes d'aide de la visionneuse d'aide recensée.

Voir aussi