Класс QInputMethodEvent

Класс QInputMethodEvent предоставляет параметры для событий ввода. Подробнее...

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

Типы

Открытые функции

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

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

Обратите внимание, что при создании пользовательских виджетов редактирования текста атрибут окна Qt::WA_InputMethodEnabled должен быть явно установлен (с помощью функции QWidget::setAttribute() ), чтобы получать события метода ввода.

События представляют интерес для авторов виджетов ввода с клавиатуры, которые хотят правильно обрабатывать языки с сложным вводом символов. Ввод текста на таких языках обычно является трехэтапным процессом:

1. Начало составления текста

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

2. Составление текста

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

3. Завершение

   В какой-то момент пользователь активирует компонент пользовательского интерфейса (возможно, используя определенную клавишу), где он может выбрать из нескольких строк, соответствующих набранному тексту. Пользователь может либо подтвердить свой выбор, либо отменить ввод; в любом случае контекст ввода будет закрыт.

QInputMethodEvent моделирует эти три этапа и передает необходимую информацию для корректного отображения промежуточных результатов. QInputMethodEvent имеет два основных параметра: preeditString() и commitString(). Параметр preeditString() предоставляет текущую строку предварительного редактирования. Параметр commitString() предоставляет текст, который должен быть добавлен к (или заменить части) тексту виджета редактора. Обычно это результат операций ввода и должен быть вставлен в текст виджетов непосредственно перед строкой предварительного редактирования.

Если commitString() должен заменить части текста в редакторе, replacementLength() будет содержать количество символов, которые необходимо заменить. replacementStart() содержит позицию, в которой символы должны быть заменены, относительно начала строки предварительного редактирования.

Ряд атрибутов управляет визуальным отображением строки предварительного редактирования (визуальное отображение текста вне строки предварительного редактирования контролируется только виджетом). Перечисление AttributeType описывает различные атрибуты, которые можно установить.

Класс, реализующий QWidget::inputMethodEvent() или QGraphicsItem::inputMethodEvent(), должен по крайней мере понимать и соблюдать атрибуты TextFormat и Cursor.

Поскольку методам ввода необходимо иметь возможность запросить определенные свойства от виджета или графического элемента, подклассы также должны реализовать QWidget::inputMethodQuery() и QGraphicsItem::inputMethodQuery() соответственно.

При получении события метода ввода виджет текста должен выполнить следующие шаги:

1. Если у виджета выделен текст, выделенный текст должен быть удален.
2. Удалить текст, начиная с replacementStart() длиной replacementLength() и заменить его на commitString(). Если replacementLength() равно 0, replacementStart() указывает позицию вставки commitString().

   При замене область строки предварительного редактирования игнорируется, поэтому замена, начинающаяся с -1 длиной 2, удалит последний символ перед строкой предварительного редактирования и первый символ после неё и вставит строку подтверждения непосредственно перед строкой предварительного редактирования.

   Если виджет реализует отмену/повтор, эта операция добавляется в стек отмены/повтора.

3. Если нет текущей строки предварительного редактирования, вставить preeditString() в текущую позицию курсора; в противном случае заменить предыдущую preeditString на полученную от этого события.

   Если виджет реализует отмену/повтор, preeditString() никак не должна влиять на стек отмены/повтора.

   Виджет должен проверить список атрибутов, чтобы применить их к строке предварительного редактирования. Он должен понимать по крайней мере атрибуты TextFormat и Cursor и отображать их в соответствии со спецификацией.

См. также QInputMethod.

Документация по типам членов

перечисление QInputMethodEvent::AttributeType

См. также Attribute.

Документация функций-членов

QInputMethodEvent::QInputMethodEvent(const QInputMethodEvent &other)

Создаёт копию other.

QInputMethodEvent::QInputMethodEvent(const QString &preeditText, const QList<QInputMethodEvent::Attribute> &attributes)

Создаёт событие типа QEvent::InputMethod. Предварительный текст устанавливается в preeditText, а атрибуты — в attributes.

Значения commitString(), replacementStart() и replacementLength() могут быть установлены с помощью setCommitString().

См. также preeditString() и attributes().

QInputMethodEvent::QInputMethodEvent()

Создаёт событие типа QEvent::InputMethod. attributes(), preeditString(), commitString(), replacementStart() и replacementLength() инициализируются значениями по умолчанию.

См. также setCommitString().

const QList<QInputMethodEvent::Attribute> &QInputMethodEvent::attributes() const

Возвращает список атрибутов, переданных конструктору QInputMethodEvent. Атрибуты управляют визуальным отображением предварительного текста (визуальное отображение текста вне предварительного текста контролируется только виджетом).

См. также preeditString() и Attribute.

const QString &QInputMethodEvent::commitString() const

Возвращает текст, который должен быть добавлен к (или заменить части) текста виджета-редактора. Обычно он является результатом операций ввода и должен быть вставлен в текст виджета непосредственно перед предварительным текстом.

См. также setCommitString(), preeditString(), replacementStart() и replacementLength().

const QString &QInputMethodEvent::preeditString() const

Возвращает предварительный текст, то есть текст, который был до начала редактирования пользователем.

См. также commitString() и attributes().

int QInputMethodEvent::replacementLength() const

Возвращает количество символов, которые должны быть заменены в предварительном тексте.

См. также replacementStart() и setCommitString().

int QInputMethodEvent::replacementStart() const

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

См. также replacementLength() и setCommitString().

void QInputMethodEvent::setCommitString(const QString &commitString, int replaceFrom = 0, int replaceLength = 0)

Устанавливает строку подтверждения commitString.

Строка подтверждения — это текст, который должен быть добавлен к (или частично заменить) тексту виджета-редактора. Обычно он является результатом операций ввода и должен быть вставлен в текст виджета непосредственно перед предварительным текстом.

Если строка подтверждения должна заменить части текста в редакторе, replaceLength определяет количество заменяемых символов. replaceFrom определяет позицию, с которой символы должны быть заменены, относительно начала предварительного текста.

См. также commitString(), replacementStart() и replacementLength().