Skip to content

PythonQt.QtGui.QInputMethod · declarations 001

Back to PythonQt.QtGui.QInputMethod

Action instance-attribute

Action: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

Click instance-attribute

Click: Any

anchorRectangle instance-attribute

anchorRectangle: QRectF

Qt 5 reference:

anchorRectangle : const QRectF

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:

QRectF anchorRectangle() const

Notifier signal:

void anchorRectangleChanged()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#anchorRectangle

anchorRectangleChanged

anchorRectangleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.anchorRectangleChanged; argument details are not documented.

animating instance-attribute

animating: Any

Qt 5 reference:

animating : const bool

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()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#animating

animatingChanged

animatingChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.animatingChanged; argument details are not documented.

commit

commit() -> None

X.commit()

Supplemental documentation: Qt 5 reference:

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

Upstream PySide2 reference signatures (binding differences may apply):

commit(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#commit

cursorRectangle instance-attribute

cursorRectangle: QRectF

Qt 5 reference:

cursorRectangle : const QRectF

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:

QRectF cursorRectangle() const

Notifier signal:

void cursorRectangleChanged()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#cursorRectangle

cursorRectangleChanged

cursorRectangleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.cursorRectangleChanged; argument details are not documented.

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.destroyed; argument details are not documented.

hide

hide() -> None

X.hide()

Supplemental documentation: Qt 5 reference:

[slot] void QInputMethod::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.

Upstream PySide2 reference signatures (binding differences may apply):

hide(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#hide

inputDirection instance-attribute

inputDirection: Any

Qt 5 reference:

inputDirection : const Qt::LayoutDirection

Current input direction.

Access functions:

Qt::LayoutDirection inputDirection() const

Notifier signal:

void inputDirectionChanged(Qt::LayoutDirection newDirection)

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#inputDirection

inputDirectionChanged

inputDirectionChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.inputDirectionChanged; argument details are not documented.

inputItemClipRectangle instance-attribute

inputItemClipRectangle: QRectF

Qt 5 reference:

inputItemClipRectangle : const QRectF

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:

QRectF inputItemClipRectangle() const

Notifier signal:

void inputItemClipRectangleChanged()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#inputItemClipRectangle

inputItemClipRectangleChanged

inputItemClipRectangleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.inputItemClipRectangleChanged; argument details are not documented.

inputItemRectangle

inputItemRectangle() -> Any

X.inputItemRectangle() -> PythonQt.QtCore.QRectF

Supplemental documentation: Qt 5 reference:

QRectF QInputMethod::inputItemRectangle() const

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

This function was introduced in Qt 5.1.

See also setInputItemRectangle().

Upstream PySide2 reference signatures (binding differences may apply):

inputItemRectangle(self) -> PySide2.QtCore.QRectF

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#inputItemRectangle

inputItemTransform

inputItemTransform() -> Any

X.inputItemTransform() -> PythonQt.QtGui.QTransform

Supplemental documentation: Qt 5 reference:

QTransform QInputMethod::inputItemTransform() const

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

See also setInputItemTransform().

Upstream PySide2 reference signatures (binding differences may apply):

inputItemTransform(self) -> PySide2.QtGui.QTransform

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#inputItemTransform

invokeAction

invokeAction(a: Any, cursorPosition: int) -> None

X.invokeAction(a, cursorPosition)

Supplemental documentation: Qt 5 reference:

[slot] void QInputMethod::invokeAction(QInputMethod::Action a, int cursorPosition)

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.

Upstream PySide2 reference signatures (binding differences may apply):

invokeAction(self, a: PySide2.QtGui.QInputMethod.Action, cursorPosition: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#invokeAction

isAnimating

isAnimating() -> bool

X.isAnimating() -> bool

Upstream PySide2 reference signatures (binding differences may apply):

isAnimating(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#isAnimating

isVisible

isVisible() -> bool

X.isVisible() -> bool

Upstream PySide2 reference signatures (binding differences may apply):

isVisible(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#isVisible

keyboardRectangle instance-attribute

keyboardRectangle: QRectF

Qt 5 reference:

keyboardRectangle : const QRectF

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:

QRectF keyboardRectangle() const

Notifier signal:

void keyboardRectangleChanged()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#keyboardRectangle

keyboardRectangleChanged

keyboardRectangleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.keyboardRectangleChanged; argument details are not documented.

locale instance-attribute

locale: QLocale

Qt 5 reference:

locale : const QLocale

Current input locale.

Access functions:

QLocale locale() const

Notifier signal:

void localeChanged()

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#locale

localeChanged

localeChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.localeChanged; argument details are not documented.

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.objectNameChanged; argument details are not documented.

queryFocusObject

queryFocusObject(query: Any, argument: Any) -> Any

X.queryFocusObject(query, argument) -> object

Supplemental documentation: Qt 5 reference:

[static] QVariant QInputMethod::queryFocusObject(Qt::InputMethodQuery query, QVariant argument)

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

Upstream PySide2 reference signatures (binding differences may apply):

queryFocusObject(query: PySide2.QtCore.Qt.InputMethodQuery, argument: typing.Any) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#queryFocusObject

reset

reset() -> None

X.reset()

Supplemental documentation: Qt 5 reference:

[slot] void QInputMethod::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.

Upstream PySide2 reference signatures (binding differences may apply):

reset(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#reset

setInputItemRectangle

setInputItemRectangle(rect: Any) -> None

X.setInputItemRectangle(rect)

Supplemental documentation: Qt 5 reference:

void QInputMethod::setInputItemRectangle(const QRectF \&rect)

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 inputItemRectangle().

Upstream PySide2 reference signatures (binding differences may apply):

setInputItemRectangle(self, rect: PySide2.QtCore.QRectF) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#setInputItemRectangle

setInputItemTransform

setInputItemTransform(transform: Any) -> None

X.setInputItemTransform(transform)

Supplemental documentation: Qt 5 reference:

void QInputMethod::setInputItemTransform(const QTransform \&transform)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setInputItemTransform(self, transform: PySide2.QtGui.QTransform) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#setInputItemTransform

setVisible

setVisible(visible: bool) -> None

X.setVisible(visible)

Supplemental documentation: Qt 5 reference:

void QInputMethod::setVisible(bool visible)

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

See also isVisible(), show(), and hide().

Upstream PySide2 reference signatures (binding differences may apply):

setVisible(self, visible: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#setVisible

show

show() -> None

X.show()

Supplemental documentation: Qt 5 reference:

[slot] void QInputMethod::show()

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.

Upstream PySide2 reference signatures (binding differences may apply):

show(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#show

update

update(queries: Any) -> None

X.update(queries)

Supplemental documentation: Qt 5 reference:

[slot] void QInputMethod::update(Qt::InputMethodQueries queries)

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.

Upstream PySide2 reference signatures (binding differences may apply):

update(self, queries: PySide2.QtCore.Qt.InputMethodQueries) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#update

visible instance-attribute

visible: Any

Qt 5 reference:

visible : const bool

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 show() and hide().

Source: https://doc.qt.io/archives/qt-5.15/qinputmethod.html#visible

visibleChanged

visibleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputMethod.visibleChanged; argument details are not documented.