Класс QVirtualKeyboardInputEngine
Класс InputEngine предоставляет движок ввода, поддерживающий интеграцию C++ и QML. Подробнее...
| Заголовок: | #include <QVirtualKeyboardInputEngine> |
| qmake: | QT += virtualkeyboard |
| Инициализируется классом: | InputEngine |
| Наследует: | QObject |
Типы
| Перечисление | InputMode { Latin, Numeric, Dialable, Pinyin, ..., Thai } |
| Перечисление | PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition } |
| Перечисление | ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor } |
| Флаги | ReselectFlags |
| Перечисление | TextCase { Lower, Upper } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Открытые функции
| 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 |
| bool | reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags) |
| void | setInputMethod(QVirtualKeyboardAbstractInputMethod *inputMethod) |
| void | setInputMode(QVirtualKeyboardInputEngine::InputMode inputMode) |
| 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 |
- 31 открытая функция унаследована от QObject
Сигналы
| void | activeKeyChanged(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 | изменениеВидимостиСпискаПредложений() |
- 2 сигнала унаследованы от QObject
Статические публичные члены
| const QMetaObject | staticMetaObject |
- 9 статических публичных членов унаследованы от QObject
Дополнительные унаследованные члены
Подробное описание
Класс InputEngine предоставляет движок ввода, поддерживающий интеграцию на C++ и QML.
Движок ввода отвечает за маршрутизацию событий ввода к методам ввода. Фактическая логика ввода реализуется методами ввода.
END_OF_DOCUMENT_MARKERДвигатель ввода также включает в себя метод ввода по умолчанию, который обрабатывает события по умолчанию, если активный метод ввода их не обрабатывает.
Документация по типу членов
enum QVirtualKeyboardInputEngine::InputMode
Это перечисление определяет режим ввода для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::Latin |
0 |
Режим ввода по умолчанию для латинского текста. |
QVirtualKeyboardInputEngine::Numeric |
1 |
Разрешен только числовой ввод. |
QVirtualKeyboardInputEngine::Dialable |
2 |
Разрешен только набираемый ввод. |
QVirtualKeyboardInputEngine::Pinyin |
3 |
Режим ввода Пинъин для китайского языка. |
QVirtualKeyboardInputEngine::Cangjie |
4 |
Режим ввода Цанцзе для китайского языка. |
QVirtualKeyboardInputEngine::Zhuyin |
5 |
Режим ввода Жуйин для китайского языка. |
QVirtualKeyboardInputEngine::Hangul |
6 |
Режим ввода Хангуль для корейского языка. |
QVirtualKeyboardInputEngine::Hiragana |
7 |
Режим ввода Хирагана для японского языка. |
QVirtualKeyboardInputEngine::Katakana |
8 |
Режим ввода Катакана для японского языка. |
QVirtualKeyboardInputEngine::FullwidthLatin |
9 |
Режим ввода латиницы с полным шириной для восточноазиатских языков. |
QVirtualKeyboardInputEngine::Greek |
10 |
Режим ввода греческого языка. |
QVirtualKeyboardInputEngine::Cyrillic |
11 |
Режим ввода кириллицы. |
QVirtualKeyboardInputEngine::Arabic |
12 |
Режим ввода арабского языка. |
QVirtualKeyboardInputEngine::Hebrew |
13 |
Режим ввода иврита. |
QVirtualKeyboardInputEngine::ChineseHandwriting |
14 |
Режим ввода китайской рукописного ввода. |
QVirtualKeyboardInputEngine::JapaneseHandwriting |
15 |
Режим ввода японской рукописного ввода. |
QVirtualKeyboardInputEngine::KoreanHandwriting |
16 |
Режим ввода корейской рукописного ввода. |
QVirtualKeyboardInputEngine::Thai |
17 |
Режим ввода тайского языка. |
enum QVirtualKeyboardInputEngine::PatternRecognitionMode
Это перечисление определяет режим ввода для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::None |
0 |
Распознавание шаблонов недоступно. |
QVirtualKeyboardInputEngine::PatternRecognitionDisabled |
None |
obsolete Используйте PatternRecognitionMode::None |
QVirtualKeyboardInputEngine::Handwriting |
1 |
Режим распознавания шаблонов для распознавания рукописного ввода. |
QVirtualKeyboardInputEngine::HandwritingRecoginition |
Handwriting |
obsolete Используйте PatternRecognitionMode::Handwriting |
enum QVirtualKeyboardInputEngine::ReselectFlagflags QVirtualKeyboardInputEngine::ReselectFlags
Это перечисление определяет правила для повторного выбора слова.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::WordBeforeCursor |
0x1 |
Активировать слово перед курсором. При использовании этой метки исключительно, слово должно заканчиваться ровно на курсоре. |
QVirtualKeyboardInputEngine::WordAfterCursor |
0x2 |
Активировать слово после курсора. При использовании этой метки исключительно, слово должно начинаться ровно с курсора. |
QVirtualKeyboardInputEngine::WordAtCursor |
WordBeforeCursor | WordAfterCursor |
Активировать слово на курсоре. Эта метка является комбинацией вышеупомянутых меток за исключением того, что слово не может начинаться или заканчиваться на курсоре. |
Тип ReselectFlags — это псевдоним для QFlags<ReselectFlag>. Он хранит комбинацию значений ReselectFlag с помощью операции OR.
enum QVirtualKeyboardInputEngine::TextCase
Это перечисление определяет регистр текста для метода ввода.
| Постоянная | Значение | Описание |
|---|---|---|
QVirtualKeyboardInputEngine::Lower |
0 |
Текст строчными буквами. |
QVirtualKeyboardInputEngine::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() |
Документация функций-членов
Qt::Key QVirtualKeyboardInputEngine::activeKey() const
Возвращает активную клавишу или Qt::Key_unknown, если активная клавиша отсутствует.
Примечание: Функция-геттер для свойства activeKey.
void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)
Указывает, что активная key изменилась.
Примечание: Сигнал уведомления для свойства activeKey.
QVirtualKeyboardInputContext *QVirtualKeyboardInputEngine::inputContext() const
Возвращает текущий экземпляр, связанный с движком ввода.
QVirtualKeyboardAbstractInputMethod *QVirtualKeyboardInputEngine::inputMethod() const
Возвращает активный метод ввода.
Примечание: Функция-геттер для свойства inputMethod.
См. также setInputMethod().
void QVirtualKeyboardInputEngine::inputMethodChanged()
Указывает, что метод ввода изменился.
Примечание: Сигнал уведомления для свойства inputMethod.
void QVirtualKeyboardInputEngine::inputMethodReset()
Выдается, когда метод ввода необходимо сбросить.
Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::reset() и InputMethod::reset() при активации метода ввода.
void QVirtualKeyboardInputEngine::inputMethodUpdate()
Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::update() и InputMethod::update() при активации метода ввода.
void QVirtualKeyboardInputEngine::inputModeChanged()
Указывает, что режим ввода изменился.
Примечание: Сигнал уведомления для свойства inputMode.
QList<int> QVirtualKeyboardInputEngine::inputModes() const
Возвращает список доступных режимов ввода.
Примечание: Функция-геттер для свойства inputModes.
void QVirtualKeyboardInputEngine::inputModesChanged()
Указывает, что доступные режимы ввода изменились.
END_OF_DOCUMENT_MARKERПримечание: Сигнал уведомления для свойства inputModes.
QList<int> QVirtualKeyboardInputEngine::patternRecognitionModes() const
Возвращает список поддерживаемых режимов распознавания шаблонов.
Примечание: Функция-геттер для свойства patternRecognitionModes.
[signal] void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()
Указывает, что доступные режимы распознавания шаблонов изменились.
Эта функция была добавлена в QtQuick.VirtualKeyboard 2.0.
Примечание: Сигнальная функция-нотификатор для свойства patternRecognitionModes.
Qt::Key QVirtualKeyboardInputEngine::previousKey() const
Возвращает предыдущую активную клавишу или Qt::Key_unknown, если ни одна клавиша не была активной.
Примечание: Функция-геттер для свойства previousKey.
[signal] void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)
Указывает, что предыдущая клавиша key изменилась.
Примечание: Сигнальная функция-нотификатор для свойства previousKey.
bool QVirtualKeyboardInputEngine::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
Эта функция пытается повторно выбрать слово, расположенное в позиции cursorPosition. Флаги reselectFlags определяют правила выбора слова относительно позиции курсора.
Функция возвращает true, если слово было успешно выбрано повторно.
Эта функция была добавлена в QtQuick.VirtualKeyboard 2.0.
Примечание: К этой функции можно обратиться через систему метаобъектов и из QML. См. Q_INVOKABLE.
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().
Эта функция была добавлена в QtQuick.VirtualKeyboard 2.0.
Примечание: К этой функции можно обратиться через систему метаобъектов и из QML. См. Q_INVOKABLE.
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.
[signal] void QVirtualKeyboardInputEngine::virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
Указывает, что виртуальная клавиша key была нажата с заданным текстом text и модификаторами modifiers. isAutoRepeat указывает, повторяется ли событие автоматически, пока клавиша нажата. Этот сигнал отправляется после обработки события клавиши методом ввода.
bool QVirtualKeyboardInputEngine::virtualKeyPress(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool repeat)
Вызывается слоем клавиатуры для указания нажатия клавиши key с заданным текстом text и модификаторами modifiers.
Клавиша key устанавливается как активная клавиша (клавиша вниз). Фактическое событие клавиши срабатывает при отпускании клавиши методом virtualKeyRelease(). Событие нажатия клавиши можно отбросить, вызвав virtualKeyCancel().
Нажатие клавиши также запускает таймер повторения клавиш, если repeat равно true.
Возвращает true, если клавиша была принята этим движком ввода.
См. также 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.12/qvirtualkeyboardinputengine.html