Activation de l'aide dans les applications
Remonter à Construction d'applications, de composants et de bibliothèques - Index
- Remarque : La plupart des fonctionnalités d'aide décrites dans cette section peuvent être utilisées dans les applications Delphi et C++ de la même façon.
Les applications VCL supportent l'affichage de l'aide à partir d'un mécanisme à base d'objets permettant la transmission des demandes d'aide à l'une des multiples visionneuses d'aide externes. Pour supporter cela, une application doit inclure une classe qui implémente l’interface System.HelpIntfs.ICustomHelpViewer (et, facultativement, l'une des interfaces qui en descendent -- Interfaces système d'aide), puis se recense elle-même avec le gestionnaire d'aide global.
La bibliothèque VCL fournit l'unité Vcl.HtmlHelpViewer. La section implementation de cette unité définit la classe THTMLHelpViewer interne, qui implémente toutes ces interfaces et fournit un lien entre les applications et la visionneuse d'aide Windows HTMLHelp. Pour de plus amples informations sur la fonction HTMLHelp, voir la bibliothèque MSDN. La section initialization de l'unité Vcl.HtmlHelpViewer crée l'instance de la classe THTMLHelpViewer :
HelpViewer := THTMLHelpViewer.Create; HelpIntfs.RegisterViewer(HelpViewerIntf, HelpViewer.FHelpManager);
Ici, le constructeur THTMLHelpViewer.Create crée en interne l'objet visionneuse d'aide HelpViewerIntf de la classe THTMLHelpViewer. Le second appel passe cet objet visionneuse d'aide à la fonction System.HelpIntfs.RegisterViewer globale, qui recense la visionneuse d'aide créée et renvoie le gestionnaire d'aide HelpViewer.FHelpManager. La fonction System.HelpIntfs.GetHelpSystem globale peut être appelée à partir d'autres unités pour accéder aux méthodes d'aide de la visionneuse d'aide recensée. De cette façon, vous pouvez obtenir l'accès aux implémentations de toutes les méthodes déclarées dans l'interface System.HelpIntfs.ICustomHelpViewer (et les autres interfaces de HelpIntfs) et qui sont implémentées dans la classe THTMLHelpViewer.
Exigences Delphi et C++
- Si vous voulez utiliser la visionneuse d'aide HTMLHelp dans votre application Delphi, vous devez insérer l'unité Vcl.HtmlHelpViewer dans la clause
usesde votre application. - Dans les applications C++, vous devez ajouter la directive
#include Vcl.HtmlHelpViewer.hpp.
Le gestionnaire d'aide maintient la liste des visionneuses recensées et leur passe les requêtes dans un processus à deux phases : il demande d'abord à chaque visionneuse d'aide recensée si elle peut fournir un support pour un ID de contexte ou un mot clé d'aide particulier, puis passe ensuite la requête d'aide à la visionneuse d'aide ayant indiqué qu'elle peut fournir un tel support.
Rubriques
- Appel de l'aide HTML depuis les applications
- Types d'aide HTML
- Gestion par défaut de l'aide F1 dans les applications VCL
- Personnalisation de l'aide F1 dans les applications VCL
- Affichage de l'aide avec les boutons d'aide
- Association de l'aide avec les commandes de menu
- Affichage de l'aide à propos des commandes de menu sélectionnées
- Utilisation de la propriété Hint pour afficher l'aide contextuelle des objets d'écran
- Interfaces système d'aide
- Implémentation de ICustomHelpViewer
- Communication avec le gestionnaire d'aide
- Demande d'informations au gestionnaire d'aide
- Affichage de l'aide basée sur un mot clé
- Affichage des sommaires
- Implémentation de IExtendedHelpViewer
- Utilisation de IHelpSystem
- Implémentation de IHelpSelector
- Recensement des objets de système d'aide
- Utilisation de l'aide dans une application VCL