Spec-Zone.ru › Qt 5.14

Класс QVirtualKeyboardInputEngine

Класс InputEngine предоставляет механизм ввода, поддерживающий интеграцию C++ и QML. Подробнее...

Заголовок: #include <QVirtualKeyboardInputEngine>
qmake: QT += virtualkeyboard
Создаётся: InputEngine
Наследует: QObject
  • Список всех членов, включая унаследованные

Открытые типы

enum InputMode { Latin, Numeric, Dialable, Pinyin, Cangjie, …, Thai }
enum PatternRecognitionMode { None, PatternRecognitionDisabled, Handwriting, HandwritingRecoginition }
enum ReselectFlag { WordBeforeCursor, WordAfterCursor, WordAtCursor }
flags ReselectFlags
enum TextCase { Lower, Upper }

Свойства

  • activeKey : const Qt::Key
  • inputMethod : QVirtualKeyboardAbstractInputMethod*
  • inputMode : InputMode
  • inputModes : const QList<int>
  • patternRecognitionModes : const QList<int>
  • previousKey : const Qt::Key
  • wordCandidateListModel : QVirtualKeyboardSelectionListModel* const
  • wordCandidateListVisibleHint : const bool

Открытые функции

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

Сигналы

void activeKeyChanged(Qt::Key key)
void inputMethodChanged()
void inputMethodReset()
void inputMethodUpdate()
void inputModeChanged()
void inputModesChanged()
void patternRecognitionModesChanged()
void previousKeyChanged(Qt::Key key)
void virtualKeyClicked(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers, bool isAutoRepeat)
void wordCandidateListModelChanged()
void wordCandidateListVisibleHintChanged()

Подробное описание

Механизм ввода отвечает за маршрутизацию событий ввода в методы ввода. Фактическая логика ввода реализована методами ввода.

Механизм ввода также включает в себя метод ввода по умолчанию, который отвечает за обработку по умолчанию, если активный метод ввода не обрабатывает событие.

Описание типа члена

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.

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()

Документация по членам-функциям

void QVirtualKeyboardInputEngine::activeKeyChanged(Qt::Key key)

Указывает, что активная key изменилась.

Примечание: Сигнал уведомления для свойства activeKey.

void QVirtualKeyboardInputEngine::inputMethodChanged()

Указывает, что метод ввода изменился.

Примечание: Сигнал уведомления для свойства inputMethod.

void QVirtualKeyboardInputEngine::inputMethodReset()

Вызывается, когда метод ввода необходимо сбросить.

Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::reset() и InputMethod::reset() при активации метода ввода.

void QVirtualKeyboardInputEngine::inputMethodUpdate()

Примечание: Этот сигнал автоматически подключается к QVirtualKeyboardAbstractInputMethod::update() и InputMethod::update() при активации метода ввода.

void QVirtualKeyboardInputEngine::inputModeChanged()

Указывает, что режим ввода изменился.

Примечание: Сигнал уведомления для свойства inputMode.

void QVirtualKeyboardInputEngine::inputModesChanged()

Указывает, что доступные режимы ввода изменились.

Примечание: Сигнал уведомления для свойства inputModes.

void QVirtualKeyboardInputEngine::patternRecognitionModesChanged()

Указывает, что доступные режимы распознавания шаблонов изменились.

Это функция была введена в QtQuick.VirtualKeyboard 2.0.

Примечание: Сигнал уведомления для свойства patternRecognitionModes.

void QVirtualKeyboardInputEngine::previousKeyChanged(Qt::Key key)

Указывает, что предыдущая key изменилась.

Примечание: Сигнал уведомления для свойства previousKey.

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 , если слово было успешно перевыбрано.

Эта функция была добавлена в 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.

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.14/qvirtualkeyboardinputengine.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API