QInputMethod Class

Indicates the kind of action performed by the user.

See Also▲

Input item's anchor rectangle in window coordinates.

Anchor rectangle is often used by various text editing controls like text prediction popups for following the text selection.

Access functions:

• anchorRectangle() const

Notifier signal:

• void anchorRectangleChanged()

True when the virtual keyboard is being opened or closed.

Animating is false when keyboard is fully open or closed. When animating is true and visibility is true keyboard is being opened. When animating is true and visibility is false keyboard is being closed.

Access functions:

• bool isAnimating() const

Notifier signal:

• void animatingChanged()

Input item's cursor rectangle in window coordinates.

Cursor rectangle is often used by various text editing controls like text prediction popups for following the text being typed.

Access functions:

• cursorRectangle() const

Notifier signal:

• void cursorRectangleChanged()

Current input direction.

Access functions:

• inputDirection() const

Notifier signal:

• void inputDirectionChanged( newDirection)

Input item's clipped rectangle in window coordinates.

The clipped input rectangle is often used by various input methods to determine how much screen real estate is available for the input method (e.g. Virtual Keyboard).

Access functions:

• inputItemClipRectangle() const

Notifier signal:

• void inputItemClipRectangleChanged()

Virtual keyboard's geometry in window coordinates.

This might be an empty rectangle if it is not possible to know the geometry of the keyboard. This is the case for a floating keyboard on android.

Access functions:

• keyboardRectangle() const

Notifier signal:

• void keyboardRectangleChanged()

Current input locale.

Access functions:

• locale() const

Notifier signal:

• void localeChanged()

Virtual keyboard's visibility on the screen

Input method visibility remains false for devices with no virtual keyboards.

Access functions:

• bool isVisible() const

Notifier signal:

• void visibleChanged()

See Also▲

Commits the word user is currently composing to the editor. The function is mostly needed by the input methods with text prediction features and by the methods where the script used for typing characters is different from the script that actually gets appended to the editor. Any kind of action that interrupts the text composing needs to flush the composing state by calling the commit() function, for example when the cursor is moved elsewhere.

Requests virtual keyboard to close.

Normally applications should not need to call this function, keyboard should automatically close when the text editor loses focus, for example when the parent view is closed.

Returns the input item's geometry in input item coordinates.

This function was introduced in Qt 5.1.

See Also▲

Returns the transformation from input item coordinates to the window coordinates.

See Also▲

Called by the input item when the word currently being composed is tapped by the user, as indicated by the action a and the given cursorPosition. Input methods often use this information to offer more word suggestions to the user.

Send query to the current focus object with parameters argument and return the result.

Resets the input method state. For example, a text editor normally calls this method before inserting a text to make widget ready to accept a text.

Input method resets automatically when the focused editor changes.

Sets the input item's geometry to be rect, in input item coordinates. This needs to be updated by the focused window like QQuickCanvas whenever item is moved inside the scene, or focus is changed.

This function was introduced in Qt 5.1.

See Also▲

Sets the transformation from input item coordinates to window coordinates to be transform. Item transform needs to be updated by the focused window like QQuickCanvas whenever item is moved inside the scene.

See Also▲

Controls the keyboard visibility. Equivalent to calling show() (if visible is true) or hide() (if visible is false).

See Also▲

Requests virtual keyboard to open. If the platform doesn't provide virtual keyboard the visibility remains false.

Normally applications should not need to call this function, keyboard should automatically open when the text editor gains focus.

Called by the input item to inform the platform input methods when there has been state changes in editor's input method query attributes. When calling the function queries parameter has to be used to tell what has changes, which input method can use to make queries for attributes it's interested with QInputMethodQueryEvent.

In particular calling update whenever the cursor position changes is important as that often causes other query attributes like surrounding text and text selection to change as well. The attributes that often change together with cursor position have been grouped in Qt::ImQueryInput value for convenience.