Класс QVirtualKeyboardInputEngine
Класс InputEngine предоставляет движок ввода, поддерживающий интеграцию C++ и QML. Подробнее...
| Заголовок: | #include <QVirtualKeyboardInputEngine> |
| qmake: | QT += virtualkeyboard |
| Инициализируется: | InputEngine |
| Наследуется от: | QObject |
Типы
| Перечисление | InputMode { Latin, Numeric, Dialable, Pinyin, Cangjie, …, Thai } |
| Перечисление | PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition } |
| Перечисление | ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor } |
| Флаги | ReselectFlags |
| Перечисление | TextCase { Lower, Upper } |
Свойства
|
|
Открытые функции
| Qt::Key | активныйКлюч() const |
| QVirtualKeyboardInputContext * | контекстВвода() const |
| QVirtualKeyboardAbstractInputMethod * | методВвода() const |
| QVirtualKeyboardInputEngine::InputMode | режимВвода() const |
| QList<int> | режимыВвода() const |
| QList<int> | режимыРаспознаванияШаблонов() const |
| Qt::Key | предыдущийКлюч() const |
| bool | сноваВыбрать(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags) |
| void | установитьМетодВвода(QVirtualKeyboardAbstractInputMethod *inputMethod) |
| void | установитьРежимВвода(QVirtualKeyboardInputEngine::InputMode inputMode) |
| QVirtualKeyboardTrace * | началоОтслеживания(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo) |
| bool | конецОтслеживания(QVirtualKeyboardTrace *trace) |
| void | отменаВиртуальнойКлавиши() |
| bool | нажатиеВиртуальнойКлавиши(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) |
| bool | нажатиеВиртуальнойКлавиши(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat) |
| bool | отпусканиеВиртуальнойКлавиши(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) |
| QVirtualKeyboardSelectionListModel * | списокПредлагаемыхСлов() const |
| bool | отображениеПредлагаемыхСлов() const |
Сигналы
| void | изменениеАктивногоКлюча(Qt::Key key) |
| void | изменениеМетодаВвода() |
| void | сбросМетодаВвода() |
| void | обновлениеМетодаВвода() |
| void | изменениеРежимаВвода() |
| void | изменениеРежимовВвода() |
| void | изменениеРежимовРаспознаванияШаблонов() |
| void | изменениеПредыдущегоКлюча(Qt::Key key) |
| void | нажатиеВиртуальнойКлавиши(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat) |
| void | изменениеСписокПредлагаемыхСлов() |
| void | изменениеОтображениеПредлагаемыхСлов() |
Подробное описание
Двигатель ввода отвечает за маршрутизацию событий ввода к методам ввода. Фактическая логика ввода реализуется методами ввода.
Двигатель ввода также включает в себя метод ввода по умолчанию, который обрабатывает по умолчанию, если активный метод ввода не обрабатывает событие.
Документация типов членов
перечисление QVirtualKeyboardInputEngine::InputMode
Это перечисление задает режим ввода для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::InputMode::Latin |
0 |
Стандартный режим ввода для латинского текста. |
QVirtualKeyboardInputEngine::InputMode::Numeric |
1 |
Разрешен только цифровой ввод. |
QVirtualKeyboardInputEngine::InputMode::Dialable |
2 |
Разрешен только ввод с набора. |
QVirtualKeyboardInputEngine::InputMode::Pinyin |
3 |
Режим ввода Пинъинь для китайского языка. |
QVirtualKeyboardInputEngine::InputMode::Cangjie |
4 |
Режим ввода Цанцзе для китайского языка. |
QVirtualKeyboardInputEngine::InputMode::Zhuyin |
5 |
Режим ввода Чжуйинь для китайского языка. |
QVirtualKeyboardInputEngine::InputMode::Hangul |
6 |
Режим ввода Хангль для корейского языка. |
QVirtualKeyboardInputEngine::InputMode::Hiragana |
7 |
Режим ввода Хирагана для японского языка. |
QVirtualKeyboardInputEngine::InputMode::Katakana |
8 |
Режим ввода Катакана для японского языка. |
QVirtualKeyboardInputEngine::InputMode::FullwidthLatin |
9 |
Режим ввода латинских символов полной ширины для восточноазиатских языков. |
QVirtualKeyboardInputEngine::InputMode::Greek |
10 |
Режим ввода греческого языка. |
QVirtualKeyboardInputEngine::InputMode::Cyrillic |
11 |
Режим ввода кириллицы. |
QVirtualKeyboardInputEngine::InputMode::Arabic |
12 |
Режим ввода арабского языка. |
QVirtualKeyboardInputEngine::InputMode::Hebrew |
13 |
Режим ввода иврита. |
QVirtualKeyboardInputEngine::InputMode::ChineseHandwriting |
14 |
Режим ввода китайской рукописного ввода. |
QVirtualKeyboardInputEngine::InputMode::JapaneseHandwriting |
15 |
Режим ввода японской рукописного ввода. |
QVirtualKeyboardInputEngine::InputMode::KoreanHandwriting |
16 |
Режим ввода корейской рукописного ввода. |
QVirtualKeyboardInputEngine::InputMode::Thai |
17 |
Режим ввода тайского языка. |
перечисление QVirtualKeyboardInputEngine::PatternRecognitionMode
Это перечисление определяет режим ввода для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::PatternRecognitionMode::None |
0 |
Распознавание образов недоступно. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::PatternRecognitionDisabled |
None |
obsolete Используйте PatternRecognitionMode::None |
QVirtualKeyboardInputEngine::PatternRecognitionMode::Handwriting |
1 |
Режим распознавания образов для распознавания рукописного ввода. |
QVirtualKeyboardInputEngine::PatternRecognitionMode::HandwritingRecoginition |
Handwriting |
obsolete Используйте PatternRecognitionMode::Handwriting |
перечисление QVirtualKeyboardInputEngine::ReselectFlagфлаги QVirtualKeyboardInputEngine::ReselectFlags
Это перечисление определяет правила для повторного выбора слова.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::ReselectFlag::WordBeforeCursor |
0x1 |
Активировать слово перед курсором. При использовании только этого флага, слово должно заканчиваться точно на курсоре. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAfterCursor |
0x2 |
Активировать слово после курсора. При использовании только этого флага, слово должно начинаться точно на курсоре. |
QVirtualKeyboardInputEngine::ReselectFlag::WordAtCursor |
WordBeforeCursor | WordAfterCursor |
Активировать слово на курсоре. Этот флаг является комбинацией вышеупомянутых флагов, за исключением того, что слово не может начинаться или заканчиваться на курсоре. |
Тип ReselectFlags — это псевдоним для QFlags<ReselectFlag>. Он хранит логическую комбинацию значений ReselectFlag.
перечисление QVirtualKeyboardInputEngine::TextCase
Это перечисление определяет регистр текста для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::TextCase::Lower |
0 |
Текст строчными буквами. |
QVirtualKeyboardInputEngine::TextCase::Upper |
1 |
Текст заглавными буквами. |
Документация свойств
activeKey : const Qt::Key
Это свойство содержит активную клавишу.
Текущая нажатая клавиша.
Функции доступа:
| Qt::Key | activeKey() const |
Сигнал уведомления:
| void | activeKeyChanged(Qt::Key key) |
inputMethod : QVirtualKeyboardAbstractInputMethod*
Это свойство содержит активный метод ввода.
Используйте это свойство для активации метода ввода или для отслеживания изменений активного метода ввода.
Функции доступа:
| QVirtualKeyboardAbstractInputMethod * | inputMethod() const |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
Сигнал уведомления:
| void | inputMethodChanged() |
inputMode : InputMode
Это свойство содержит текущий режим ввода.
Используйте это свойство для получения или установки текущего режима ввода. Свойство InputEngine::inputModes предоставляет список допустимых режимов ввода для текущего метода ввода и локали.
Функции доступа:
| QVirtualKeyboardInputEngine::InputMode | inputMode() const |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
Сигнал уведомления:
| void | inputModeChanged() |
inputModes : const QList<int>
Это свойство содержит доступные режимы ввода для активного метода ввода.
Список доступных режимов ввода зависит от метода ввода и локали. Это свойство обновляется при изменении любого из зависимых факторов.
Функции доступа:
| QList<int> | inputModes() const |
Сигнал уведомления:
| void | inputModesChanged() |
patternRecognitionModes : const QList<int>
Это свойство содержит список доступных режимов распознавания шаблонов.
Список доступных режимов распознавания шаблонов.
Это свойство было добавлено в QtQuick.VirtualKeyboard 2.0.
Функции доступа:
| QList<int> | patternRecognitionModes() const |
Сигнал уведомления:
| void | patternRecognitionModesChanged() |
previousKey : const Qt::Key
Это свойство содержит предыдущую активную клавишу.
Предыдущая нажатая клавиша.
Функции доступа:
| Qt::Key | previousKey() const |
Сигнал уведомления:
| void | previousKeyChanged(Qt::Key key) |
wordCandidateListModel : QVirtualKeyboardSelectionListModel* const
Модель списка для списка кандидатов слов.
Используйте это свойство для доступа к модели списка кандидатов слов.
Функции доступа:
| QVirtualKeyboardSelectionListModel * | wordCandidateListModel() const |
Сигнал уведомления:
| void | wordCandidateListModelChanged() |
wordCandidateListVisibleHint : const bool
Подсказка видимости списка кандидатов слов.
Используйте это свойство для проверки, должен ли список кандидатов слов отображаться в пользовательском интерфейсе.
Функции доступа:
| bool | wordCandidateListVisibleHint() const |
Сигнал уведомления:
| void | wordCandidateListVisibleHintChanged() |
Документация по функциям членов
[signal] void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)
Указывает, что активная клавиша key изменилась.
Примечание: Сигнал уведомления для свойства activeKey.
[signal] void QVirtualKeyboardInputEngine::inputMethodChanged()
Указывает, что метод ввода изменился.
Примечание: Сигнал уведомления для свойства inputMethod.
[signal] void QVirtualKeyboardInputEngine::inputMethodReset()
Вызывается, когда метод ввода должен быть сброшен.
Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::reset() и InputMethod::reset() при активации метода ввода.
[signal] void QVirtualKeyboardInputEngine::inputMethodUpdate()
Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::update() и InputMethod::update() при активации метода ввода.
[signal] void QVirtualKeyboardInputEngine::inputModeChanged()
Указывает, что режим ввода изменился.
Примечание: Сигнал уведомления для свойства inputMode.
[signal] void QVirtualKeyboardInputEngine::inputModesChanged()
Указывает, что доступные режимы ввода изменились.
Примечание: Сигнал уведомления для свойства inputModes.
[signal] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()
Указывает, что доступные режимы распознавания шаблонов изменились.
Примечание: Сигнал уведомления для свойства patternRecognitionModes.
Эта функция была добавлена в QtQuick.VirtualKeyboard 2.0.
[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)
Указывает, что предыдущая клавиша key изменилась.
Примечание: Сигнал уведомления для свойства previousKey.
[signal] void QVirtualKeyboardInputEngine::virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
Указывает, что виртуальная клавиша была нажата с заданным текстом и модификаторами. isAutoRepeat указывает, повторяется ли событие автоматически во время нажатия клавиши. Этот сигнал испускается после того, как метод обработки ввода обработает событие нажатия клавиши.
Qt::Key QVirtualKeyboardInputEngine::activeKey() const
Возвращает текущую активную клавишу или Qt::Key_unknown, если активных клавиш нет.
Примечание: Функция-геттер для свойства activeKey.
QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const
Возвращает экземпляр InputContext , связанный с движком ввода.
QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const
Возвращает активный метод ввода.
Примечание: Функция-геттер для свойства inputMethod.
См. также setInputMethod().
QList<int> QVirtualKeyboardInputEngine::inputModes() const
Возвращает список доступных режимов ввода.
Примечание: Функция-геттер для свойства inputModes.
QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const
Возвращает список поддерживаемых режимов распознавания шаблонов.
Примечание: Функция-геттер для свойства patternRecognitionModes.
Qt::Key QVirtualKeyboardInputEngine::previousKey() const
Возвращает предыдущую активную клавишу или Qt::Key_unknown, если активной клавиши не было.
Примечание: Функция-геттер для свойства previousKey.
bool QVirtualKeyboardInputEngine::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
Эта функция пытается повторно выбрать слово, расположенное по cursorPosition. reselectFlags определяют правила выбора слова относительно позиции курсора.
Функция возвращает true, если слово было успешно выбрано повторно.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
Функция была добавлена в QtQuick.VirtualKeyboard 2.0.
void QVirtualKeyboardInputEngine::setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod)
Устанавливает inputMethod в качестве активного метода ввода.
Примечание: Функция-сеттер для свойства inputMethod.
См. также inputMethod().
QVirtualKeyboardTrace *QVirtualKeyboardInputEngine::traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)
Начинает взаимодействие отслеживания с движком ввода.
Взаимодействие отслеживается уникальным идентификатором traceId. Движок ввода назначит идентификатор объекту QVirtualKeyboardTrace, если метод ввода принимает событие.
patternRecognitionMode определяет используемый режим распознавания шаблона.
Если текущий метод ввода принимает событие, он возвращает объект QVirtualKeyboardTrace, связанный с этим взаимодействием. Если метод ввода отбрасывает событие, он возвращает значение NULL.
traceCaptureDeviceInfo предоставляет информацию об устройстве-источнике, а traceScreenInfo — информацию о контексте экрана.
По определению, объект QVirtualKeyboardTrace остается действительным до вызова метода traceEnd().
Взаимодействие отслеживания завершается вызовом метода traceEnd().
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
Функция была добавлена в QtQuick.VirtualKeyboard 2.0.
bool QVirtualKeyboardInputEngine::traceEnd(QVirtualKeyboardTrace *trace)
Завершает взаимодействие отслеживания с движком ввода.
Объект trace может быть удалён в любой момент после вызова этой функции.
Функция возвращает true, если взаимодействие отслеживания было принято (т. е. события касания не должны использоваться для чего-либо ещё).
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
void QVirtualKeyboardInputEngine::virtualKeyCancel()
Возвращает состояние активной клавиши без испускания события нажатия клавиши. Этот метод полезен, когда пользователь отменяет текущую клавишу, и состояние клавиши необходимо восстановить.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
bool QVirtualKeyboardInputEngine::virtualKeyClick(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Издаёт событие нажатия клавиши для заданной key, text и modifiers. Возвращает true, если событие нажатия клавиши было принято движком ввода.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
Вызывается слоем клавиатуры, чтобы указать, что key была нажата, с заданным text и modifiers.
key устанавливается как активная клавиша (нажатая клавиша). Фактическое событие нажатия клавиши генерируется, когда клавиша отпускается методом virtualKeyRelease(). Событие нажатия клавиши можно отбросить, вызвав virtualKeyCancel().
Нажатие клавиши также запускает таймер повторения клавиши, если repeat равно true.
Возвращает true, если клавиша была принята этим движком ввода.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
См. также virtualKeyCancel() и virtualKeyRelease().
bool QVirtualKeyboardInputEngine::virtualKeyRelease(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Отпускает клавишу key. Метод испускает событие нажатия клавиши для метода ввода, если событие не было сгенерировано повторяющимся таймером. text и modifiers передаются методу ввода.
Возвращает true, если клавиша была принята движком ввода.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qvirtualkeyboardinputengine.html