L'environnement de bureau K

8.2. Ajouter une Aide Rapide

Les fenêtres d'Aide Rapide sont un autre bon exemple de manière de donner de l'aide. L'utilisateur peut accéder à l'aide rapide sur un widget qui y est connecté en cliquant avec le bouton droit de la souris et en sélectionnant Aide Rapide (NdT : "Quick-Help") dans le menu contextuel. L'Aide Rapide est donc à mi-chemin entre une aide détaillée et des bulles d'aide - la documentation serait trop exhaustive et une bulle d'aide ne donnerait pas assez de détails. Pour voir comment fonctionne l'Aide Rapide, ouvrez n'importe quelle boîte de dialogue de KDevelop et cliquez avec le bouton droit sur un élément de la boîte de dialogue. Sélectionnez ensuite l'entrée "Aide Rapide" et vous obtiendrez le message d'aide. En plus, ces messages peuvent être formatés avec de la couleur, une police et peuvent même contenir des URL pour référer à une certaine page Web (et peuvent donc aussi pointer sur le manuel d'utilisation).

Pour utiliser l'Aide Rapide, ajoutez le fichier d'inclusion kquickhelp.h à votre fichier source contenant de l'aide rapide. Comme la classe KQuickHelp fait partie de la bibliothèque KDE-UI, il devrait déjà être utilisé par votre application ; sinon, ajoutez kdeui à l'option d'édition de lien de votre projet.

Voici un exemple :

 KQuickHelp::add( yourwidget, i18n("your Tip") );

qui est strictement identique à l'utilisation de QToolTip. Lors de la construction d'une boîte de dialogue avec l'éditeur de boîtes de dialogue de KDevelop, ajoutez vos bulles d'aide et votre aide rapide dans le fichier d'implantation - PAS dans le fichier source car il est reconstruit par l'éditeur de boîtes de dialogues à chaque fois que vous éditez le widget.

La classe KQuickHelp permet aussi de formater du texte en utilisant des balises (NdT : tags). Elle autorise aussi les hyperliens, tels que les protocoles Internet, les couleurs et les types et tailles de police. Consultez KDE Library Reference Guide et la documentation de la classe pour plus d'informations sur KQuickTip.