QShortcut

La classe QShortcut est utilis�e pour cr�er des raccourcis clavier. Plus d'informations...

#include <QShortcut>

Voir la position dans l'arbre des classes.

H�ritage

H�rite de QObject.

Description d�taill�e

La classe QShortcut est utilis�e pour cr�er des raccourcis clavier. Elle fournit un moyen de connecter des raccourcis clavier au m�canisme de signaux et slots de Qt, de sorte que les objets peuvent �tre inform�s quand une combinaison de touches d'un raccourci est enfonc�e. Le raccourci peut �tre mis en place pour contenir toutes les touches n�cessaires � la description d'un raccourci clavier, y compris les �tats des touches de modification telles que Shift, Ctrl et Alt.

Sur certains widgets, utiliser & devant un caract�re cr�e automatiquement un raccourci pour celui-ci. Par exemple  »&Quitter » cr�e un raccourci Alt+Q (utiliser && pour afficher une esperluette). Le widget peut consommer et effectuer une action sur un raccourci. Sur X11, l'esperluette ne sera pas affich�e, et le caract�re sera soulign�. Sur Windows, les raccourcis ne sont normalement pas affich�s jusqu'� ce que l'utilisateur presse la touche Alt, mais ceci est un param�tre que l'utilisateur peut changer. Sur Mac, les raccourcis sont d�sactiv�s par d�faut. Appelez qt_set_sequence_auto_mnemonic() pour les activer. Cependant, �tant donn� que les raccourcis mn�motechniques ne rentrent pas dans les lignes directrices d'Aqua, Qt ne soulignera pas le caract�re du raccourci.

Pour les applications qui utilisent des menus, il peut �tre plus pratique d'utiliser les fonctions pr�vues dans la classe QMenu pour assigner des raccourcis clavier � des �l�ments du menu lors de leur cr�ation. Par ailleurs, les raccourcis peuvent �tre associ�s � d'autres types d'actions dans la classe QAction.

Le plus simple pour cr�er un raccourci pour un widget particulier est de le construire avec une s�quence de touches. Par exemple :

raccourci = new QShortcut(QKeySequence(tr(Ctrl+O, Ouvrir un fichier)),
                          parent);

Quand l'utilisateur tape la s�rie de touches pour un raccourci, le signal activated() de la classe est �mis (en le cas d'ambigu�t�, le signal activatedAmbiguously() est �mis). Un raccourci est per�u par la boucle �v�nementielle de Qt au moment o� le raccourci du widget parent re�oit les �v�nements.

Une s�quence de touches de raccourci peut �tre d�finie avec setKey() et r�cup�r�e avec key(). Un raccourci peut �tre activ� ou d�sactiv� avec setEnabled() et peut avoir un texte d'aide « What's This? » d�fini par setWathsThis().

Voir aussi QShortcutEvent, QKeySequence et QAction.

Propri�t�s

autoRepeat : bool

Cette propri�t� indique si le raccourci peut se r�p�ter automatiquement.

Si true, le raccourci est automatiquement r�p�t� quand la combinaison du raccourci clavier est effectu�e, � condition que l'auto-r�p�tition du clavier soit activ�e sur le syst�me. La valeur par d�faut est true.

Cette propri�t� a �t� introduite � partir de Qt 4.2.

Fonctions d'acc�s

bool autoRepeat () const
void setAutoRepeat ( bool on )

context : Qt::ShortcutContext

Cette propri�t� indique le contexte dans lequel le raccourci est valide.

Un contexte de raccourci d�cide dans quelle circonstance un raccourci est autoris� � �tre d�clench�. Le contexte par d�faut est Qt::WindowShortcut, qui permet au raccourci d'�tre d�clench� si le parent (le widget qui contient le raccourci) est un sous-widget de la fen�tre active au premier plan.

Par d�faut, cette propri�t� est �gale � Qt::WindowShortcut.

Fonctions d'acc�s

Qt::ShortcutContext context ()
void setContext ( Qt::ShortcutContext context )

enabled : bool

Cette propri�t� indique si le raccourci est activ�.

L'activation d'un raccourci �met les signaux activated() ou activatedAmbiguously() quand un QShortcutEvent qui correspond � la s�quence key() du raccourci est press�.

Si l'application est en mode WhatsThis, le raccourci n'�mettra pas les signaux, mais affichera le texte de la propri�t� « What's This? » � la place.

Par d�faut, cette propri�t� vaut true.

Fonctions d'acc�s

bool isEnabled () const
void setEnabled ( bool enable )

Voir aussi whatsThis.

key : QKeySequence

Cette propri�t� contient la s�quence de touches du raccourci.

Il s'agit d'une s�quence de touches avec une combinaison optionnelle de Shift, Ctrl et Alt. La s�quence de touches peut �tre fournie de diff�rentes fa�ons :

setKey(0);                       // aucun signal �mis
setKey(QKeySequence());          // aucun signal �mis
setKey(0x3b1);                   // la lettre grecque Alpha 
setKey(Qt::Key_D);               // 'd', pour par exemple supprimer 
setKey('q');                     // 'q', pour par exemple quitter
setKey(Qt::CTRL + Qt::Key_P);    // Ctrl+P, pour par exemple imprimer le document 
setKey("Ctrl+P");                // Ctrl+P, pour par exemple imprimer le document

Par d�faut, cette propri�t� contient une s�quence de touches vide.

Fonctions d'acc�s

QKeySequence key () const
void setKey ( const QKeySequence & key )

whatsThis : QString

Cette propri�t� contient le texte d'aide « What's This? » du raccourci.

Le texte sera affich� quand l'application est en mode « What's This? » et que l'utilisateur tape la s�rie de touches key() du raccourci.

Pour d�finir l'aide « What's This? » sur un �l�ment d'un menu (avec ou sans touche de raccourci), d�finissez l'aide sur l'action de l'�l�ment.

Par d�faut, cette propri�t� contient une cha�ne de caract�res vide.

Fonctions d'acc�s

QString whatsThis () const
void setWhatsThis ( const QString & text )

Voir aussi QWhatsThis::inWhatsThisMode() et QAction::setWhatsThis().

Fonctions membres

QShortcut::QShortcut ( QWidget * parent )

Construit un objet QShortcut pour le widget parent. Tant qu'aucun raccourci clavier n'est sp�cifi�, le raccourci n'�mettra aucun signal.

Voir aussi setKey().

QShortcut::QShortcut ( const QKeySequence & key, QWidget * parent, const char * member = 0, const char * ambiguousMember = 0, Qt::ShortcutContext context = Qt::WindowShortcut )

Construit un objet QShortcut pour le widget parent. Le raccourci fonctionne sur son parent, �coutant les QShortcutEvent qui correspondent � la s�quence de touches. En fonction de l'ambigu�t� de l'�v�nement, le raccourci appellera la fonction member ou la fonction ambiguousMember, si la touche press�e �tait dans le context du raccourci.

QShortcut::~QShortcut ()

D�truit le raccourci.

void QShortcut::activated () [signal]

Ce signal est �mis quand l'utilisateur tape la s�quence de touches du raccourci.

Voir aussi activatedAmbiguously().

void QShortcut::activatedAmbiguously () [signal]

Quand une s�quence de touches est bien tap�e sur le clavier, on dit qu'elle est ambigu� dans la mesure o� elle correspond � l'ouverture de plus d'un raccourci.

Quand la s�quence de touches du raccourci est compl�te, activatedAmbiguously() est �mis si la s�quence de touches est toujours ambigu� (c'est-�-dire s'il s'agit du d�but d'un ou de plusieurs autres raccourcis). Le signal activated() n'est pas �mis dans ce cas.

Voir aussi activated().

int QShortcut::id () const

Retourne l'identifiant du raccourci.

Voir aussi QShortcutEvent::shortcutId().

QWidget * QShortcut::parentWidget () const

Retourne le widget parent du raccourci.

Remerciements

Merci � Adrien Dadouchi pour la traduction et � Jonathan Courtois, Thibaut Cuvelier et � Jacques Thery pour leur relecture !