L'environnement de bureau K

Chapitre 8. Fonctions d'Aide

Une partie très importante du processus de développement est de fournir des fonctionnalités d'aide à l'utilisateur, là où c'est possible. La plupart des développeurs ont tendance à reporter cela mais vous devez vous souvenir qu'un utilisateur normal n'est pas forcément un expert d'Unix. Il peut très bien venir du côté sombre des logiciels, là où l'utilisation est parsemée de douceurs qui permettent à l'utilisateur d'utiliser une application sans même toucher à une seule page du manuel. C'est pourquoi les bibliothèques de KDE et Qt fournissent tous les moyens permettant d'ajouter des fonctions d'aide prêtes à l'emploi qui rendront votre application professionnelle. Dans l'application, ces fonctions sont :

En plus, l'application devrait fournir un accès direct à la documentation en ligne au format HTML en appuyant sur la touche standard d'aide F1. Comme KDevelop propose aussi toutes sortes d'aides, et que les applications KDE générées par l'assistant d'application contiennent déjà le support pour cela, ce chapitre vous aidera à trouver où et comment ajouter des fonctions d'aide.

Pendant le développement de votre application, vous devriez essayer d'être homogène dans tout ce que vous faites ; c'est pourquoi, vous devez prendre les mesures nécessaires directement pendant l'extension du code. Cela vous empêchera de plonger à nouveau dans le code et de chercher à comprendre ce que fait votre application ou ce que vous sous-entendiez par certains morceaux de code.

8.1. Bulles d'aide

Les bulles d'aide sont une façon très simple de donner de l'aide. Ce sont de petits messages d'aide qui s'affichent lorsque l'utilisateur déplace sa souris sur un widget qui fournit une bulle d'aide et disparaît lorsque la souris s'en va. L'utilisation la plus habituelle des bulles d'aide est dans les barres d'outils , où vos bulles d'aide devraient être aussi petites que possible, car les barres d'outils peuvent être configurées pour afficher leur contenu de différentes façons : en affichant le bouton seul, en affichant le bouton avec le texte sur la droite, le bouton avec le texte en-dessous ou seulement le texte. Cette possibilité devrait être configurable par l'utilisateur mais ce n'est pas une obligation. Dans tous les cas, le texte est affiché comme une bulle d'aide et une barre d'outils est généralement constituée de boutons et d'autres widgets comme les zones de saisie et les listes déroulantes. Pour une référence complète, consultez la référence de la classe KToolBar située dans la bibliothèque KDE-UI.

À titre d'exemple, nous allons considérer le bouton "Nouveau fichier" d'une application générique& ;:

 toolBar()->insertButton(Icon("filenew.xpm"), ID_FILE_NEW, true, i18n("New File") );

Ici, la partie i18n("New File") définit le message de la bulle d'aide. Il est entouré par la macro i18n() fournie par kapp.h pour traduire la bulle d'aide dans la langue actuellement sélectionnée.

Les bulles d'aide peuvent aussi être ajoutées à n'importe quel widget personnalisé en utilisant les classes QToolTip et QToolTipGroup fournies par Qt . Voici un exemple d'utilisation :

 QToolTip::add( yourwidget, i18n("your Tip") );
Pour plus d'informations, consultez le Manuel de Référence de Qt , classe QToolTip.