Keys QML Type

Fournit des informations clés sur les éléments. Plus d'informations...

• 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 clés peuvent être gérées via les propriétés de signal onPressed et onReleased.

Les propriétés de signal ont un paramètre KeyEvent, nommé event, qui contient les détails de l'événement. Si une clé est gérée, la valeur de event.accepted doit être fixée à true pour éviter que l'événement ne se propage dans la hiérarchie des éléments.

Exemple d'utilisation

L'exemple suivant montre comment le gestionnaire général onPressed peut être utilisé pour tester une certaine touche ; dans ce cas, la touche du curseur 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 attribuent automatiquement la valeur true à event.accepted.

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

Voir Qt.Key pour la liste des codes clavier.

Priorités de gestion des touches

Le type d'attachement Keys peut être configuré pour traiter les événements liés aux touches 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 repli pour les touches qui ne sont pas gérées par l'élément.

Si priority est Keys.BeforeItem (valeur par défaut), l'ordre de traitement des événements clés est le suivant :

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

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

1. Gestion des clés spécifiques à l'élément, par exemple TextInput gestion des clés
2. Éléments spécifiés dans forwardTo
3. des gestionnaires de clés spécifiques, par exemple onReturnPressed
4. Gestionnaires onPressed, onReleased
5. élément parent

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

Voir également KeyEvent et KeyNavigation attached property.

Documentation sur les propriétés

enabled : bool

Ce drapeau active la gestion des clés s'il est vrai (par défaut) ; sinon, aucun gestionnaire de clés ne sera appelé.

forwardTo : list<Item> [read-only]

Cette propriété permet de transmettre à d'autres éléments les pressions et relâchements de touches, ainsi que les entrées clavier provenant des méthodes d'entrée. Cela peut s'avérer utile lorsque vous souhaitez qu'un élément gère certaines touches (par exemple, les touches de déplacement vers le haut et vers le bas) et qu'un autre élément gère d'autres touches (par exemple, les touches de déplacement vers la gauche et vers la droite). Lorsqu'un élément auquel des touches ont été transmises accepte l'événement, il n'est plus transmis aux éléments situés plus loin dans la liste.

Cet exemple transmet les événements liés aux touches à 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, voir 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 de l'élément attaché.

Voir également Key Handling Priorities.

Documentation sur les signaux

asteriskPressed(KeyEvent event)

Ce signal est émis lorsque l'astérisque "*" a été pressé. Le paramètre event fournit des informations sur l'événement.

backPressed(KeyEvent event)

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

backtabPressed(KeyEvent event)

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

callPressed(KeyEvent event)

Ce signal est émis lorsque la touche Call a été enfoncée. Le paramètre event fournit des informations sur l'é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 Delete a été pressé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é appuyé. Le paramètre event fournit des informations sur l'événement.

digit1Pressed(KeyEvent event)

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

digit2Pressed(KeyEvent event)

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

digit3Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "3" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit4Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "4" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit5Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "5" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit6Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "6" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit7Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "7" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit8Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "8" a été appuyé. Le paramètre event fournit des informations sur l'événement.

digit9Pressed(KeyEvent event)

Ce signal est émis lorsque le chiffre "9" a été appuyé. Le paramètre event fournit des informations sur l'événement.

downPressed(KeyEvent event)

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

enterPressed(KeyEvent event)

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

escapePressed(KeyEvent event)

Ce signal est émis lorsque la touche Escape a été pressé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é pressée. Le paramètre event fournit des informations sur l'événement.

hangupPressed(KeyEvent event)

Ce signal est émis lorsque la touche Raccrocher a été actionné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é pressée. Le paramètre event fournit des informations sur l'événement.

menuPressed(KeyEvent event)

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

noPressed(KeyEvent event)

Ce signal est émis lorsque la touche No a été pressé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 Retour a été pressé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é pressé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é pressée. Le paramètre event fournit des informations sur l'événement.

shortcutOverride(KeyEvent event)

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

Définissez event.accepted à 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 cet élément possède activeFocus.

Voir également Shortcut.

spacePressed(KeyEvent event)

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

tabPressed(KeyEvent event)

Ce signal est émis lorsque la touche Tab a été pressé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é pressé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.