Тип QML InputMethod

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

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

Свойства

• inputContext : InputContext
• inputEngine : InputEngine

Сигналы

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

Методы

• bool clickPreeditText(int cursorPosition)
• 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(), позволяя методу ввода обновить типы списков выбора.

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

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

bool clickPreeditText(int cursorPosition)

Вызывается, когда пользователь нажимает на предварительно отредактированный текст в позиции cursorPosition.

Функция должна вернуть true если она обрабатывает событие. В противном случае ввод перенаправляется на reselect() для дальнейшей обработки.

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

list<int> inputModes(string locale)

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

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

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

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

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

list<int> patternRecognitionModes()

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

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

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

bool reselect(int cursorPosition, int reselectFlags)

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

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

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

Этот метод был представлен в 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.

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

bool traceEnd(Trace trace)

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

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

update()

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