Vcl.HtmlHelpViewer
Implémente le wrapper pour la fonction API HTMLHelp de Windows.
| Package | vcl.bpl |
|---|
Classes
| IHtmlHelpTester | Les 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 HTMLHelp Windows. |
Variables
| HtmlHelpTester | La variable HtmlHelpTester stocke l'objet créé du type IHtmlHelpTester. |
| ViewerName | La variable ViewerName stocke une chaîne que le Gestionnaire d'aide peut utiliser pour identifier cette visionneuse parmi les visionneuses recensées. |
Description
L'unité HtmlHelpViewer implémente une visionneuse d'aide externe fournissant le wrapper pour la fonction API HTMLHelp de Windows. L'objectif de conception de cette unité est d'être indistinguable des autres visionneuses d'aide externes pour autant que le gestionnaire d'aide VCL puisse le déterminer. Par conséquent, elle encapsule seulement ces fonctionnalités de l'API HTMLHelp qui sont utilisées par le système d'aide implémenté dans l'unité System.HelpIntfs.
HtmlHelpViewer encapsule les fonctionnalités de l'API HTMLHelp dans la classe THtmlHelpViewer privée, déclarée dans la section implementation. La classe THtmlHelpViewer implémente les interfaces d'aide déclarées dans l'unité System.HelpIntfs. System.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.
Pour accéder aux méthodes de la classe privée THtmlHelpViewer 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é System.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 HTMLHelp dans votre application, incluez l'unité HtmlHelpViewer dans la section uses de l'unité main (ou dans une autre unité adéquate) de votre application.
Section initialization
La section initialization de l'unité HtmlHelpViewer fournit l'initialisation suivante :
HelpViewer := THtmlHelpViewer.Create; HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
Ici :
- Le constructeur THtmlHelpViewer.Create de la première ligne crée en interne l'objet visionneuse d'aide
HelpViewerIntfde la classe THtmlHelpViewer 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.