Тип QML InputMethod

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

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

Свойства

• inputContext : InputContext
• inputEngine : InputEngine

Сигналы

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

Методы

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

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

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

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

inputContext : InputContext

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

inputEngine : InputEngine

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

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

selectionListActiveItemChanged(type, int index)

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

selectionListChanged(type)

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

selectionListsChanged()

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

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

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

bool clickPreeditText(cursorPosition)

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

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

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

list<int> inputModes(locale)

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

bool keyEvent(key, string text, int modifiers)

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

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

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

list<int> patternRecognitionModes()

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

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

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

bool reselect(cursorPosition, int reselectFlags)

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

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

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

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

reset()

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

var selectionListData(type, int index, int role)

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

int selectionListItemCount(type)

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

void selectionListItemSelected(type, int index)

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

list<int> selectionLists()

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

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

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

bool setInputMode(locale, int inputMode)

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

bool setTextCase(textCase)

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

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

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

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

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

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

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

bool traceEnd(trace)

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

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

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

update()

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