QWhatsThis Class

Description détaillée

L'aide "Qu'est-ce que c'est ?" fait partie du système d'aide en ligne d'une application et fournit aux utilisateurs des informations sur la fonctionnalité et l'utilisation d'un widget particulier. Les textes de l'aide "What's This ?" sont généralement plus longs et plus détaillés que tooltips, mais fournissent généralement moins d'informations que celles fournies par des fenêtres d'aide séparées.

QWhatsThis fournit une fenêtre unique avec un texte explicatif qui s'affiche lorsque l'utilisateur demande "Qu'est-ce que c'est ? Par défaut, l'utilisateur pose la question en plaçant le curseur sur le widget concerné et en appuyant sur les touches Maj+F1. Le texte d'aide apparaît immédiatement ; il disparaît dès que l'utilisateur fait autre chose. (Notez que s'il existe un raccourci pour Shift+F1, ce mécanisme ne fonctionnera pas). Certaines boîtes de dialogue proposent un bouton " ?" sur lequel l'utilisateur peut cliquer pour passer en mode "Qu'est-ce que c'est ?"; il clique alors sur le widget approprié pour faire apparaître la fenêtre "Qu'est-ce que c'est ? Il est également possible de prévoir une option de menu ou un bouton de barre d'outils pour passer en mode "Qu'est-ce que c'est ?

Pour ajouter du texte "Qu'est-ce que c'est ?" à un widget ou à une action, il suffit d'appeler QWidget::setWhatsThis() ou QAction::setWhatsThis().

Le texte peut être du texte enrichi ou du texte simple. Si vous spécifiez une chaîne de texte riche formatée, elle sera rendue à l'aide de la feuille de style par défaut, ce qui permet d'intégrer des images dans le texte affiché. Pour être aussi rapide que possible, la feuille de style par défaut utilise une méthode simple pour déterminer si le texte peut être rendu en tant que texte brut. Voir Qt::mightBeRichText() pour plus de détails.

newAct = new QAction(tr("&New"), this);
newAct->setShortcut(tr("Ctrl+N"));
newAct->setStatusTip(tr("Create a new file"));
newAct->setWhatsThis(tr("Click this option to create a new file."));

Une autre façon d'entrer dans le mode "Qu'est-ce que c'est ?" est d'appeler createAction() et d'ajouter l'adresse QAction renvoyée à un menu ou à une barre d'outils. En invoquant cette action d'aide contextuelle (dans l'image ci-dessous, le bouton avec la flèche et le point d'interrogation), l'utilisateur passe en mode "Qu'est-ce que c'est ? S'il clique sur un widget, le texte d'aide approprié s'affiche. L'utilisateur quitte le mode lorsqu'il obtient de l'aide ou lorsqu'il appuie sur la touche Echap.

Vous pouvez entrer dans le mode "Qu'est-ce que c'est ?" par programmation avec enterWhatsThisMode(), vérifier le mode avec inWhatsThisMode() et revenir au mode normal avec leaveWhatsThisMode().

Si vous souhaitez contrôler manuellement le comportement "What's This ?" d'un widget, consultez Qt::WA_CustomWhatsThis.

Il est également possible d'afficher différents textes d'aide pour différentes régions d'un widget, en utilisant un QHelpEvent de type QEvent::WhatsThis. Interceptez l'événement d'aide dans la fonction QWidget::event() de votre widget et appelez QWhatsThis::showText() avec le texte que vous souhaitez afficher pour la position spécifiée dans QHelpEvent::pos(). Si le texte est un texte enrichi et que l'utilisateur clique sur un lien, le widget reçoit également un QWhatsThisClickedEvent avec la référence du lien sous la forme QWhatsThisClickedEvent::href(). Si un QWhatsThisClickedEvent est traité (c'est-à-dire que QWidget::event() renvoie un vrai), la fenêtre d'aide reste visible. Appelez QWhatsThis::hideText() pour la masquer explicitement.