QVirtualKeyboardInputEngine Class
La clase ` InputEngine ` proporciona un motor de entrada que admite la integración con C++ y QML. Más información...
| Encabezado: | #include <QVirtualKeyboardInputEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard) target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) |
| qmake: | QT += virtualkeyboard |
| En QML: | InputEngine |
| Heredan de: | QObject |
Tipos públicos
| 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 } |
Propiedades
|
|
Funciones públicas
| 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 |
Señales
| 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() |
Descripción detallada
El motor de entrada se encarga de dirigir los eventos de entrada a los métodos de entrada. La lógica de entrada propiamente dicha la implementan los métodos de entrada.
El motor de entrada también incluye el método de entrada predeterminado, que se encarga del procesamiento predeterminado si el método de entrada activo no gestiona el evento.
Documentación sobre los tipos de miembros
enum class QVirtualKeyboardInputEngine::InputMode
Esta enumeración especifica el modo de introducción de datos para el método de introducción.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::InputMode::Latin | 0 | El modo de entrada predeterminado para el texto en alfabeto latino. |
QVirtualKeyboardInputEngine::InputMode::Numeric | 1 | Solo se permite la introducción de números. |
QVirtualKeyboardInputEngine::InputMode::Dialable | 2 | Solo se permite la entrada mediante marcación. |
QVirtualKeyboardInputEngine::InputMode::Pinyin | 3 | Modo de entrada Pinyin para chino. |
QVirtualKeyboardInputEngine::InputMode::Cangjie | 4 | Modo de entrada Cangjie para chino. |
QVirtualKeyboardInputEngine::InputMode::Zhuyin | 5 | Modo de entrada Zhuyin para chino. |
QVirtualKeyboardInputEngine::InputMode::Hangul | 6 | Modo de entrada Hangul para coreano. |
QVirtualKeyboardInputEngine::InputMode::Hiragana | 7 | Modo de entrada «Hiragana» para japonés. |
QVirtualKeyboardInputEngine::InputMode::Katakana | 8 | Modo de entrada «Katakana» para japonés. |
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin | 9 | Modo de entrada de caracteres latinos de ancho completo para lenguas del este de Asia. |
QVirtualKeyboardInputEngine::InputMode::Greek | 10 | Modo de entrada griego. |
QVirtualKeyboardInputEngine::InputMode::Cyrillic | 11 | Modo de entrada cirílico. |
QVirtualKeyboardInputEngine::InputMode::Arabic | 12 | Modo de entrada en árabe. |
QVirtualKeyboardInputEngine::InputMode::Hebrew | 13 | Modo de entrada hebreo. |
QVirtualKeyboardInputEngine::InputMode::ChineseHandwriting | 14 | Modo de entrada mediante escritura manuscrita en chino. |
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting | 15 | Modo de entrada por escritura manuscrita en japonés. |
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting | 16 | Modo de entrada mediante escritura manuscrita coreana. |
QVirtualKeyboardInputEngine::InputMode::Thai | 17 | Modo de entrada tailandés. |
QVirtualKeyboardInputEngine::InputMode::Stroke | 18 | Modo de entrada por trazos para chino. |
QVirtualKeyboardInputEngine::InputMode::Romaji | 19 | Modo de entrada «Romaji» para japonés. |
QVirtualKeyboardInputEngine::InputMode::HiraganaFlick | 20 | Modo de entrada «Flick» para japonés. |
enum class QVirtualKeyboardInputEngine::PatternRecognitionMode
Esta enumeración especifica el modo de entrada del método de introducción de texto.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::PatternRecognitionMode::None | 0 | El reconocimiento de patrones no está disponible. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::PatternRecognitionDisabled | None | obsolete Utilice PatternRecognitionMode::None |
QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting | 1 | Modo de reconocimiento de patrones para el reconocimiento de escritura manuscrita. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginition | Handwriting | obsolete Utilice PatternRecognitionMode::Handwriting |
enum class QVirtualKeyboardInputEngine::ReselectFlag
flags QVirtualKeyboardInputEngine::ReselectFlags
Esta enumeración especifica las reglas para la reselección de palabras.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor | 0x1 | Activa la palabra situada antes del cursor. Cuando se utiliza esta bandera de forma exclusiva, la palabra debe terminar exactamente en el cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor | 0x2 | Activa la palabra situada después del cursor. Cuando se utiliza esta bandera de forma exclusiva, la palabra debe comenzar exactamente en el cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursor | WordBeforeCursor | WordAfterCursor | Activa la palabra en la que se encuentra el cursor. Este indicador es una combinación de los indicadores anteriores, con la excepción de que la palabra no puede comenzar ni terminar en el cursor. |
El tipo `ReselectFlags` es un `typedef` para ` QFlags<ReselectFlag>`. Almacena una combinación OR de valores de `ReselectFlag`.
enum class QVirtualKeyboardInputEngine::TextCase
Esta enumeración especifica el tipo de mayúsculas y minúsculas del método de entrada.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::TextCase::Lower | 0 | Texto en minúsculas. |
QVirtualKeyboardInputEngine::TextCase::Upper | 1 | Texto en mayúsculas. |
Documentación de la propiedad
[read-only] activeKey : Qt::Key
Esta propiedad contiene la tecla activa.
Tecla pulsada actualmente.
Funciones de acceso:
| Qt::Key | activeKey() const |
Señal de notificación:
| void | activeKeyChanged(Qt::Key key) |
inputMethod : QVirtualKeyboardAbstractInputMethod*
Esta propiedad contiene el método de entrada activo.
Utiliza esta propiedad para establecer el método de entrada activo o para supervisar cuándo cambia el método de entrada activo.
Funciones de acceso:
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
Señal de notificador:
| void | inputMethodChanged() |
inputMode : InputMode
Esta propiedad contiene el modo de entrada actual.
Utiliza esta propiedad para obtener o establecer el modo de entrada actual. El método « InputEngine::inputModes » proporciona una lista de los modos de entrada válidos para el método de entrada y la configuración regional actuales.
Funciones de acceso:
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
Señal de notificación:
| void | inputModeChanged() |
[read-only] inputModes : QList<int>
Esta propiedad contiene los modos de entrada disponibles para el método de entrada activo.
La lista de modos de entrada disponibles depende del método de entrada y de la configuración regional. Esta propiedad se actualiza cuando cambia cualquiera de estas dependencias.
Funciones de acceso:
| QList<int> | inputModes() const |
Señal de notificación:
| void | inputModesChanged() |
[read-only, since QtQuick.VirtualKeyboard 2.0] patternRecognitionModes : QList<int>
Esta propiedad contiene la lista de modos de reconocimiento de patrones disponibles.
La lista de modos de reconocimiento de patrones disponibles.
Esta enumeración se introdujo en QtQuick.VirtualKeyboard 2.0.
Funciones de acceso:
| QList<int> | patternRecognitionModes() const |
Señal de notificación:
[read-only] previousKey : Qt::Key
Esta propiedad contiene la tecla que se pulsó anteriormente.
Tecla pulsada anteriormente.
Funciones de acceso:
| Qt::Key | previousKey() const |
Señal de notificación:
| void | previousKeyChanged(Qt::Key key) |
[read-only] wordCandidateListModel : QVirtualKeyboardSelectionListModel*
Modelo de lista para la lista de palabras candidatas.
Utilice esta propiedad para acceder al modelo de lista correspondiente a la lista de palabras candidatas.
Funciones de acceso:
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
Señal de notificación:
| void | wordCandidateListModelChanged() |
[read-only] wordCandidateListVisibleHint : bool
Indicador visible de la lista de palabras candidatas.
Utiliza esta propiedad para comprobar si la lista de sugerencias de palabras debe estar visible en la interfaz de usuario.
Funciones de acceso:
| bool | wordCandidateListVisibleHint() const |
Señal de notificador:
| void | wordCandidateListVisibleHintChanged() |
Documentación de la función miembro
Qt::Key QVirtualKeyboardInputEngine::activeKey() const
Devuelve la clave activa en ese momento o ` Qt::Key_unknown ` si no hay ninguna clave activa.
Nota: Funcióngetter para la propiedad activeKey.
[signal] void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)
Indica que la propiedad « key » activa ha cambiado.
Nota: Señalde notificación para la propiedad « activeKey ».
QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const
Devuelve la instancia de ` InputContext ` asociada al motor de entrada.
QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const
Devuelve el método de entrada activo.
Nota: Funcióngetter para la propiedad inputMethod.
Véase también setInputMethod().
[signal] void QVirtualKeyboardInputEngine::inputMethodChanged()
Indica que el método de entrada ha cambiado.
Nota: Señalde notificación para la propiedad « inputMethod ».
[signal] void QVirtualKeyboardInputEngine::inputMethodReset()
Se emite cuando es necesario restablecer el método de entrada.
Nota: Esta señal se conecta automáticamente a QVirtualKeyboardAbstractInputMethod::reset() y InputMethod::reset() cuando se activa el método de entrada.
[signal] void QVirtualKeyboardInputEngine::inputMethodUpdate()
Nota: Esta señal se conecta automáticamente a QVirtualKeyboardAbstractInputMethod::update() y InputMethod::update() cuando se activa el método de entrada.
[signal] void QVirtualKeyboardInputEngine::inputModeChanged()
Indica que el modo de entrada ha cambiado.
Nota: Señalde notificación para la propiedad inputMode.
QList<int> QVirtualKeyboardInputEngine::inputModes() const
Devuelve la lista de modos de entrada disponibles.
Nota: Funcióngetter para la propiedad inputModes.
[signal] void QVirtualKeyboardInputEngine::inputModesChanged()
Indica que los modos de entrada disponibles han cambiado.
Nota: Señalde notificación para la propiedad « inputModes ».
QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const
Devuelve una lista de los modos de reconocimiento de patrones compatibles.
Nota: Funcióngetter para la propiedad patternRecognitionModes.
[signal, since QtQuick.VirtualKeyboard 2.0] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()
Indica que han cambiado los modos de reconocimiento de patrones disponibles.
Nota: Señalde notificación para la propiedad « patternRecognitionModes ».
Esta función se introdujo en QtQuick.VirtualKeyboard 2.0.
Qt::Key QVirtualKeyboardInputEngine::previousKey() const
Devuelve la clave que estaba activa anteriormente o ` Qt::Key_unknown ` si ninguna clave ha estado activa.
Nota: Funcióngetter para la propiedad previousKey.
[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)
Indica que la propiedad « key » anterior ha cambiado.
Nota: Señalde notificador para la propiedad previousKey.
[invokable, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardInputEngine::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
Esta función intenta volver a seleccionar una palabra situada en la posición cursorPosition. El parámetro reselectFlags define las reglas según las cuales se debe seleccionar la palabra en relación con la posición del cursor.
La función devuelve true si la palabra se ha vuelto a seleccionar correctamente.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Esta función se introdujo en QtQuick.VirtualKeyboard 2.0.
void QVirtualKeyboardInputEngine::setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)
Establece « inputMethod » como método de entrada activo.
Nota: Funciónde asignación para la propiedad inputMethod.
Véase también inputMethod().
[invokable, since QtQuick.VirtualKeyboard 2.0] QVirtualKeyboardTrace *QVirtualKeyboardInputEngine::traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)
Inicia una interacción de seguimiento con el motor de entrada.
El seguimiento se identifica de forma única mediante el « traceId ». El motor de entrada asignará el identificador al objeto « QVirtualKeyboardTrace » si el método de entrada acepta el evento.
El objeto ` patternRecognitionMode ` especifica el modo de reconocimiento utilizado para el patrón.
Si el método de entrada actual acepta el evento, devuelve un objeto ` QVirtualKeyboardTrace ` asociado a esta interacción. Si el método de entrada descarta el evento, devuelve un valor `NULL`.
El objeto traceCaptureDeviceInfo proporciona información sobre el dispositivo de origen, mientras que el objeto traceScreenInfo proporciona información sobre el contexto de pantalla.
Por definición, el objeto ` QVirtualKeyboardTrace ` permanece válido hasta que se llama al método ` traceEnd()`.
La interacción de rastreo finaliza al invocar el método traceEnd().
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Esta función se introdujo en QtQuick.VirtualKeyboard 2.0.
[invokable] bool QVirtualKeyboardInputEngine::traceEnd(QVirtualKeyboardTrace *trace)
Finaliza la interacción de rastreo con el motor de entrada.
El objeto ` trace ` puede descartarse en cualquier momento tras llamar a esta función.
La función devuelve «true» si se ha aceptado la interacción de rastreo (es decir, los eventos táctiles no deben utilizarse para ninguna otra cosa).
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[invokable] void QVirtualKeyboardInputEngine::virtualKeyCancel()
Restablece el estado de la tecla activa sin emitir el evento de tecla. Este método resulta útil cuando el usuario descarta la tecla actual y es necesario restablecer el estado de la tecla.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Emite un evento de pulsación de tecla para los valores indicados de key, text y modifiers. Devuelve true si el motor de entrada ha aceptado el evento de tecla.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[signal] void QVirtualKeyboardInputEngine::virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
Indica que se ha pulsado la tecla virtual « key » con los valores « text » y « modifiers » indicados. El valor « isAutoRepeat » indica si el evento se repite automáticamente mientras se mantiene pulsada la tecla. Esta señal se emite una vez que el método de entrada ha procesado el evento de tecla.
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
La capa del teclado llama a esta función para indicar que se ha pulsado la tecla « key », con los valores « text » y « modifiers » indicados.
La tecla key se establece como tecla activa (tecla pulsada). El evento de tecla propiamente dicho se activa cuando se suelta la tecla mediante el método virtualKeyRelease(). El evento de pulsación de tecla puede descartarse llamando a virtualKeyCancel().
La pulsación de tecla también inicia el temporizador de repetición de teclas si repeat es true.
Devuelve ` true ` si la tecla ha sido aceptada por este motor de entrada.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Véase también virtualKeyCancel() y virtualKeyRelease().
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Suelta la tecla en key. El método emite un evento de tecla para el método de entrada si el evento no ha sido generado por un temporizador de repetición. Los valores text y modifiers se pasan al método de entrada.
Devuelve true si el motor de entrada ha aceptado la tecla.
Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase 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.