Тип QML InputMethod

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

Заявление об импорте: import QtQuick.VirtualKeyboard

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

Свойства

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.

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

selectionListChanged(int type)

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

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

`[since QtQuick.VirtualKeyboard 2.2]` selectionListsChanged()

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

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

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

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

`[since QtQuick.VirtualKeyboard 2.4]` 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, событие нажатия клавиши перенаправляется на стандартный метод ввода для дальнейшей обработки.

`[since QtQuick.VirtualKeyboard 2.0]` list<int> patternRecognitionModes()

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

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

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

`[since 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(). Этот сигнал вызовет этот метод, позволяя методу ввода обновить типы списков выбора.

END_OF_DOCUMENT_MARKER

bool setInputMode(string locale, int inputMode)

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

bool setTextCase(int textCase)

Обновляет textCase для данного метода ввода. Метод возвращает true в случае успеха.

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

InputEngine.Lower Текст строчными буквами.
InputEngine.Upper Текст заглавными буквами.

`[since QtQuick.VirtualKeyboard 2.0]` Trace traceBegin(int traceId, int patternRecognitionMode, var traceCaptureDeviceInfo, var traceScreenInfo)

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

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

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

`[since QtQuick.VirtualKeyboard 2.0]` bool traceEnd(Trace trace)

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

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