Communication avec le gestionnaire d'aide

De RAD Studio
Aller à : navigation, rechercher

Remonter à Interfaces système d'aide


System.HelpIntfs.ICustomHelpViewer fournit quatre fonctions servant à communiquer les informations système au gestionnaire d'aide. Le gestionnaire d'aide appelle ces fonctions dans les circonstances suivantes :

  • GetViewerName: String -- appelée lorsque le gestionnaire d'aide veut connaître le nom du visualiseur d'aide (par exemple, si l'application doit afficher la liste des visualiseurs d'aide recensés). Cette information est renvoyée via une valeur de retour chaîne et celle-ci doit être logiquement statique (c'est-à-dire qu'elle ne peut pas être modifiée pendant que l'application s'exécute).
  • NotifyID(const ViewerID: Integer) -- appelée immédiatement après le recensement pour fournir au visualiseur d'aide un cookie qui l'identifie de manière unique. Cette information doit être conservée pour une utilisation ultérieure ; si le visualiseur d'aide s'interrompt de son propre chef (et non pas en réponse à une notification du gestionnaire d'aide), il doit fournir le cookie identificateur au gestionnaire d'aide pour que celui-ci libère toutes les références au visualiseur. (Ne pas réussir à fournir le cookie, ou en fournir un mauvais, peut amener le gestionnaire d'aide à libérer les références au mauvais visualiseur d'aide.)
  • ShutDown -- appelée par le gestionnaire d'aide pour signaler au visualiseur d'aide que le gestionnaire d'aide va s'interrompre et que toutes les ressources allouées par le visualiseur doivent être libérées. Il est conseillé de déléguer à cette méthode la libération de toutes les ressources.
  • SoftShutDown -- appelée par le gestionnaire d'aide pour demander au visualiseur d'aide de fermer toutes les manifestations visibles externes du système d'aide (par exemple, les fenêtres affichant des informations d'aide) sans décharger le visualiseur.

Voir aussi