QInputMethod露

PyQt5.QtGui.QInputMethod: Inherits from QObject.

Description露

The QInputMethod class provides access to the active text input method.

QInputMethod is used by the text editors for integrating to the platform text input methods and more commonly by application views for querying various text input method-related information like virtual keyboard visibility and keyboard dimensions.

Qt Quick also provides access to QInputMethod in QML through Qt global object as Qt.inputMethod property.

Enums露

Action

Indicates the kind of action performed by the user.

Methods露

anchorRectangle() → QRectF: TODO

commit(): 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 function, for example when the cursor is moved elsewhere.

cursorRectangle() → QRectF: TODO

hide()

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.

inputDirection() → LayoutDirection: TODO

inputItemClipRectangle() → QRectF: TODO

inputItemRectangle() → QRectF: Returns the input item鈥檚 geometry in input item coordinates.

See also

setInputItemRectangle().

inputItemTransform() → QTransform: Returns the transformation from input item coordinates to the window coordinates.

See also

setInputItemTransform().

invokeAction(Action, int): 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.

isAnimating() → bool: TODO

isVisible() → bool: TODO

keyboardRectangle() → QRectF: TODO

locale() → QLocale: TODO

@staticmethod queryFocusObject(InputMethodQuery, Any) → Any: Send query to the current focus object with parameters argument and return the result.

reset()

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.

setInputItemRectangle(QRectF): Sets the input item鈥檚 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.

See also

inputItemRectangle().

setInputItemTransform(QTransform): 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

inputItemTransform().

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

See also

show(), hide().

show()

Requests virtual keyboard to open. If the platform doesn鈥檛 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.

update(Union[InputMethodQueries, InputMethodQuery]): TODO

Signals露

anchorRectangleChanged(): TODO

animatingChanged(): TODO

cursorRectangleChanged(): TODO

inputDirectionChanged(LayoutDirection): TODO

inputItemClipRectangleChanged(): TODO

keyboardRectangleChanged(): TODO

localeChanged(): TODO

visibleChanged(): TODO

Member	Value	Description
Click	0	A normal click/tap
ContextMenu	1	A context menu click/tap (e.g. right-button or tap-and-hold)