Qt 4.8
|
The QInputMethodEvent class provides parameters for input method events. More...
#include <qevent.h>
Classes | |
class | Attribute |
The QInputMethodEvent::Attribute class stores an input method attribute. More... | |
Public Functions | |
const QList< Attribute > & | attributes () const |
Returns the list of attributes passed to the QInputMethodEvent constructor. More... | |
const QString & | commitString () const |
Returns the text that should get added to (or replace parts of) the text of the editor widget. More... | |
const QString & | preeditString () const |
Returns the preedit text, i. More... | |
QInputMethodEvent () | |
Constructs an event of type QEvent::InputMethod. More... | |
QInputMethodEvent (const QString &preeditText, const QList< Attribute > &attributes) | |
Construcs an event of type QEvent::InputMethod. More... | |
QInputMethodEvent (const QInputMethodEvent &other) | |
Constructs a copy of other. More... | |
int | replacementLength () const |
Returns the number of characters to be replaced in the preedit string. More... | |
int | replacementStart () const |
Returns the position at which characters are to be replaced relative from the start of the preedit string. More... | |
void | setCommitString (const QString &commitString, int replaceFrom=0, int replaceLength=0) |
Sets the commit string to commitString. More... | |
Public Functions inherited from QEvent | |
void | accept () |
Sets the accept flag of the event object, the equivalent of calling setAccepted(true). More... | |
void | ignore () |
Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). More... | |
bool | isAccepted () const |
QEvent (Type type) | |
Contructs an event object of type type. More... | |
void | setAccepted (bool accepted) |
bool | spontaneous () const |
Returns true if the event originated outside the application (a system event); otherwise returns false. More... | |
Type | type () const |
Returns the event type. More... | |
virtual | ~QEvent () |
Destroys the event. More... | |
Properties | |
QList< Attribute > | attrs |
QString | commit |
QString | preedit |
int | replace_from |
int | replace_length |
Additional Inherited Members | |
Static Public Functions inherited from QEvent | |
static int | registerEventType (int hint=-1) |
Registers and returns a custom event type. More... | |
Protected Variables inherited from QEvent | |
QEventPrivate * | d |
ushort | t |
The QInputMethodEvent class provides parameters for input method events.
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:
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.
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.
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 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:
If the widget has selected text, the selected text should get removed.
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.
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.
A QTextCharFormat for the part of the preedit string specified by start and length.
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.Enumerator | |
---|---|
TextFormat | |
Cursor | |
Language | |
Ruby | |
Selection |
Definition at line 434 of file qevent.h.
QInputMethodEvent::QInputMethodEvent | ( | ) |
Constructs an event of type QEvent::InputMethod.
The attributes(), preeditString(), commitString(), replacementStart(), and replacementLength() are initialized to default values.
Definition at line 1996 of file qevent.cpp.
QInputMethodEvent::QInputMethodEvent | ( | const QString & | preeditText, |
const QList< Attribute > & | attributes | ||
) |
Construcs 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().
Definition at line 2011 of file qevent.cpp.
QInputMethodEvent::QInputMethodEvent | ( | const QInputMethodEvent & | other | ) |
Constructs a copy of other.
Definition at line 2020 of file qevent.cpp.
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).
Definition at line 454 of file qevent.h.
Referenced by QTextControlPrivate::inputMethodEvent(), and QWSServer::sendIMEvent().
|
inline |
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.
Definition at line 457 of file qevent.h.
Referenced by QTextControlPrivate::inputMethodEvent(), QLineEdit::inputMethodEvent(), QComboBox::inputMethodEvent(), QAbstractItemView::inputMethodEvent(), QLineControl::processInputMethodEvent(), QWSServer::sendIMEvent(), and setCommitString().
|
inline |
Returns the preedit text, i.
e. the text before the user started editing it.
Definition at line 455 of file qevent.h.
Referenced by QTextControlPrivate::inputMethodEvent(), QLineEdit::inputMethodEvent(), QLineControl::processInputMethodEvent(), and QWSServer::sendIMEvent().
|
inline |
Returns the number of characters to be replaced in the preedit string.
Definition at line 459 of file qevent.h.
Referenced by QTextControlPrivate::inputMethodEvent(), QLineControl::processInputMethodEvent(), and QWSServer::sendIMEvent().
|
inline |
Returns the position at which characters are to be replaced relative from the start of the preedit string.
Definition at line 458 of file qevent.h.
Referenced by QTextControlPrivate::inputMethodEvent(), QLineControl::processInputMethodEvent(), and QWSServer::sendIMEvent().
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 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.
Definition at line 2042 of file qevent.cpp.
Referenced by QMacInputContext::globalEventProcessor(), QMacInputContext::reset(), QWinInputContext::reset(), QXIMInputContext::reset(), QWSInputMethod::sendCommitString(), QWSInputContext::translateIMEvent(), and QXIMInputContext::x11FilterEvent().
|
private |
Definition at line 466 of file qevent.h.
Referenced by setCommitString().
|
private |
Definition at line 467 of file qevent.h.
Referenced by setCommitString().
|
private |
Definition at line 468 of file qevent.h.
Referenced by setCommitString().