Guide de déploiement

Vue d'ensemble

Ce document décrit comment déployer et utiliser le plugin Qt Virtual Keyboard avec les applications Qt.

Déploiement

Les différents plugins et fichiers de Qt Virtual Keyboard sont déployés aux endroits suivants :

Dépendances

Pour en savoir plus, consultez la page Déployer les bibliothèques de Qt.

Méthode d'intégration

Qt Virtual Keyboard Qtvkbstylesplugin supporte actuellement deux méthodes d'intégration alternatives pour l'utilisation du plugin :

• DesktopLa première méthode d'intégration est la suivante : elle ne nécessite aucune modification des applications existantes. Le clavier virtuel est disponible pour toutes les applications Qt du système.

  Dans cette méthode d'intégration, le clavier est affiché dans une fenêtre de haut niveau dédiée.

• ApplicationLe clavier virtuel est intégré dans l'application Qt elle-même par l'instanciation d'un élément InputPanel en QML.

  Cette méthode est obligatoire dans les environnements où il n'y a pas de prise en charge de plusieurs fenêtres de premier niveau (tels que les dispositifs embarqués), mais elle peut également être utilisée dans les applications de bureau.

  Cette méthode peut également être utilisée par les compositeurs Qt Wayland afin de fournir un clavier virtuel côté serveur. Voir la section ci-dessous pour plus de détails.

La méthode d'intégration est automatiquement sélectionnée par les fichiers du projet. Cependant, dans les environnements de bureau, il est possible d'ignorer la méthode d'intégration du bureau et d'utiliser la méthode d'intégration de l'application à la place, en utilisant la variable d'environnement QT_VIRTUALKEYBOARD_DESKTOP_DISABLE, ou en ajoutant -no-vkb-desktop à la ligne de commande configure.

Utilisation de Qt Virtual Keyboard avec Qt Wayland

Cette section explique comment utiliser Qt Virtual Keyboard pour interagir avec l'exempleQt Widgets Line Edits en utilisant l'exemple Fancy Compositor comme compositeur.

Nous utiliserons Ubuntu 18.04 pour exécuter l'exemple, en utilisant X11 comme système de fenêtrage. Le compositeur de l'exemple (fancy-compositor) s'ouvrira comme une fenêtre dans une session X11.

1. Démarrez le compositeur :

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

2. Avant de lancer l'application cliente, assurez-vous que QT_IM_MODULE est désactivé :

   unset QT_IM_MODULE

3. Lancez l'exemple d'édition de lignes en tant que client :

   ./lineedits -platform wayland

4. Cliquez sur une modification de ligne et le panneau de saisie de Qt Virtual Keyboard s'ouvrira.

En cas de problème, les variables d'environnement suivantes peuvent être définies lors de l'exécution du compositeur afin d'obtenir une sortie de débogage qui peut aider à diagnostiquer le problème :

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

Chargement du plugin

Dans les deux méthodes d'intégration, l'application doit utiliser la variable d'environnement QT_IM_MODULE pour charger le plugin. Par exemple :

$ QT_IM_MODULE=qtvirtualkeyboard myapp

ou dans la fonction main() :

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

Dans la méthode d'intégration bureautique, cette étape suffit pour utiliser Qt Virtual Keyboard. Dans la méthode d'intégration des applications, l'application doit créer une instance de InputPanel comme expliqué dans le chapitre suivant.

Création d'un InputPanel

L'exemple suivant montre comment créer un InputPanel et comment diviser la zone d'écran avec le conteneur de l'application.

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

Le panneau de saisie doit être un élément frère du conteneur d'application. Il est important de ne pas placer le panneau de saisie dans le conteneur de l'application, car il se superposerait alors au contenu de l'application. De plus, la hauteur du panneau de saisie sera automatiquement mise à jour en fonction de la largeur disponible ; le rapport d'aspect du panneau de saisie est constant.

Variables d'environnement

Plusieurs variables d'environnement définies par le module sont énumérées ci-dessous :