Sur cette page

InputMethod QML Type

Type de base pour la création d'une méthode d'entrée en QML. Plus d'informations...

Import Statement: import QtQuick.VirtualKeyboard

Propriétés

Signaux

Méthodes

Description détaillée

Le type InputMethod vous permet de créer une méthode d'entrée personnalisée qui peut être assignée à InputEngine.

Documentation de la propriété

inputContext : InputContext [read-only]

Le contexte d'entrée.

inputEngine : InputEngine [read-only]

Le moteur d'entrée.

Documentation sur les signaux

selectionListActiveItemChanged(int type, int index)

La méthode d'entrée émet ce signal lorsque la valeur courante de index a changé dans la liste de sélection identifiée par type.

Note : Le gestionnaire correspondant est onSelectionListActiveItemChanged.

selectionListChanged(int type)

La méthode d'entrée émet ce signal lorsque le contenu de la liste de sélection est modifié. Le paramètre type indique la liste de sélection qui a été modifiée.

Remarque : le gestionnaire correspondant est onSelectionListChanged.

[since QtQuick.VirtualKeyboard 2.2] selectionListsChanged()

La méthode input émet ce signal lorsque les types de la liste de sélection ont changé. Ce signal déclenche un appel à la méthode selectionLists(), ce qui permet à la méthode input de mettre à jour les types de la liste de sélection.

Note : Le gestionnaire correspondant est onSelectionListsChanged.

Ce signal a été introduit dans QtQuick.VirtualKeyboard 2.2.

Documentation de la méthode

[since QtQuick.VirtualKeyboard 2.4] bool clickPreeditText(int cursorPosition)

Appelée lorsque l'utilisateur clique sur le texte pré-édité à l'adresse cursorPosition.

La fonction doit renvoyer true si elle gère l'événement. Sinon, l'entrée est renvoyée à reselect() pour un traitement ultérieur.

Cette méthode a été introduite dans QtQuick.VirtualKeyboard 2.4.

list<int> inputModes(string locale)

Renvoie une liste de modes d'entrée pour locale.

bool keyEvent(int key, string text, int modifiers)

L'objectif de cette méthode est de gérer les événements de clé générés par le moteur de saisie.

Le paramètre key spécifie le code de la clé à gérer. Le code de la clé ne fait pas de distinction entre les lettres majuscules et non majuscules. Le paramètre text contient le texte Unicode de la clé. Le paramètre modifiers contient les modificateurs de clé qui s'appliquent à key.

Cette méthode renvoie true si l'événement clé a été traité avec succès. Si la valeur de retour est false, l'événement clé est redirigé vers la méthode d'entrée par défaut pour la suite du traitement.

[since QtQuick.VirtualKeyboard 2.0] list<int> patternRecognitionModes()

Renvoie la liste des modes de reconnaissance des formes pris en charge.

Cette méthode est invoquée par le moteur de saisie pour demander la liste des modes de reconnaissance des formes pris en charge.

Cette méthode a été introduite dans QtQuick.VirtualKeyboard 2.0.

[since QtQuick.VirtualKeyboard 2.0] bool reselect(int cursorPosition, int reselectFlags)

Cette méthode tente de resélectionner un mot situé à l'adresse cursorPosition. L'adresse reselectFlags définit les règles de sélection du mot par rapport à la position du curseur.

  • InputEngine.WordBeforeCursor Activer le mot avant le curseur. Lorsque ce drapeau est utilisé exclusivement, le mot doit se terminer exactement au niveau du curseur.
  • InputEngine.WordAfterCursor Activer le mot après le curseur. Lorsque cet indicateur est utilisé exclusivement, le mot doit commencer exactement au niveau du curseur.
  • InputEngine.WordAtCursor Activer le mot au niveau du curseur. Cet indicateur est une combinaison des indicateurs précédents, à l'exception du fait que le mot ne peut pas commencer ou s'arrêter au niveau du curseur.

La méthode renvoie true si le mot a été resélectionné avec succès.

Cette méthode a été introduite dans QtQuick.VirtualKeyboard 2.0.

void reset()

Cette méthode est appelée par le moteur de saisie lorsque cette méthode de saisie doit être réinitialisée. La méthode d'entrée doit uniquement réinitialiser son état interne. La principale différence avec la méthode update() est que reset() ne modifie que l'état de la méthode d'entrée ; elle ne doit pas modifier le contexte d'entrée.

var selectionListData(int type, int index, int role)

Renvoie les données d'un élément d'une liste de sélection identifiée par type. Le paramètre role spécifie les données demandées. Le paramètre index est un index basé sur zéro dans la liste de sélection.

int selectionListItemCount(int type)

Renvoie le nombre d'éléments de la liste de sélection identifiée par type.

void selectionListItemSelected(int type, int index)

Cette méthode est appelée lorsque l'utilisateur a sélectionné un élément à l'adresse index. La liste de sélection est identifiée par le paramètre type.

list<int> selectionLists()

Renvoie la liste des types de sélection utilisés pour cette méthode de saisie.

Cette méthode est appelée par le moteur de saisie lorsque la méthode de saisie est activée et à chaque fois que les indices de la méthode de saisie sont mis à jour. La méthode de saisie peut réserver des listes de sélection en renvoyant les types de listes de sélection souhaités.

La méthode d'entrée peut demander au moteur d'entrée de mettre à jour les listes de sélection à tout moment en émettant le signal selectionListsChanged(). Ce signal déclenche un appel à cette méthode, ce qui permet à la méthode de saisie de mettre à jour les types de listes de sélection.

bool setInputMode(string locale, int inputMode)

Modifie inputMode et locale pour cette méthode d'entrée. La méthode renvoie true en cas de succès.

bool setTextCase(int textCase)

Met à jour textCase pour cette méthode d'entrée. La méthode renvoie true en cas de succès.

Les valeurs possibles pour la casse du texte sont les suivantes :

  • InputEngine.Lower Texte en minuscules.
  • InputEngine.Upper Texte en majuscules.

[since QtQuick.VirtualKeyboard 2.0] Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)

Cette méthode est appelée lorsqu'une interaction de traçage commence avec l'adresse patternRecognitionMode spécifiée. La trace est identifiée de manière unique par traceId. traceCaptureDeviceInfo fournit des informations sur le périphérique source et traceScreenInfo fournit des informations sur le contexte de l'écran.

Si la méthode d'entrée accepte l'événement et souhaite capturer l'entrée de la trace, elle doit renvoyer un nouvel objet Trace. Cet objet doit rester valide jusqu'à ce que la méthode InputMethod.traceEnd() soit appelée. Si la trace est affichée à l'écran, elle y reste jusqu'à ce que l'objet Trace soit détruit.

Cette méthode a été introduite dans QtQuick.VirtualKeyboard 2.0.

[since QtQuick.VirtualKeyboard 2.0] bool traceEnd(Trace trace)

Cette méthode est appelée lorsque l'interaction de la trace se termine. La méthode de saisie doit détruire l'objet trace à un moment donné après l'appel de cette fonction. Retourne true en cas de succès.

Voir l'API Trace pour les méthodes d'entrée pour savoir comment accéder aux données recueillies.

Cette méthode a été introduite dans QtQuick.VirtualKeyboard 2.0.

void update()

Cette méthode est appelée par le moteur de saisie lorsque la méthode de saisie doit être mise à jour. La méthode de saisie doit fermer le texte en cours de pré-édition et rétablir l'état interne par défaut.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.