Класс QVirtualKeyboardAbstractInputMethod
Базовый класс для методов ввода. Подробнее...
| Заголовок: | #include <QVirtualKeyboardAbstractInputMethod> |
| CMake: | find_package(Qt6 COMPONENTS VirtualKeyboard REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::VirtualKeyboard) |
| qmake: | QT += virtualkeyboard |
| Наследует: | QObject |
Открытые функции
| QVirtualKeyboardAbstractInputMethod(QObject *parent = nullptr) | |
| virtual | ~QVirtualKeyboardAbstractInputMethod() |
| virtual bool | clickPreeditText(int cursorPosition) |
| QVirtualKeyboardInputContext * | inputContext() const |
| QVirtualKeyboardInputEngine * | inputEngine() const |
| virtual QList<QVirtualKeyboardInputEngine::InputMode> | inputModes(const QString &locale) = 0 |
| virtual bool | keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) = 0 |
| virtual QList<QVirtualKeyboardInputEngine::PatternRecognitionMode> | patternRecognitionModes() const |
| virtual bool | reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags) |
Открытые слоты
| virtual void | clearInputMode() |
| virtual void | reset() |
| virtual void | update() |
Сигналы
| void | selectionListActiveItemChanged(QVirtualKeyboardSelectionListModel::Type type, int index) |
Подробное описание
Используйте этот класс, если хотите реализовать пользовательский метод ввода с помощью языков C/C++.
Документация по функциям-членам
QVirtualKeyboardAbstractInputMethod::QVirtualKeyboardAbstractInputMethod(QObject *parent = nullptr)
Конструирует метод ввода с parent.
[virtual slot, since QtQuick.VirtualKeyboard 6.1] void QVirtualKeyboardAbstractInputMethod::clearInputMode()
Очищает режим ввода.
Этот метод вызывается виртуальной клавиатурой, когда этот метод ввода заменяется другим. Он должен очистить операции, выполненные методом setInputMode(), например, отсоединить обработчики сигналов от виртуальной клавиатуры или освободить ресурсы.
Режим ввода может быть повторно активирован вызовом setInputMode(). Однако обратите внимание, что вызовы setInputMethod() и clearInputMethod() не сбалансированы. Таким образом, например, setInputMethod() может вызываться несколько раз без соответствующих вызовов clearInputMethod().
Реализация по умолчанию ничего не делает.
Функция была добавлена в QtQuick.VirtualKeyboard 6.1.
[virtual slot] void QVirtualKeyboardAbstractInputMethod::reset()
Этот метод вызывается механизмом ввода, когда метод ввода необходимо сбросить. Метод ввода должен сбросить только своё внутреннее состояние. Основное отличие от метода update() заключается в том, что reset() изменяет только состояние метода ввода, т. е. он не должен изменять контекст ввода.
[signal] void QVirtualKeyboardAbstractInputMethod::selectionListActiveItemChanged(QVirtualKeyboardSelectionListModel::Type type, int index)
Метод ввода излучает этот сигнал, когда текущий индекс изменился в списке выбора, идентифицируемом по type.
[signal] void QVirtualKeyboardAbstractInputMethod::selectionListChanged(QVirtualKeyboardSelectionListModel::Type type)
Метод ввода излучает этот сигнал, когда содержимое списка выбора изменилось. Параметр type указывает, какой список выбора изменился.
[signal, since QtQuick.VirtualKeyboard 2.2] void QVirtualKeyboardAbstractInputMethod::selectionListsChanged()
Метод ввода излучает этот сигнал, когда типы списков выбора изменились. Этот сигнал вызовет метод selectionLists(), позволяя методу ввода обновить типы списков выбора.
Функция была добавлена в QtQuick.VirtualKeyboard 2.2.
[virtual slot] void QVirtualKeyboardAbstractInputMethod::update()
Этот метод вызывается механизмом ввода, когда метод ввода необходимо обновить. Метод ввода должен закрыть текущий текст предварительного редактирования и восстановить своё внутреннее состояние до значения по умолчанию.
[virtual] QVirtualKeyboardAbstractInputMethod::~QVirtualKeyboardAbstractInputMethod()
Уничтожает метод ввода и освобождает все выделенные ресурсы.
END_OF_DOCUMENT_MARKER
[virtual, since QtQuick.VirtualKeyboard 2.4] bool QVirtualKeyboardAbstractInputMethod::clickPreeditText(int cursorPosition)
Вызывается, когда пользователь нажимает на предварительно отредактированный текст в позиции cursorPosition.
Функция должна вернуть true , если она обрабатывает событие. В противном случае вход перенаправляется в reselect() для дальнейшей обработки.
Эта функция была введена в QtQuick.VirtualKeyboard 2.4.
QVirtualKeyboardInputContext *QVirtualKeyboardAbstractInputMethod::inputContext() const
Возвращает контекст ввода, связанный с методом ввода. Этот метод возвращает NULL , если метод ввода не активен.
QVirtualKeyboardInputEngine *QVirtualKeyboardAbstractInputMethod::inputEngine() const
Возвращает движок ввода, связанный с методом ввода. Этот метод возвращает NULL , если метод ввода не активен.
[pure virtual] QList<QVirtualKeyboardInputEngine::InputMode> QVirtualKeyboardAbstractInputMethod::inputModes(const QString &locale)
Возвращает список режимов ввода для locale.
[pure virtual] bool QVirtualKeyboardAbstractInputMethod::keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
Цель этого метода — обрабатывать события нажатия клавиш, генерируемые движком ввода.
Параметр key задаёт код клавиши для обработки. Код клавиши не различает заглавные и строчные буквы. Параметр text содержит текстовое представление Unicode для клавиши. Параметр modifiers содержит модификаторы клавиши, применимые к данной клавише.
Этот метод возвращает true , если событие нажатия клавиши было успешно обработано. Если возвращаемое значение false, событие нажатия клавиши перенаправляется на стандартный метод ввода для дальнейшей обработки.
[virtual, since QtQuick.VirtualKeyboard 2.0] QList<QVirtualKeyboardInputEngine::PatternRecognitionMode> QVirtualKeyboardAbstractInputMethod::patternRecognitionModes() const
Возвращает список поддерживаемых режимов распознавания шаблонов.
Этот метод вызывается движком ввода для запроса списка поддерживаемых режимов распознавания шаблонов.
Эта функция была введена в QtQuick.VirtualKeyboard 2.0.
[virtual, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardAbstractInputMethod::reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags)
Эта функция пытается повторно выбрать слово, расположенное в позиции cursorPosition. Параметр reselectFlags определяет правила выбора слова относительно позиции курсора.
Функция возвращает true , если слово было успешно повторно выбрано.
Эта функция была введена в QtQuick.VirtualKeyboard 2.0.
[virtual] QVariant QVirtualKeyboardAbstractInputMethod::selectionListData(QVirtualKeyboardSelectionListModel::Type type, int index, QVirtualKeyboardSelectionListModel::Role role)
Возвращает данные элемента списка выбора, идентифицированного значением type. Параметр role указывает, какие данные запрашиваются. Параметр index — индекс в списке, начиная с нуля.
[virtual] int QVirtualKeyboardAbstractInputMethod::selectionListItemCount(QVirtualKeyboardSelectionListModel::Type type)
Возвращает количество элементов в списке выбора, идентифицированном значением type.
[virtual] void QVirtualKeyboardAbstractInputMethod::selectionListItemSelected(QVirtualKeyboardSelectionListModel::Type type, int index)
Этот метод вызывается, когда пользователь выбрал элемент с индексом index. Список выбора идентифицируется параметром type.
[virtual] bool QVirtualKeyboardAbstractInputMethod::selectionListRemoveItem(QVirtualKeyboardSelectionListModel::Type type, int index)
Этот метод вызывается, когда элемент с индексом index должен быть удалён из словаря. Список выбора идентифицируется параметром type. Функция возвращает true , если слово было успешно удалено.
[virtual] QList<QVirtualKeyboardSelectionListModel::Type> QVirtualKeyboardAbstractInputMethod::selectionLists()
Возвращает список списков выбора, используемых этим методом ввода.
Этот метод вызывается движком ввода при активации метода ввода и каждый раз, когда обновляются подсказки метода ввода. Метод ввода может резервировать списки выбора, возвращая необходимые типы списков выбора.
Метод ввода может запросить у движка ввода обновить списки выбора в любое время, выпустив сигнал selectionListsChanged(). Этот сигнал вызовет этот метод, позволяя методу ввода обновить типы списков выбора.
[pure virtual] bool QVirtualKeyboardAbstractInputMethod::setInputMode(const QString &locale, QVirtualKeyboardInputEngine::InputMode inputMode)
Устанавливает inputMode и locale для этого метода ввода. Возвращает true при успехе.
[pure virtual] bool QVirtualKeyboardAbstractInputMethod::setTextCase(QVirtualKeyboardInputEngine::TextCase textCase)
Обновляет textCase для этого метода ввода. Метод возвращает true при успехе.
[virtual, since QtQuick.VirtualKeyboard 2.0] QVirtualKeyboardTrace *QVirtualKeyboardAbstractInputMethod::traceBegin(int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode, const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo)
Этот метод вызывается при запуске взаимодействия отслеживания с указанным значением patternRecognitionMode. Взаимодействие отслеживания однозначно идентифицируется значением traceId. Параметр traceCaptureDeviceInfo предоставляет информацию об источнике устройства, а traceScreenInfo — информацию о контексте экрана.
Если метод ввода принимает событие и хочет захватить взаимодействие отслеживания, он должен вернуть новый объект QVirtualKeyboardTrace. Этот объект должен оставаться валидным до вызова метода traceEnd(). Если объект QVirtualKeyboardTrace отображается на экране, он остаётся на экране до уничтожения объекта QVirtualKeyboardTrace.
Эта функция была введена в QtQuick.VirtualKeyboard 2.0.
[virtual, since QtQuick.VirtualKeyboard 2.0] bool QVirtualKeyboardAbstractInputMethod::traceEnd(QVirtualKeyboardTrace *trace)
Этот метод вызывается при завершении взаимодействия отслеживания. Метод ввода должен уничтожить объект trace в какой-то момент после вызова этой функции. Смотрите API отслеживания для методов ввода, как получить собранные данные.
Метод возвращает true , если взаимодействие отслеживания принято.
Эта функция была введена в QtQuick.VirtualKeyboard 2.0.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qvirtualkeyboardabstractinputmethod.html