Guía de implantación

Visión general de

Este documento describe cómo desplegar y utilizar el plugin Qt Virtual Keyboard con aplicaciones Qt.

Despliegue

Los diferentes plugins y archivos de Qt Virtual Keyboard se despliegan en las siguientes ubicaciones:

Dependencias

Más información en Despliegue de las bibliotecas de Qt.

Método de integración

Qt Virtual Keyboard soporta actualmente dos métodos alternativos de integración para usar el plugin:

• Desktop: no requiere cambios en las aplicaciones existentes. El teclado virtual está disponible para todas las aplicaciones Qt del sistema.

  En este método de integración, el teclado se muestra en una ventana dedicada de nivel superior.

• ApplicationEl teclado virtual se integra en la propia aplicación Qt mediante la instanciación de un elemento InputPanel en QML.

  Este método es obligatorio en entornos donde no hay soporte para múltiples ventanas de nivel superior (como dispositivos embebidos), pero también puede utilizarse en aplicaciones de escritorio.

  Este método también puede ser utilizado por los compositores Qt Wayland Compositor para proporcionar un teclado virtual del lado del servidor. Véase la sección siguiente para más detalles.

El método de integración es seleccionado automáticamente por los archivos de proyecto. Sin embargo, en entornos de escritorio, es posible anular el método de integración del escritorio y utilizar el método de integración de la aplicación en su lugar, utilizando la variable de entorno QT_VIRTUALKEYBOARD_DESKTOP_DISABLE, o añadiendo -no-vkb-desktop a la línea de comandos configure.

Uso de Qt Virtual Keyboard con Qt Wayland

Esta sección explica cómo utilizar Qt Virtual Keyboard para interactuar con el ejemploQt Widgets Line Edits utilizando el ejemplo Fancy Compositor como compositor.

Usaremos Ubuntu 18.04 para ejecutar el ejemplo, usando X11 como sistema de ventanas. El compositor de ejemplo (fancy-compositor) se abrirá como una ventana dentro de una sesión X11.

1. Inicie el compositor:

   QT_XCB_GL_INTEGRATION=xcb_egl QT_WAYLAND_CLIENT_BUFFER_INTEGRATION=xcomposite-egl \
   QT_IM_MODULE=qtvirtualkeyboard ./fancy-compositor -platform xcb

2. Antes de ejecutar la aplicación cliente, asegúrese de que QT_IM_MODULE está deshabilitado:

   unset QT_IM_MODULE

3. Inicie el ejemplo Line Edits como cliente:

   ./lineedits -platform wayland

4. Haga clic en una línea de edición y Qt Virtual Keyboard's panel de entrada se abrirá.

Si se encuentran problemas, las siguientes variables de entorno se pueden establecer cuando se ejecuta el compositor para obtener la salida de depuración que puede ayudar a diagnosticar el problema:

WAYLAND_DEBUG=1
QT_LOGGING_RULES="qt.virtualkeyboard=true;qt.qpa.wayland*=true"

Carga del Plugin

En ambos métodos de integración, la aplicación debe utilizar la variable de entorno QT_IM_MODULE para cargar el plugin. Por ejemplo

$ QT_IM_MODULE=qtvirtualkeyboard myapp

o en la función main():

qputenv("QT_IM_MODULE", QByteArray("qtvirtualkeyboard"));

En el método de integración de escritorio, este paso es todo lo que se requiere para utilizar Qt Virtual Keyboard. En el método de integración de aplicaciones, la aplicación debe crear una instancia de InputPanel como se explica en el capítulo siguiente.

Creación de InputPanel

El siguiente ejemplo muestra cómo crear un InputPanel y cómo dividir el área de la pantalla con el contenedor de la aplicación.

import QtQuick
import QtQuick.VirtualKeyboard

Item {
    id: root
    Item {
        id: appContainer
        anchors.left: parent.left
        anchors.top: parent.top
        anchors.right: parent.right
        anchors.bottom: inputPanel.top
        ...
    }
    InputPanel {
        id: inputPanel
        y: Qt.inputMethod.visible ? parent.height - inputPanel.height : parent.height
        anchors.left: parent.left
        anchors.right: parent.right
    }
}

El panel de entrada debe ser un elemento hermano junto al contenedor de la aplicación. Es importante no poner el panel de entrada dentro del contenedor de la aplicación, ya que entonces se solaparía con el contenido de la aplicación. Además, la altura del panel de entrada se actualizará automáticamente en función de la anchura disponible; la relación de aspecto del panel de entrada es constante.

Variables de entorno

Hay varias variables de entorno definidas por el módulo que se enumeran a continuación: