Keys QML Type (Uncreatable)

Fournit la gestion des clés aux éléments. En savoir plus...

Remarque : il s'agit d'un type non créable. Il ne peut pas être instancié dans QML.

• Liste de tous les membres, y compris les membres hérités

Propriétés

• enabled : bool
• forwardTo : list<Item>
• priority : enumeration

Signaux

• asteriskPressed(KeyEvent event)
• backPressed(KeyEvent event)
• backtabPressed(KeyEvent event)
• callPressed(KeyEvent event)
• cancelPressed(KeyEvent event)
• context1Pressed(KeyEvent event)
• context2Pressed(KeyEvent event)
• context3Pressed(KeyEvent event)
• context4Pressed(KeyEvent event)
• deletePressed(KeyEvent event)
• digit0Pressed(KeyEvent event)
• digit1Pressed(KeyEvent event)
• digit2Pressed(KeyEvent event)
• digit3Pressed(KeyEvent event)
• digit4Pressed(KeyEvent event)
• digit5Pressed(KeyEvent event)
• digit6Pressed(KeyEvent event)
• digit7Pressed(KeyEvent event)
• digit8Pressed(KeyEvent event)
• digit9Pressed(KeyEvent event)
• downPressed(KeyEvent event)
• enterPressed(KeyEvent event)
• escapePressed(KeyEvent event)
• flipPressed(KeyEvent event)
• hangupPressed(KeyEvent event)
• leftPressed(KeyEvent event)
• menuPressed(KeyEvent event)
• noPressed(KeyEvent event)
• pressed(KeyEvent event)
• released(KeyEvent event)
• returnPressed(KeyEvent event)
• rightPressed(KeyEvent event)
• selectPressed(KeyEvent event)
• shortcutOverride(KeyEvent event)
• spacePressed(KeyEvent event)
• tabPressed(KeyEvent event)
• upPressed(KeyEvent event)
• volumeDownPressed(KeyEvent event)
• volumeUpPressed(KeyEvent event)
• yesPressed(KeyEvent event)

Description détaillée

Toutes les primitives visuelles prennent en charge la gestion des touches via le type d'attachement « Keys ». Les touches peuvent être gérées via les propriétés de signal « onPressed » et « onReleased ».

Ces propriétés de signal disposent d’un paramètre « KeyEvent » nommé «event», qui contient les détails de l’événement. Lorsqu’une touche est gérée, la valeur de «event.accepted» doit être définie sur «true» pour empêcher l’événement de se propager vers le haut de la hiérarchie des éléments.

Exemple d'utilisation

L'exemple suivant montre comment le gestionnaire général « onPressed » peut être utilisé pour détecter une touche spécifique ; dans ce cas, la touche fléchée gauche :

Item {
    anchors.fill: parent
    focus: true
    Keys.onPressed: (event)=> {
        if (event.key == Qt.Key_Left) {
            console.log("move left");
            event.accepted = true;
        }
    }
}

Certaines touches peuvent également être gérées via des propriétés de signal spécifiques, par exemple ` onSelectPressed`. Ces gestionnaires définissent automatiquement ` event.accepted ` sur `true`.

Item {
    anchors.fill: parent
    focus: true
    Keys.onLeftPressed: console.log("move left")
}

Consultez Qt.Key pour obtenir la liste des codes clavier.

Priorités de gestion des touches

Le type d’attachement Keys peut être configuré pour traiter les événements de touche avant ou après l’élément auquel il est attaché. Cela permet d’intercepter des événements afin de remplacer le comportement par défaut d’un élément, ou de servir de solution de secours pour les touches non gérées par l’élément.

Si priority est défini sur Keys.BeforeItem (par défaut), l’ordre de traitement des événements de touche est le suivant :

1. Éléments spécifiés dans forwardTo
2. des gestionnaires de touches spécifiques, par exemple les gestionnaires onReturnPressed
3. les gestionnaires onPressed et onReleased
4. Gestion des touches spécifique à l’élément, par exemple la gestion des touches « TextInput »
5. l'élément parent

Si la priorité est « Keys.AfterItem », l'ordre de traitement des événements de touche est le suivant :

1. Gestion des touches spécifique à l’élément, par exemple la gestion des touches « TextInput »
2. Éléments spécifiés dans forwardTo
3. des gestionnaires de touches spécifiques, par exemple les gestionnaires onReturnPressed
4. les gestionnaires onPressed et onReleased
5. élément parent

Si l'événement est accepté au cours de l'une des étapes ci-dessus, la propagation des touches s'arrête.

Voir également KeyEvent et KeyNavigation attached property.

Documentation sur les propriétés

enabled : bool

Si cette option est activée (valeur par défaut), elle permet la gestion des touches ; dans le cas contraire, aucun gestionnaire de touches ne sera appelé.

forwardTo : list<Item> [read-only]

Cette propriété permet de rediriger vers d'autres éléments les frappes, les relâchements de touches et les entrées clavier provenant des méthodes de saisie. Cela peut s'avérer utile lorsque vous souhaitez qu'un élément gère certaines touches (par exemple, les touches fléchées haut et bas) et qu'un autre élément gère d'autres touches (par exemple, les touches fléchées gauche et droite). Dès qu'un élément auquel des touches ont été transmises accepte l'événement, celui-ci n'est plus transmis aux éléments suivants de la liste.

Cet exemple transfère les événements de touche vers deux listes :

Item {
    ListView {
        id: list1
        // ...
    }
    ListView {
        id: list2
        // ...
    }
    Keys.forwardTo: [list1, list2]
    focus: true
}

Pour connaître l'ordre dans lequel les événements sont reçus lors de l'utilisation de forwardTo, consultez Key Handling Priorities.

priority : enumeration

Cette propriété détermine si les clés sont traitées avant ou après le traitement des clés propres à l'élément associé.

Voir également Key Handling Priorities.

Documentation sur les signaux

asteriskPressed(KeyEvent event)

Ce signal est émis lorsque la touche « * » d'Asterisk a été enfoncée. Le paramètre event fournit des informations sur cet événement.

backPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Retour » a été enfoncée. Le paramètre event fournit des informations sur l'événement.

backtabPressed(KeyEvent event)

Ce signal est émis lorsque la combinaison de touches Maj+Tab (Backtab) a été actionnée. Le paramètre event fournit des informations sur cet événement.

callPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Appel » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

cancelPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Annuler » a été enfoncée. Le paramètre event fournit des informations sur l'événement.

context1Pressed(KeyEvent event)

Ce signal est émis lorsque la touche Context1 a été enfoncée. Le paramètre event fournit des informations sur l'événement.

context2Pressed(KeyEvent event)

Ce signal est émis lorsque la touche Context2 a été enfoncée. Le paramètre event fournit des informations sur l'événement.

context3Pressed(KeyEvent event)

Ce signal est émis lorsque la touche Context3 a été enfoncée. Le paramètre event fournit des informations sur l'événement.

context4Pressed(KeyEvent event)

Ce signal est émis lorsque la touche Context4 a été enfoncée. Le paramètre event fournit des informations sur l'événement.

deletePressed(KeyEvent event)

Ce signal est émis lorsque la touche Suppr a été enfoncée. Le paramètre event fournit des informations sur l'événement.

digit0Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre « 0 » a été sélectionné. Le paramètre event fournit des informations sur l'événement.

digit1Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre « 1 » a été sélectionné. Le paramètre event fournit des informations sur l'événement.

digit2Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre « 2 » a été sélectionné. Le paramètre event fournit des informations sur l'événement.

digit3Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 3 » a été enfoncée. Le paramètre event fournit des informations sur l'événement.

digit4Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 4 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

digit5Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 5 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

digit6Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 6 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

digit7Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 7 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

digit8Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 8 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

digit9Pressed(KeyEvent event)

Ce signal est émis lorsque la touche « 9 » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

downPressed(KeyEvent event)

Ce signal est émis lorsque la flèche vers le bas a été enfoncée. Le paramètre event fournit des informations sur l'événement.

enterPressed(KeyEvent event)

Ce signal est émis lorsque la touche Entrée est enfoncée. Le paramètre event fournit des informations sur l'événement.

escapePressed(KeyEvent event)

Ce signal est émis lorsque la touche Échap a été enfoncée. Le paramètre event fournit des informations sur l'événement.

flipPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Flip » a été enfoncée. Le paramètre event fournit des informations sur cet événement.

hangupPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Raccrocher » a été enfoncée. Le paramètre event fournit des informations sur l'événement.

leftPressed(KeyEvent event)

Ce signal est émis lorsque la flèche gauche a été actionnée. Le paramètre event fournit des informations sur l'événement.

menuPressed(KeyEvent event)

Ce signal est émis lorsque la touche Menu est enfoncée. Le paramètre event fournit des informations sur l'événement.

noPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Non » a été enfoncée. Le paramètre « event » fournit des informations sur l'événement.

pressed(KeyEvent event)

Ce signal est émis lorsqu'une touche a été enfoncée. Le paramètre event fournit des informations sur l'événement.

released(KeyEvent event)

Ce signal est émis lorsqu'une touche a été relâchée. Le paramètre event fournit des informations sur l'événement.

returnPressed(KeyEvent event)

Ce signal est émis lorsque la touche Entrée a été enfoncée. Le paramètre event fournit des informations sur l'événement.

rightPressed(KeyEvent event)

Ce signal est émis lorsque la flèche droite a été actionnée. Le paramètre event fournit des informations sur l'événement.

selectPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Select » a été enfoncée. Le paramètre « event » fournit des informations sur l'événement.

shortcutOverride(KeyEvent event)

Ce signal est émis lorsqu'une touche susceptible d'être utilisée comme raccourci a été enfoncée. Le paramètre ` event ` fournit des informations sur l'événement.

Définissez ` event.accepted ` sur ` true ` si vous souhaitez empêcher que la touche enfoncée soit utilisée comme raccourci par d’autres types, tels que ` Shortcut`. Par exemple :

Item {
    id: escapeItem
    focus: true

    // Ensure that we get escape key press events first.
    Keys.onShortcutOverride: (event)=> event.accepted = (event.key === Qt.Key_Escape)

    Keys.onEscapePressed: {
        console.log("escapeItem is handling escape");
        // event.accepted is set to true by default for the specific key handlers
    }
}

Shortcut {
    sequence: "Escape"
    onActivated: console.log("Shortcut is handling escape")
}

Comme pour les autres signaux, shortcutOverride ne sera émis pour un élément que si celui-ci dispose de activeFocus.

Voir également Shortcut.

spacePressed(KeyEvent event)

Ce signal est émis lorsque la touche Espace est enfoncée. Le paramètre event fournit des informations sur l'événement.

tabPressed(KeyEvent event)

Ce signal est émis lorsque la touche Tab est enfoncée. Le paramètre ` event ` fournit des informations sur l'événement.

upPressed(KeyEvent event)

Ce signal est émis lorsque la flèche vers le haut a été enfoncée. Le paramètre event fournit des informations sur l'événement.

volumeDownPressed(KeyEvent event)

Ce signal est émis lorsque la touche « VolumeDown » a été enfoncée. Le paramètre event fournit des informations sur l'événement.

volumeUpPressed(KeyEvent event)

Ce signal est émis lorsque la touche « VolumeUp » a été enfoncée. Le paramètre « event » fournit des informations sur l'événement.

yesPressed(KeyEvent event)

Ce signal est émis lorsque la touche « Oui » a été enfoncée. Le paramètre event fournit des informations sur l'événement.