|  | M -1.0-

Module : HelpViewer V1.0

Catégorie / Domaine : | Tools
Compatibilité Scol Engine : | V3.2d et supérieure
Systèmes d'exploitation : | Windows 95/98
| Windows NT 4.0
Documentation datée du : | 31/07/2000

Remplace fiche :

Description du module

HelpViewer permet à un utilisateur d’afficher une fenêtre d’aide. Il doit être relié au module HelpServer pour fonctionner :

[HelpViewer].ask | à | [HelpServer].ask
[HelpServer].answer | à | [HelpViewer].answer

L’icône d’aide s’affiche avec l’action “start” :

Evénement à [HelpViewer].start

L’icône d’aide s’affiche soit dans une zone de document, si celle-ci a été définie, soit dans une fenêtre popup en bas à droite de l’écran.Pour appeler la fenêtre d’aide, l’utilisateur doit cliquer sur l’icône d’aide. La fenêtre d’aide met alors à sa disposition un arbre de questions/réponses.

Actions et évènements

Actions

· start : démarre le client HelpViewer et affiche l’icône d’aide

· answer : on transmet à HelpViewer une série de questions/réponses suivant la syntaxe de type strbuild :

[référence du champ d’aide]\ [type du champ]\ [texte du champ]\n ect…

référence : identificateur (textuel) du texte du champ, correspondant aux coordonnées du champ dans l’arbre d’aide

type : « 0 » si question, « 1 » si réponse, « 2 » si pointeur vers champ d’aide précédent, « 3 » si barre de titre, « 4 » si barre d’espace

· make it ask : déclenche automatiquement l’affichage d’un champ d’aide. Les coordonnées du champs d’aide doivent être passées en paramètre.

Exemple : make it ask 0_0 affiche la racine de l’aide.

Evènements

· ask : transmet une référence de champ d’aide, correspondant à la référence du père des nœuds d’aide que l’on veut afficher.

Zones

· HelpViewerIcon : interface graphique de l’icône d’aide (définir une zone n’est pas obligatoire. Si la zone HelpViewerIcon n’est pas définie, l’icône d’aide apparaîtra dans une petite fenêtre popup en bas à droite de l’écran.