Interfaces système d'aide
Remonter à Activation de l'aide dans les applications
Le système d'aide permet la communication entre votre application et les visionneuses d'aide, via une série d'interfaces définies dans l'unité System.HelpIntfs. HelpIntfs fournit aussi l'implémentation du gestionnaire d'aide. Les interfaces les plus importantes sont les suivantes :
- System.HelpIntfs.ICustomHelpViewer fournit le support de l'affichage de rubriques d'aide spécifiées par des mots clés de type chaîne, et de l'affichage d'un sommaire listant toutes les rubriques d'aide disponibles dans une visionneuse d'aide particulière.
- Attention ! L'unité HelpIntfs ne fournit pas d'implémentation pour les interfaces System.HelpIntfs.ICustomHelpViewer, System.HelpIntfs.IExtendedHelpViewer et System.HelpIntfs.ISpecialWinHelpViewer. Pour utiliser les méthodes de ces interfaces, vous pouvez insérer dans la clause uses de votre application l'unité Vcl.HtmlHelpViewer. L'unité Vcl.HtmlHelpViewer fournit une interface Delphi à la fonction de gestion d'aide native Windows HTMLHelp. Pour C++, vous devez inclure le fichier d'en-tête Vcl.HtmlHelpViewer.hpp. Vous pouvez aussi fournir votre propre implémentation pour ICustomHelpViewer et d'autres interfaces. Cette implémentation doit fournir un wrapper Delphi (ou C++) aux visionneuses d'aide externes à utiliser.
- System.HelpIntfs.IExtendedHelpViewer fournit le support de l'affichage de rubriques d'aide spécifiées par des identificateurs de contexte numériques et par des noms de rubriques. Dans la plupart des systèmes d'aide, les noms des rubriques peuvent fonctionner comme des mots clés de haut niveau (par exemple, "
IntToStr" pourrait être un mot clé dans le système d'aide, mais "Routines de gestion des chaînes" pourrait être le nom d'une rubrique).
- System.HelpIntfs.ISpecialWinHelpViewer fournit le support de la réponse aux commandes HTMLHelp spécialisées qu'une application s'exécutant sous Windows peut recevoir et qui ne sont pas facilement généralisables. En général, seules les applications opérant dans l'environnement Windows doivent implémenter cette interface et, même alors, elle n'est nécessaire que pour les applications faisant une forte utilisation des messages HTMLHelp non standard.
- System.HelpIntfs.IHelpManager fournit un mécanisme permettant à la visionneuse d'aide de communiquer avec le gestionnaire d'aide de l'application, et demande un supplément d’information. IHelpManager est obtenu pendant l'appel à System.HelpIntfs.RegisterViewer qui recense la visionneuse d'aide elle-même.
- System.HelpIntfs.IHelpSystem fournit un mécanisme à travers lequel TApplication passe les requêtes d'aide au système d'aide. TApplication obtient une instance d'un objet qui implémente à la fois IHelpSystem et IHelpManager au chargement de l'application et exporte cette instance en tant que propriété. Cela autorise d'autres parties du code de l'application à traiter les requêtes d'aide directement lorsque c’est possible.
- IHelpSelector doit fournir un mécanisme à travers lequel le système d'aide peut invoquer l'interface utilisateur pour demander la visionneuse d'aide qui doit être utilisée quand plusieurs visionneuses d'aide sont à même de gérer une requête d'aide basée sur un mot clé ou d'afficher un sommaire.
- Remarque : Nous ne fournissons pas une implémentation de l'interface IHelpSelector. Pour utiliser les méthodes de cette interface, vous devez fournir votre propre implémentation.
Rubriques
- 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