QVirtualKeyboardInputEngine Class
La clase InputEngine proporciona un motor de entrada que admite la integración de C++ y QML. Más...
| Cabecera: | #include <QVirtualKeyboardInputEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS VirtualKeyboard)target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) |
| qmake: | QT += virtualkeyboard |
| En QML: | InputEngine |
| Hereda: | 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 es responsable de enrutar los eventos de entrada a los métodos de entrada. La lógica de entrada real es implementada por los métodos de entrada.
El motor de entrada también incluye el método de entrada por defecto, que se encarga del procesamiento por defecto si el método de entrada activo no maneja el evento.
Documentación de tipos de miembros
enum class QVirtualKeyboardInputEngine::InputMode
Este enum especifica el modo de entrada para el método de entrada.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::InputMode::Latin | 0 | El modo de entrada por defecto para texto latino. |
QVirtualKeyboardInputEngine::InputMode::Numeric | 1 | Sólo se permite la entrada numérica. |
QVirtualKeyboardInputEngine::InputMode::Dialable | 2 | Sólo se permite la entrada marcable. |
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 Katakana para japonés. |
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin | 9 | Modo de introducción de caracteres latinos de ancho completo para las lenguas de Asia Oriental. |
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 escritura china. |
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting | 15 | Modo manuscrito japonés. |
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting | 16 | Modo de escritura coreana. |
QVirtualKeyboardInputEngine::InputMode::Thai | 17 | Modo de entrada en tailandés. |
QVirtualKeyboardInputEngine::InputMode::Stroke | 18 | Modo de entrada Stroke 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
Este enum especifica el modo de entrada para el método de entrada.
| 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 a mano. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginition | Handwriting | obsolete Utilice PatternRecognitionMode::Handwriting |
enum class QVirtualKeyboardInputEngine::ReselectFlag
flags QVirtualKeyboardInputEngine::ReselectFlags
Esta enum especifica las reglas para la reselección de palabras.
| Constante | Valor | Descripción |
|---|---|---|
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor | 0x1 | Activa la palabra anterior al cursor. Cuando se utiliza exclusivamente esta bandera, la palabra debe terminar exactamente en el cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor | 0x2 | Activa la palabra después del cursor. Cuando se utiliza exclusivamente este indicador, la palabra debe empezar exactamente en el cursor. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursor | WordBeforeCursor | WordAfterCursor | Activar la palabra en el cursor. Esta bandera es una combinación de las banderas anteriores con la excepción de que la palabra no puede empezar o terminar en el cursor. |
El tipo ReselectFlags es un typedef para QFlags<ReselectFlag>. Almacena una combinación OR de valores ReselectFlag.
enum class QVirtualKeyboardInputEngine::TextCase
Este enum especifica el caso de texto para el 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 del notificador:
| void | activeKeyChanged(Qt::Key key) |
inputMethod : QVirtualKeyboardAbstractInputMethod*
Esta propiedad contiene el método de entrada activo.
Utilice esta propiedad para activar el método de entrada, o para controlar cuando cambia el método de entrada activo.
Funciones de acceso:
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
Notificador de señal:
| void | inputMethodChanged() |
inputMode : InputMode
Esta propiedad contiene el modo de entrada actual.
Utilice esta propiedad para obtener o establecer el modo de entrada actual. InputEngine::inputModes proporciona una lista de 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 del notificador:
| 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 alguna de las dependencias.
Funciones de acceso:
| QList<int> | inputModes() const |
Señal del notificador:
| 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 propiedad fue introducida en QtQuick.VirtualKeyboard 2.0.
Funciones de acceso:
| QList<int> | patternRecognitionModes() const |
Señal del notificador:
[read-only] previousKey : Qt::Key
Esta propiedad contiene la tecla activa anterior.
Tecla pulsada anteriormente.
Funciones de acceso:
| Qt::Key | previousKey() const |
Señal de aviso:
| 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 de la lista de palabras candidatas.
Funciones de acceso:
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
Señal del notificador:
| void | wordCandidateListModelChanged() |
[read-only] wordCandidateListVisibleHint : bool
pista visible para la lista de palabras candidatas.
Utilice esta propiedad para comprobar si la lista de palabras candidatas debe ser visible en la interfaz de usuario.
Funciones de acceso:
| bool | wordCandidateListVisibleHint() const |
Señal del notificador:
| void | wordCandidateListVisibleHintChanged() |
Documentación de la función miembro
Qt::Key QVirtualKeyboardInputEngine::activeKey() const
Devuelve la tecla actualmente activa, o Qt::Key_unknown si no hay ninguna tecla activa.
Nota: Función Getter para la propiedad activeKey.
[signal] void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)
Indica que el key activo ha cambiado.
Nota: Señal notificadora para la propiedad activeKey.
QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const
Devuelve la instancia InputContext asociada al motor de entrada.
QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const
Devuelve el método de entrada activo.
Nota: Función Getter para la propiedad inputMethod.
Véase también setInputMethod().
[signal] void QVirtualKeyboardInputEngine::inputMethodChanged()
Indica que el método de entrada ha cambiado.
Nota: Señal notificadora para la propiedad inputMethod.
[signal] void QVirtualKeyboardInputEngine::inputMethodReset()
Se emite cuando es necesario reiniciar 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ñal notificadora para la propiedad inputMode.
QList<int> QVirtualKeyboardInputEngine::inputModes() const
Devuelve la lista de modos de entrada disponibles.
Nota: Función Getter para la propiedad inputModes.
[signal] void QVirtualKeyboardInputEngine::inputModesChanged()
Indica que los modos de entrada disponibles han cambiado.
Nota: Señal de aviso para la propiedad inputModes.
QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const
Devuelve la lista de modos de reconocimiento de patrones soportados.
Nota: Función Getter para la propiedad patternRecognitionModes.
[signal, since QtQuick.VirtualKeyboard 2.0] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()
Indica que los modos de reconocimiento de patrones disponibles han cambiado.
Nota: Señal notificadora para la propiedad patternRecognitionModes.
Esta función se introdujo en QtQuick.VirtualKeyboard 2.0.
Qt::Key QVirtualKeyboardInputEngine::previousKey() const
Devuelve la tecla previamente activa, o Qt::Key_unknown si no ha habido ninguna tecla activa.
Nota: Función Getter para la propiedad previousKey.
[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)
Indica que el anterior key ha cambiado.
Nota: Señal notificadora 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 cursorPosition. En reselectFlags se definen las reglas de selección de la palabra en relación con la posición del cursor.
La función devuelve true si la palabra ha sido seleccionada con éxito.
Nota: Esta función puede invocarse a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
Esta función fue introducida en QtQuick.VirtualKeyboard 2.0.
void QVirtualKeyboardInputEngine::setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)
Establece inputMethod como método de entrada activo.
Nota: Función Setter 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 rastreo con el motor de entrada.
El rastro se identifica unívocamente por el traceId. El motor de entrada asignará el id al objeto QVirtualKeyboardTrace si el método de entrada acepta el evento.
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 y el objeto traceScreenInfo proporciona información sobre el contexto de la pantalla.
Por definición, el objeto QVirtualKeyboardTrace permanece válido hasta que se llama al método traceEnd().
La interacción de rastreo finaliza llamando al método traceEnd().
Nota: Esta función puede invocarse 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 ser descartado en cualquier momento después de llamar a esta función.
La función devuelve true si la interacción de rastreo fue aceptada (es decir, los eventos táctiles no deben utilizarse para otra cosa).
Nota: Esta función puede invocarse a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.
[invokable] void QVirtualKeyboardInputEngine::virtualKeyCancel()
Revierte el estado de la tecla activa sin emitir el evento de tecla. Este método es útil cuando el usuario descarta la tecla actual y es necesario restaurar el estado de la tecla.
Nota: Esta función puede invocarse 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 campos key, text y modifiers. Devuelve true si el evento de tecla fue aceptado por el motor de entrada.
Nota: Esta función puede invocarse 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 el virtual key con los dados text y modifiers. isAutoRepeat indica si el evento se repite automáticamente mientras se pulsa la tecla. Esta señal se emite después de que el método de entrada haya procesado el evento de tecla.
[invokable] bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
Llamada por la capa del teclado para indicar que se ha pulsado key, con las dadas text y modifiers.
key se establece como tecla activa (tecla abajo). El evento de tecla real 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 la tecla también inicia el temporizador de repetición de teclas si repeat es true.
Devuelve true si la tecla fue aceptada por este motor de entrada.
Nota: Esta función puede invocarse 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)
Libera la tecla en key. El método emite un evento de clave 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 la clave ha sido aceptada por el motor de entrada.
Nota: Esta función puede invocarse 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.
