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.
- class PySide6.QtGui.QInputMethod#
Indicates the kind of action performed by the user.
A normal click/tap
A context menu click/tap (e.g. right-button or tap-and-hold)
This property holds 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.
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.
This property holds 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.
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.
This property holds Current input direction..
This property holds 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).
Returns the input item’s geometry in input item coordinates.
Returns the transformation from input item coordinates to the window coordinates.
- PySide6.QtGui.QInputMethod.invokeAction(a, cursorPosition)#
cursorPosition – 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.
- Return type
This property holds True when the virtual keyboard is being opened or closed..
Animating is false when keyboard is fully open or closed. When
true keyboard is being opened. When
visibility is false keyboard is being closed.
- Return type
This property holds Virtual keyboard’s visibility on the screen.
Input method visibility remains false for devices with no virtual keyboards.
This property holds 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.
This property holds Current input locale..
- static PySide6.QtGui.QInputMethod.queryFocusObject(query, argument)#
argument – object
- Return type
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.
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.
visible – bool
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
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
ImQueryInput value for convenience.