QInputMethodEvent Class | Qt GUI 6.7.0
Description: The QInputMethodEvent class provides parameters for input method events.

- Qt 6.7
- Qt GUI
- C++ Classes
- QInputMethodEvent
- Qt 6.7.0 Reference Documentation

# QInputMethodEvent Class

The QInputMethodEvent class provides parameters for input method events. More...

Header: | #include <QInputMethodEvent>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: | QT += gui
Inherits: | QEvent

- List of all members, including inherited members
- QInputMethodEvent is part of Event Classes.

## Public Types

class | Attribute
enum | AttributeType { TextFormat, Cursor, Language, Ruby, Selection }

## Public Functions

| QInputMethodEvent()
| QInputMethodEvent(const QString &preeditText, const QList<QInputMethodEvent::Attribute> &attributes)
const QList<QInputMethodEvent::Attribute> & | attributes() const
const QString & | commitString() const
const QString & | preeditString() const
int | replacementLength() const
int | replacementStart() const
void | setCommitString(const QString &commitString, int replaceFrom = 0, int replaceLength = 0)

## Detailed Description

Input method events are sent to widgets when an input method is used to enter text into a widget. Input methods are widely used to enter text for languages with non-Latin alphabets.

Note that when creating custom text editing widgets, the Qt::WA_InputMethodEnabled window attribute must be set explicitly (using the QWidget::setAttribute() function) in order to receive input method events.

The events are of interest to authors of keyboard entry widgets who want to be able to correctly handle languages with complex character input. Text input in such languages is usually a three step process:

1. Starting to Compose

   When the user presses the first key on a keyboard, an input context is created. This input context will contain a string of the typed characters.

2. Composing

   With every new key pressed, the input method will try to create a matching string for the text typed so far called preedit string. While the input context is active, the user can only move the cursor inside the string belonging to this input context.

3. Completing

   At some point, the user will activate a user interface component (perhaps using a particular key) where they can choose from a number of strings matching the text they have typed so far. The user can either confirm their choice cancel the input; in either case the input context will be closed.

QInputMethodEvent models these three stages, and transfers the information needed to correctly render the intermediate result. A QInputMethodEvent has two main parameters: preeditString() and commitString(). The preeditString() parameter gives the currently active preedit string. The commitString() parameter gives a text that should get added to (or replace parts of) the text of the editor widget. It usually is a result of the input operations and has to be inserted to the widgets text directly before the preedit string.

If the commitString() should replace parts of the text in the editor, replacementLength() will contain the number of characters to be replaced. replacementStart() contains the position at which characters are to be replaced relative from the start of the preedit string.

A number of attributes control the visual appearance of the preedit string (the visual appearance of text outside the preedit string is controlled by the widget only). The AttributeType enum describes the different attributes that can be set.

A class implementing QWidget::inputMethodEvent() or QGraphicsItem::inputMethodEvent() should at least understand and honor the TextFormat and Cursor attributes.

Since input methods need to be able to query certain properties from the widget or graphics item, subclasses must also implement QWidget::inputMethodQuery() and QGraphicsItem::inputMethodQuery(), respectively.

When receiving an input method event, the text widget has to performs the following steps:

1. If the widget has selected text, the selected text should get removed.
2. Remove the text starting at replacementStart() with length replacementLength() and replace it by the commitString(). If replacementLength() is 0, replacementStart() gives the insertion position for the commitString().

   When doing replacement the area of the preedit string is ignored, thus a replacement starting at -1 with a length of 2 will remove the last character before the preedit string and the first character afterwards, and insert the commit string directly before the preedit string.

   If the widget implements undo/redo, this operation gets added to the undo stack.

3. If there is no current preedit string, insert the preeditString() at the current cursor position; otherwise replace the previous preeditString with the one received from this event.

   If the widget implements undo/redo, the preeditString() should not influence the undo/redo stack in any way.

   The widget should examine the list of attributes to apply to the preedit string. It has to understand at least the TextFormat and Cursor attributes and render them as specified.

See also QInputMethod.

## Member Type Documentation

### enum QInputMethodEvent::AttributeType

Constant | Value | Description
--- | --- | ---
`QInputMethodEvent::TextFormat` | `0` | A QTextCharFormat for the part of the preedit string specified by start and length. value contains a QVariant of type QTextFormat specifying rendering of this part of the preedit string. There should be at most one format for every part of the preedit string. If several are specified for any character in the string the behaviour is undefined. A conforming implementation has to at least honor the backgroundColor, textColor and fontUnderline properties of the format.
`QInputMethodEvent::Cursor` | `1` | If set, a cursor should be shown inside the preedit string at position start. The length variable determines whether the cursor is visible or not. If the length is 0 the cursor is invisible. If value is a QVariant of type QColor this color will be used for rendering the cursor, otherwise the color of the surrounding text will be used. There should be at most one Cursor attribute per event. If several are specified the behaviour is undefined.
`QInputMethodEvent::Language` | `2` | The variant contains a QLocale object specifying the language of a certain part of the preedit string. There should be at most one language set for every part of the preedit string. If several are specified for any character in the string the behavior is undefined.
`QInputMethodEvent::Ruby` | `3` | The ruby text for a part of the preedit string. There should be at most one ruby text set for every part of the preedit string. If several are specified for any character in the string the behaviour is undefined.
`QInputMethodEvent::Selection` | `4` | If set, the edit cursor should be moved to the specified position in the editor text contents. In contrast with `Cursor`, this attribute does not work on the preedit text, but on the surrounding text. The cursor will be moved after the commit string has been committed, and the preedit string will be located at the new edit position. The start position specifies the new position and the length variable can be used to set a selection starting from that point. The value is unused.

See also Attribute.

## Member Function Documentation

### QInputMethodEvent::QInputMethodEvent()

Constructs an event of type QEvent::InputMethod. The attributes(), preeditString(), commitString(), replacementStart(), and replacementLength() are initialized to default values.

See also setCommitString().

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

Constructs an event of type QEvent::InputMethod. The preedit text is set to preeditText, the attributes to attributes.

The commitString(), replacementStart(), and replacementLength() values can be set using setCommitString().

See also preeditString() and attributes().

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

Returns the list of attributes passed to the QInputMethodEvent constructor. The attributes control the visual appearance of the preedit string (the visual appearance of text outside the preedit string is controlled by the widget only).

See also preeditString() and Attribute.

### const QString &QInputMethodEvent::commitString() const

Returns the text that should get added to (or replace parts of) the text of the editor widget. It usually is a result of the input operations and has to be inserted to the widgets text directly before the preedit string.

See also setCommitString(), preeditString(), replacementStart(), and replacementLength().

### const QString &QInputMethodEvent::preeditString() const

Returns the preedit text, i.e. the text before the user started editing it.

See also commitString() and attributes().

### int QInputMethodEvent::replacementLength() const

Returns the number of characters to be replaced in the preedit string.

See also replacementStart() and setCommitString().

### int QInputMethodEvent::replacementStart() const

Returns the position at which characters are to be replaced relative from the start of the preedit string.

See also replacementLength() and setCommitString().

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

Sets the commit string to commitString.

The commit string is the text that should get added to (or replace parts of) the text of the editor widget. It usually is a result of the input operations and has to be inserted to the widgets text directly before the preedit string.

If the commit string should replace parts of the text in the editor, replaceLength specifies the number of characters to be replaced. replaceFrom specifies the position at which characters are to be replaced relative from the start of the preedit string.

See also commitString(), replacementStart(), and replacementLength().