QVirtualKeyboardInputEngine Class
La classe InputEngine fournit un moteur d'entrée qui prend en charge l'intégration C++ et QML. Plus d'informations...
| En-tête : | #include <QVirtualKeyboardInputEngine> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard)target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) |
| qmake : | QT += virtualkeyboard |
| En QML : | InputEngine |
| Héritages : | QObject |
Types publics
| enum class | InputMode { Latin, Numeric, Dialable, Pinyin, Cangjie, …, HiraganaFlick } |
| enum class | PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition } |
| enum class | ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor } |
| flags | ReselectFlags |
| enum class | TextCase { Lower, Upper } |
Propriétés
|
|
Fonctions publiques
| Qt::Key | activeKey() const |
| QVirtualKeyboardInputContext * | inputContext() const |
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| QList<int> | inputModes() const |
| QList<int> | patternRecognitionModes() const |
| Qt::Key | previousKey() const |
(since QtQuick.VirtualKeyboard 2.0) bool | reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags) |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
(since QtQuick.VirtualKeyboard 2.0) QVirtualKeyboardTrace * | traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo) |
| bool | traceEnd(QVirtualKeyboardTrace *trace) |
| void | virtualKeyCancel() |
| bool | virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) |
| bool | virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat) |
| bool | virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) |
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
| bool | wordCandidateListVisibleHint() const |
Signaux
| void | activeKeyChanged(Qt::Key key) |
| void | inputMethodChanged() |
| void | inputMethodReset() |
| void | inputMethodUpdate() |
| void | inputModeChanged() |
| void | inputModesChanged() |
(since QtQuick.VirtualKeyboard 2.0) void | patternRecognitionModesChanged() |
| void | previousKeyChanged(Qt::Key key) |
| void | virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat) |
| void | wordCandidateListModelChanged() |
| void | wordCandidateListVisibleHintChanged() |
Description détaillée
Le moteur de saisie est responsable de l'acheminement des événements de saisie vers les méthodes de saisie. La logique d'entrée proprement dite est mise en œuvre par les méthodes d'entrée.
Le moteur de saisie comprend également la méthode de saisie par défaut, qui prend en charge le traitement par défaut si la méthode de saisie active ne gère pas l'événement.
Documentation sur les types de membres
enum class QVirtualKeyboardInputEngine::InputMode
Cette énumération spécifie le mode d'entrée pour la méthode d'entrée.
| Constante | Valeur | Description |
|---|---|---|
QVirtualKeyboardInputEngine::InputMode::Latin | 0 | Mode de saisie par défaut pour le texte latin. |
QVirtualKeyboardInputEngine::InputMode::Numeric | 1 | Seule la saisie numérique est autorisée. |
QVirtualKeyboardInputEngine::InputMode::Dialable | 2 | Seule la saisie numérique est autorisée. |
QVirtualKeyboardInputEngine::InputMode::Pinyin | 3 | Mode de saisie Pinyin pour le chinois. |
QVirtualKeyboardInputEngine::InputMode::Cangjie | 4 | Mode de saisie Cangjie pour le chinois. |
QVirtualKeyboardInputEngine::InputMode::Zhuyin | 5 | Mode de saisie Zhuyin pour le chinois. |
QVirtualKeyboardInputEngine::InputMode::Hangul | 6 | Mode de saisie Hangul pour le coréen. |
QVirtualKeyboardInputEngine::InputMode::Hiragana | 7 | Mode de saisie Hiragana pour le japonais. |
QVirtualKeyboardInputEngine::InputMode::Katakana | 8 | Mode de saisie Katakana pour le japonais. |
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin | 9 | Mode d'entrée latin pleine largeur pour les langues d'Asie de l'Est. |
QVirtualKeyboardInputEngine::InputMode::Greek | 10 | Mode de saisie en grec. |
QVirtualKeyboardInputEngine::InputMode::Cyrillic | 11 | Mode de saisie cyrillique. |
QVirtualKeyboardInputEngine::InputMode::Arabic | 12 | Mode de saisie arabe. |
QVirtualKeyboardInputEngine::InputMode::Hebrew | 13 | Mode de saisie en hébreu. |
QVirtualKeyboardInputEngine::InputMode::ChineseHandwriting | 14 | Mode de saisie de l'écriture chinoise. |
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting | 15 | Mode de saisie de l'écriture japonaise. |
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting | 16 | Mode de saisie de l'écriture coréenne. |
QVirtualKeyboardInputEngine::InputMode::Thai | 17 | Mode de saisie en thaïlandais. |
QVirtualKeyboardInputEngine::InputMode::Stroke | 18 | Mode de saisie des traits pour le chinois. |
QVirtualKeyboardInputEngine::InputMode::Romaji | 19 | Mode de saisie Romaji pour le japonais. |
QVirtualKeyboardInputEngine::InputMode::HiraganaFlick | 20 | Mode de saisie Flick pour le japonais. |
enum class QVirtualKeyboardInputEngine::PatternRecognitionMode
Cette énumération spécifie le mode d'entrée pour la méthode d'entrée.
| Constante | Valeur | Description du mode de saisie |
|---|---|---|
QVirtualKeyboardInputEngine::PatternRecognitionMode::None | 0 | La reconnaissance des formes n'est pas disponible. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::PatternRecognitionDisabled | None | obsolete Utiliser PatternRecognitionMode::None |
QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting | 1 | Mode de reconnaissance des formes pour la reconnaissance de l'écriture manuscrite. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginition | Handwriting | obsolete Utilisez PatternRecognitionMode::Handwriting |
enum class QVirtualKeyboardInputEngine::ReselectFlag
flags QVirtualKeyboardInputEngine::ReselectFlags
Cette énumération spécifie les règles de resélection des mots.
| Constante | Valeur | Description |
|---|---|---|
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor | 0x1 | Active le mot précédant le curseur. Lorsque cet indicateur est utilisé exclusivement, le mot doit se terminer exactement au niveau du curseur. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor | 0x2 | Active le mot après le curseur. Lorsque cet indicateur est utilisé exclusivement, le mot doit commencer exactement au niveau du curseur. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursor | WordBeforeCursor | WordAfterCursor | 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. |
Le type ReselectFlags est un typedef pour QFlags<ReselectFlag>. Il stocke une combinaison OU de valeurs ReselectFlag.
enum class QVirtualKeyboardInputEngine::TextCase
Cette énumération spécifie la casse du texte pour la méthode de saisie.
| Constante | Valeur | Description |
|---|---|---|
QVirtualKeyboardInputEngine::TextCase::Lower | 0 | Texte en minuscules. |
QVirtualKeyboardInputEngine::TextCase::Upper | 1 | Texte en majuscules. |
Propriété Documentation
[read-only] activeKey : Qt::Key
Cette propriété contient la touche active.
Touche actuellement enfoncée.
Fonctions d'accès :
| Qt::Key | activeKey() const |
Signal de notification :
| void | activeKeyChanged(Qt::Key key) |
inputMethod : QVirtualKeyboardAbstractInputMethod*
Cette propriété contient la méthode d'entrée active.
Cette propriété permet de définir la méthode d'entrée active ou de surveiller le changement de la méthode d'entrée active.
Fonctions d'accès :
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
Signal de notification :
| void | inputMethodChanged() |
inputMode : InputMode
Cette propriété contient le mode d'entrée actuel.
Utilisez cette propriété pour obtenir ou définir le mode de saisie actuel. Le site InputEngine::inputModes fournit une liste des modes de saisie valides pour la méthode de saisie et la locale actuelles.
Fonctions d'accès :
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
Signal de notification :
| void | inputModeChanged() |
[read-only] inputModes : QList<int>
Cette propriété contient les modes de saisie disponibles pour la méthode de saisie active.
La liste des modes de saisie disponibles dépend de la méthode de saisie et de la locale. Cette propriété est mise à jour lorsque l'une des dépendances change.
Fonctions d'accès :
| QList<int> | inputModes() const |
Signal de notification :
| void | inputModesChanged() |
[read-only, since QtQuick.VirtualKeyboard 2.0] patternRecognitionModes : QList<int>
Cette propriété contient la liste des modes de reconnaissance des formes disponibles.
La liste des modes de reconnaissance des formes disponibles.
Cette propriété a été introduite dans QtQuick.VirtualKeyboard 2.0.
Fonctions d'accès :
| QList<int> | patternRecognitionModes() const |
Signal de notification :
[read-only] previousKey : Qt::Key
Cette propriété contient la touche active précédente.
Touche précédemment enfoncée.
Fonctions d'accès :
| Qt::Key | previousKey() const |
Signal de notification :
| void | previousKeyChanged(Qt::Key key) |
[read-only] wordCandidateListModel : QVirtualKeyboardSelectionListModel*
modèle de liste pour la liste des candidats aux mots.
Cette propriété permet d'accéder au modèle de liste pour la liste de candidats aux mots.
Fonctions d'accès :
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
Signal de notification :
| void | wordCandidateListModelChanged() |
[read-only] wordCandidateListVisibleHint : bool
Indice de visibilité pour la liste des mots candidats.
Utilisez cette propriété pour vérifier si la liste des mots candidats doit être visible dans l'interface utilisateur.
Fonctions d'accès :
| bool | wordCandidateListVisibleHint() const |
Signal du notificateur :
| void | wordCandidateListVisibleHintChanged() |
Fonction membre Documentation
Qt::Key QVirtualKeyboardInputEngine::activeKey() const
Renvoie la clé actuellement active ou Qt::Key_unknown si aucune clé n'est active.
Remarque : fonction d'obtention de la propriété activeKey.
[signal] void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)
Indique que le site actif key a changé.
Note : Signal de notification pour le bien activeKey.
QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const
Renvoie l'instance InputContext associée au moteur d'entrée.
QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const
Renvoie la méthode d'entrée active.
Remarque : fonction Getter pour la propriété inputMethod.
Voir également setInputMethod().
[signal] void QVirtualKeyboardInputEngine::inputMethodChanged()
Indique que la méthode d'entrée a changé.
Note : Signal de notification pour la propriété inputMethod.
[signal] void QVirtualKeyboardInputEngine::inputMethodReset()
Emis lorsque la méthode d'entrée doit être réinitialisée.
Remarque : Ce signal est automatiquement connecté à QVirtualKeyboardAbstractInputMethod::reset() et InputMethod::reset() lorsque la méthode d'entrée est activée.
[signal] void QVirtualKeyboardInputEngine::inputMethodUpdate()
Remarque : Ce signal est automatiquement connecté à QVirtualKeyboardAbstractInputMethod::update() et InputMethod::update() lorsque la méthode d'entrée est activée.
[signal] void QVirtualKeyboardInputEngine::inputModeChanged()
Indique que le mode d'entrée a changé.
Note : Signal de notification pour la propriété inputMode.
QList<int> QVirtualKeyboardInputEngine::inputModes() const
Renvoie la liste des modes d'entrée disponibles.
Remarque : fonction Getter pour la propriété inputModes.
[signal] void QVirtualKeyboardInputEngine::inputModesChanged()
Indique que les modes d'entrée disponibles ont changé.
Note : Signal de notification pour la propriété inputModes.
QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const
Renvoie la liste des modes de reconnaissance des formes pris en charge.
Note : Fonction d'obtention pour la propriété patternRecognitionModes.
[signal, since QtQuick.VirtualKeyboard 2.0] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()
Indique que les modes de reconnaissance des formes disponibles ont changé.
Note : Signal de notification pour la propriété patternRecognitionModes.
Cette fonction a été introduite dans QtQuick.VirtualKeyboard 2.0.
Qt::Key QVirtualKeyboardInputEngine::previousKey() const
Renvoie la clé précédemment active, ou Qt::Key_unknown si aucune clé n'a été active.
Remarque : fonction d'obtention de la propriété previousKey.
[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)
Indique que le précédent key a été modifié.
Note : Signal de notification pour le bien previousKey.
[invokable, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardInputEngine::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
Cette fonction 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.
La fonction renvoie true si le mot a été resélectionné avec succès.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
Cette fonction a été introduite dans QtQuick.VirtualKeyboard 2.0.
void QVirtualKeyboardInputEngine::setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)
Définit inputMethod comme méthode d'entrée active.
Remarque : fonction de définition de la propriété inputMethod.
Voir aussi inputMethod().
[invokable, since QtQuick.VirtualKeyboard 2.0] QVirtualKeyboardTrace *QVirtualKeyboardInputEngine::traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)
Démarre une interaction de trace avec le moteur d'entrée.
La trace est identifiée de manière unique par l'objet traceId. Le moteur de saisie attribue l'identifiant à l'objet QVirtualKeyboardTrace si la méthode de saisie accepte l'événement.
L'objet patternRecognitionMode spécifie le mode de reconnaissance utilisé pour le motif.
Si la méthode d'entrée actuelle accepte l'événement, elle renvoie un objet QVirtualKeyboardTrace associé à cette interaction. Si la méthode d'entrée rejette l'événement, elle renvoie une valeur NULL.
L'objet traceCaptureDeviceInfo fournit des informations sur le dispositif source et l'objet traceScreenInfo fournit des informations sur le contexte de l'écran.
Par définition, l'objet QVirtualKeyboardTrace reste valide jusqu'à ce que la méthode traceEnd() soit appelée.
L'interaction de la trace est terminée par l'appel de la méthode traceEnd().
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
Cette fonction a été introduite dans QtQuick.VirtualKeyboard 2.0.
[invokable] bool QVirtualKeyboardInputEngine::traceEnd(QVirtualKeyboardTrace *trace)
Met fin à l'interaction de la trace avec le moteur d'entrée.
L'objet trace peut être supprimé à tout moment après l'appel de cette fonction.
La fonction renvoie true si l'interaction de trace a été acceptée (c'est-à-dire que les événements tactiles ne doivent pas être utilisés à d'autres fins).
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
[invokable] void QVirtualKeyboardInputEngine::virtualKeyCancel()
Rétablit l'état de la touche active sans émettre d'événement de touche. Cette méthode est utile lorsque l'utilisateur abandonne la touche en cours et que l'état de la touche doit être rétabli.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Emet un événement de clic de touche pour les valeurs données key, text et modifiers. Retourne true si l'événement a été accepté par le moteur de saisie.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
[signal] void QVirtualKeyboardInputEngine::virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
Indique que le site virtuel key a été cliqué avec les sites text et modifiers. Le isAutoRepeat indique si l'événement est automatiquement répété lorsque la touche est enfoncée. Ce signal est émis après que la méthode d'entrée a traité l'événement de la touche.
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
Appelé par la couche clavier pour indiquer que key a été pressé, avec les données text et modifiers.
La touche key est définie comme une touche active (touche vers le bas). L'événement touche réel est déclenché lorsque la touche est relâchée par la méthode virtualKeyRelease(). L'événement de pression sur la touche peut être supprimé en appelant virtualKeyCancel().
L'appui sur la touche déclenche également la minuterie de répétition de la touche si repeat est true.
Renvoie true si la touche a été acceptée par ce moteur d'entrée.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
Voir également virtualKeyCancel() et virtualKeyRelease().
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Libère la touche à l'adresse key. La méthode émet un événement clé pour la méthode d'entrée si l'événement n'a pas été généré par un minuteur répétitif. Les adresses text et modifiers sont transmises à la méthode d'entrée.
Retourne true si la clé a été acceptée par le moteur d'entrée.
Remarque : cette fonction peut être invoquée via le système de méta-objets et à partir de QML. Voir Q_INVOKABLE.
© 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.