Guide de déploiement

Présentation

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

Déploiement

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

Dépendances

Pour en savoir plus, consultez la section Déploiement des bibliothèques Qt.

Méthode d'intégration

Qt Virtual Keyboard Prend actuellement en charge deux méthodes d'intégration alternatives pour l'utilisation du plugin :

• Desktop: ne nécessite aucune modification des applications existantes. Le clavier virtuel est disponible pour toutes les applications Qt du système.

  Avec cette méthode d'intégration, le clavier s'affiche dans une fenêtre dédiée de premier plan.

• Application: le clavier virtuel est intégré directement dans l'application Qt elle-même en instanciant un élément « InputPanel » dans QML.

  Cette méthode est obligatoire dans les environnements ne prenant pas en charge plusieurs fenêtres de premier niveau (tels que les appareils embarqués), mais peut également être utilisée dans les applications de bureau.

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

La méthode d’intégration est automatiquement sélectionnée par les fichiers de projet. Cependant, dans les environnements de bureau, il est possible de remplacer la méthode d’intégration au bureau par la méthode d’intégration à l’application, soit en utilisant la variable d’environnement ` QT_VIRTUALKEYBOARD_DESKTOP_DISABLE `, soit 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’exemple «Qt 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 sous forme de fenêtre au sein d’une session X11.

1. Lancez 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 d'exécuter l'application cliente, assurez-vous que la variable QT_IM_MODULE n'est pas définie :

   unset QT_IM_MODULE

3. Lancez l'exemple Line Edits en tant que client :

   ./lineedits -platform wayland

4. Cliquez sur un champ de saisie et le panneau de saisie d'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 des informations de débogage permettant de 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 au bureau, cette étape suffit pour utiliser Qt Virtual Keyboard. Dans la méthode d’intégration à l’application, celle-ci 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 d’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 situé à côté du conteneur d’application. Il est important de ne pas placer le panneau de saisie à l’intérieur du conteneur d’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 hauteur/largeur du panneau de saisie est constant.

Paramètres du plugin

Certains paramètres peuvent être spécifiés en les ajoutant à la valeur de l’ QT_IM_MODULE (après deux points), par exemple QT_IM_MODULE=qtvirtualkeyboard:wordCandidateListVisible. Certains paramètres sont des paires clé-valeur séparées par "=".

Variables d'environnement

Le module définit plusieurs variables d'environnement, répertoriées ci-dessous :