Keys QML Type

Proporciona el manejo de llaves a los elementos. Más...

• Lista de todos los miembros, incluidos los heredados

Propiedades

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

Señales

• 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)

Descripción detallada

Todas las primitivas visuales soportan el manejo de teclas a través del tipo de conexión Keys. Las teclas pueden manejarse mediante las propiedades de señal onPressed y onReleased.

Las propiedades de señal tienen un parámetro KeyEvent, llamado event, que contiene detalles del evento. Si se maneja una tecla, event.accepted debe establecerse en true para evitar que el evento se propague por la jerarquía de elementos.

Ejemplo de uso

El siguiente ejemplo muestra cómo se puede utilizar el manejador general onPressed para comprobar una determinada tecla; en este caso, la tecla izquierda del cursor:

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

Algunas teclas pueden manejarse alternativamente a través de propiedades de señal específicas, por ejemplo onSelectPressed. Estos manejadores establecen automáticamente event.accepted a true.

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

Consulte Qt.Key para ver la lista de códigos de teclado.

Prioridades de manejo de teclas

El tipo de adjunto Keys puede configurarse para manejar eventos de teclado antes o después del elemento al que está adjunto. Esto hace posible interceptar eventos para anular el comportamiento por defecto de un ítem, o actuar como un fallback para teclas no manejadas por el ítem.

Si priority es Keys.BeforeItem (por defecto) el orden de procesamiento de los eventos de teclas es:

1. Elementos especificados en forwardTo
2. manejadores de teclas específicos, por ejemplo, onReturnPressed
3. manejadores onPressed, onReleased
4. Gestión de teclas específicas de cada elemento, por ejemplo, TextInput.
5. elemento principal

Si la prioridad es Keys.AfterItem el orden de procesamiento de eventos clave es:

1. Gestión de teclas específicas del elemento, por ejemplo, TextInput gestión de teclas
2. Elementos especificados en forwardTo
3. manipuladores de teclas específicos, p. ej. onReturnPressed
4. onPressed, onReleased
5. elemento principal

Si se acepta el evento durante cualquiera de los pasos anteriores, se detiene la propagación de teclas.

Véase también KeyEvent y KeyNavigation attached property.

Documentación de propiedades

enabled : bool

Esta bandera habilita el manejo de teclas si es true (por defecto); en caso contrario no se llamará a ningún manejador de teclas.

forwardTo : list<Item> [read-only]

Esta propiedad proporciona una forma de reenviar pulsaciones de teclas, soltar teclas y entradas de teclado procedentes de métodos de entrada a otros elementos. Esto puede ser útil cuando se desea que un elemento maneje algunas teclas (por ejemplo, las teclas de flecha arriba y abajo), y otro elemento maneje otras teclas (por ejemplo, las teclas de flecha izquierda y derecha). Una vez que un elemento al que se le han reenviado teclas acepta el evento, ya no se reenvía a elementos posteriores de la lista.

Este ejemplo reenvía eventos de teclas a dos listas:

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

Para ver el orden en que se reciben los eventos cuando se utiliza forwardTo, consulte Key Handling Priorities.

priority : enumeration

Esta propiedad determina si las claves se procesan antes o después de la gestión de claves del elemento adjunto.

Véase también Key Handling Priorities.

Documentación de señales

asteriskPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado el asterisco '*'. El parámetro event proporciona información sobre el evento.

backPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Atrás. El parámetro event proporciona información sobre el evento.

backtabPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la combinación de teclas Shift+Tab (Backtab). El parámetro event proporciona información sobre el evento.

callPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Llamar. El parámetro event proporciona información sobre el evento.

cancelPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Cancelar. El parámetro event proporciona información sobre el evento.

context1Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Context1. El parámetro event proporciona información sobre el evento.

context2Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Context2. El parámetro event proporciona información sobre el evento.

context3Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Context3. El parámetro event proporciona información sobre el evento.

context4Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Context4. El parámetro event proporciona información sobre el evento.

deletePressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Supr. El parámetro event proporciona información sobre el evento.

digit0Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado el dígito "0". El parámetro event proporciona información sobre el evento.

digit1Pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado el dígito "1". El parámetro event proporciona información sobre el evento.

digit2Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "2". El parámetro event proporciona información sobre el evento.

digit3Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "3". El parámetro event proporciona información sobre el evento.

digit4Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "4". El parámetro event proporciona información sobre el evento.

digit5Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "5". El parámetro event proporciona información sobre el evento.

digit6Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "6". El parámetro event proporciona información sobre el evento.

digit7Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "7". El parámetro event proporciona información sobre el evento.

digit8Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "8". El parámetro event proporciona información sobre el evento.

digit9Pressed(KeyEvent event)

Esta señal se emite cuando se pulsa la cifra "9". El parámetro event proporciona información sobre el evento.

downPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la flecha hacia abajo. El parámetro event proporciona información sobre el evento.

enterPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Intro. El parámetro event proporciona información sobre el evento.

escapePressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Escape. El parámetro event proporciona información sobre el evento.

flipPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Flip. El parámetro event proporciona información sobre el evento.

hangupPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Colgar. El parámetro event proporciona información sobre el evento.

leftPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la flecha izquierda. El parámetro event proporciona información sobre el evento.

menuPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la tecla Menú. El parámetro event proporciona información sobre el evento.

noPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla No. El parámetro event proporciona información sobre el evento.

pressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado una tecla. El parámetro event proporciona información sobre el evento.

released(KeyEvent event)

Esta señal se emite cuando se suelta una tecla. El parámetro event proporciona información sobre el evento.

returnPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Retorno. El parámetro event proporciona información sobre el evento.

rightPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la flecha derecha. El parámetro event proporciona información sobre el evento.

selectPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la tecla Seleccionar. El parámetro event proporciona información sobre el evento.

shortcutOverride(KeyEvent event)

Esta señal se emite cuando se ha pulsado una tecla que potencialmente podría utilizarse como atajo de teclado. El parámetro event proporciona información sobre el evento.

Establezca event.accepted en true si desea evitar que la tecla pulsada sea utilizada como atajo por otros tipos, como Shortcut. Por ejemplo:

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")
}

Al igual que con las otras señales, shortcutOverride sólo se emitirá para un elemento si ese elemento tiene activeFocus.

Véase también Shortcut.

spacePressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Espacio. El parámetro event proporciona información sobre el evento.

tabPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la tecla Tabulador. El parámetro event proporciona información sobre el evento.

upPressed(KeyEvent event)

Esta señal se emite cuando se pulsa la flecha hacia arriba. El parámetro event proporciona información sobre el evento.

volumeDownPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla BajarVolumen. El parámetro event proporciona información sobre el evento.

volumeUpPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Subir Volumen. El parámetro event proporciona información sobre el evento.

yesPressed(KeyEvent event)

Esta señal se emite cuando se ha pulsado la tecla Sí. El parámetro event proporciona información sobre el evento.