Тип QML InputMethod

Базовый тип для создания метода ввода в QML. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• inputContext : InputContext
• inputEngine : InputEngine

Сигналы

• selectionListActiveItemChanged(int type, int index)
• selectionListChanged(int type)
• selectionListsChanged()

Методы

• list<int> inputModes(string locale)
• bool keyEvent(int key, string text, int modifiers)
• list<int> patternRecognitionModes()
• bool reselect(int cursorPosition, int reselectFlags)
• reset()
• var selectionListData(int type, int index, int role)
• int selectionListItemCount(int type)
• void selectionListItemSelected(int type, int index)
• list<int> selectionLists()
• bool setInputMode(string locale, int inputMode)
• bool setTextCase(int textCase)
• Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)
• bool traceEnd(Trace trace)
• update()

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

Тип InputMethod позволяет создавать пользовательский метод ввода, который может быть назначен InputEngine.

Документация по свойствам

inputContext : InputContext

Контекст ввода.

inputEngine : InputEngine

Двигатель ввода.

Документация по сигналам

selectionListActiveItemChanged(int type, int index)

Метод ввода отправляет этот сигнал, когда текущий индекс изменился в списке выбора, идентифицируемом type.

selectionListChanged(int type)

Метод ввода отправляет этот сигнал, когда содержимое списка выбора изменяется. Параметр type указывает, какой список выбора изменился.

selectionListsChanged()

Метод ввода отправляет этот сигнал, когда типы списков выбора изменяются. Этот сигнал вызовет метод selectionLists(), что позволит методу ввода обновить типы списков выбора.

Этот QML-сигнал был введен в QtQuick.VirtualKeyboard 2.2.

Документация по методам

list<int> inputModes(string locale)

Возвращает список режимов ввода для locale.

bool keyEvent(int key, string text, int modifiers)

Цель этого метода — обработать события нажатия клавиш, сгенерированные движком ввода.

Параметр key указывает код клавиши, которую нужно обработать. Код клавиши не различает заглавные и строчные буквы. Параметр text содержит текстовое представление клавиши в формате Unicode. Параметр modifiers содержит модификаторы клавиш, применимые к key.

Этот метод возвращает true если событие нажатия клавиши было успешно обработано. Если возвращаемое значение равно false, событие нажатия клавиши перенаправляется на метод ввода по умолчанию для дальнейшей обработки.

list<int> patternRecognitionModes()

Возвращает список поддерживаемых режимов распознавания шаблонов.

Этот метод вызывается движком ввода для запроса списка поддерживаемых режимов распознавания шаблонов.

Этот метод QML был введён в QtQuick.VirtualKeyboard 2.0.

bool reselect(int cursorPosition, int reselectFlags)

Этот метод пытается повторно выделить слово, расположенное в позиции cursorPosition. Параметр reselectFlags определяет правила выбора слова относительно позиции курсора.

• InputEngine.WordBeforeCursor Активирует слово перед курсором. Когда этот флаг используется исключительно, слово должно заканчиваться точно в позиции курсора.
• InputEngine.WordAfterCursor Активирует слово после курсора. Когда этот флаг используется исключительно, слово должно начинаться точно в позиции курсора.
• InputEngine.WordAtCursor Активирует слово в позиции курсора. Этот флаг является комбинацией вышеуказанных флагов, за исключением того, что слово не может начинаться или заканчиваться на курсоре.

Метод возвращает true если слово было успешно повторно выделено.

Этот метод QML был введён в QtQuick.VirtualKeyboard 2.0.

reset()

Этот метод вызывается движком ввода, когда метод ввода необходимо сбросить. Метод ввода должен только сбросить своё внутреннее состояние. Основное отличие от метода update() заключается в том, что reset() изменяет только состояние метода ввода; он не должен изменять контекст ввода.

var selectionListData(int type, int index, int role)

Возвращает данные элемента списка выбора, идентифицированного параметром type. Параметр role определяет запрашиваемые данные. Параметр index — индекс элемента в списке выбора, отсчитываемый с нуля.

int selectionListItemCount(int type)

Возвращает количество элементов в списке выбора, идентифицированном параметром type.

void selectionListItemSelected(int type, int index)

Этот метод вызывается, когда пользователь выбрал элемент с индексом index. Список выбора идентифицируется параметром type.

list<int> selectionLists()

Возвращает список типов списков выбора, используемых для этого метода ввода.

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

Метод ввода может запросить у движка ввода обновление списков выбора в любое время, выпустив сигнал selectionListsChanged(). Этот сигнал вызовет этот метод, позволяя методу ввода обновить типы списков выбора.

bool setInputMode(string locale, int inputMode)

Изменяет inputMode и locale для этого метода ввода. Метод возвращает true при успешном выполнении.

bool setTextCase(int textCase)

Обновляет textCase для этого метода ввода. Метод возвращает true при успешном выполнении.

Возможные значения для регистра текста:

• InputEngine.Lower Текст в нижнем регистре.
• InputEngine.Upper Текст в верхнем регистре.

Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)

Этот метод вызывается при начале взаимодействия отслеживания с указанным значением patternRecognitionMode. Отслеживание уникально идентифицируется значением traceId. traceCaptureDeviceInfo содержит информацию об устройстве-источнике, а traceScreenInfo — информацию о контексте экрана.

Если метод ввода принимает событие и хочет захватить отслеживание ввода, он должен вернуть новый объект Trace. Этот объект должен оставаться валидным до вызова метода InputMethod.traceEnd(). Если Trace отображается на экране, он остается там до уничтожения объекта Trace.

Этот метод QML был представлен в QtQuick.VirtualKeyboard 2.0.

bool traceEnd(Trace trace)

Этот метод вызывается при завершении взаимодействия отслеживания. Метод ввода должен уничтожить объект trace в какой-то момент после вызова этой функции. См. API Trace, чтобы узнать, как получить собранные данные.

Этот метод QML был представлен в QtQuick.VirtualKeyboard 2.0.

update()

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