Тип 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)

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

Примечание: Соответствующий обработчик — onSelectionListActiveItemChanged.

selectionListChanged(int type)

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

Примечание: Соответствующий обработчик — onSelectionListChanged.

selectionListsChanged()

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

Примечание: Соответствующий обработчик — onSelectionListsChanged.

Этот сигнал был представлен в 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 содержит текстовое значение Unicode для клавиши. Параметр 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.

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

bool traceEnd(Trace trace)

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

См. Trace API для методов ввода, чтобы узнать, как получить собранные данные.

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

update()

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