API reference - Class QInputMethod

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QInputMethod

Class hierarchy: QInputMethod » QObject

Sub-classes: Action, QFlags_Action

Public methods

void_createEnsures the C++ object is created
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]boolanimatingMethod bool QInputMethod::isAnimating()
[signal]voidanimatingChangedSignal declaration for QInputMethod::animatingChanged()
voidcommitMethod void QInputMethod::commit()
[const]QRectFcursorRectangleMethod QRectF QInputMethod::cursorRectangle()
[signal]voidcursorRectangleChangedSignal declaration for QInputMethod::cursorRectangleChanged()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QInputMethod::destroyed(QObject *)
voidhideMethod void QInputMethod::hide()
[const]Qt_LayoutDirectioninputDirectionMethod Qt::LayoutDirection QInputMethod::inputDirection()
[signal]voidinputDirectionChanged(const Qt_LayoutDirection newDirection)Signal declaration for QInputMethod::inputDirectionChanged(Qt::LayoutDirection newDirection)
[const]QRectFinputItemRectangleMethod QRectF QInputMethod::inputItemRectangle()
voidinputItemRectangle=(const QRectF rect)Method void QInputMethod::setInputItemRectangle(const QRectF &rect)
[const]QTransforminputItemTransformMethod QTransform QInputMethod::inputItemTransform()
voidinputItemTransform=(const QTransform transform)Method void QInputMethod::setInputItemTransform(const QTransform &transform)
voidinvokeAction(const QInputMethod_Action a,
int cursorPosition)
Method void QInputMethod::invokeAction(QInputMethod::Action a, int cursorPosition)
[const]boolisAnimating?Method bool QInputMethod::isAnimating()
[const]boolisVisible?Method bool QInputMethod::isVisible()
[const]QRectFkeyboardRectangleMethod QRectF QInputMethod::keyboardRectangle()
[signal]voidkeyboardRectangleChangedSignal declaration for QInputMethod::keyboardRectangleChanged()
[const]QLocalelocaleMethod QLocale QInputMethod::locale()
[signal]voidlocaleChangedSignal declaration for QInputMethod::localeChanged()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QInputMethod::objectNameChanged(const QString &objectName)
voidresetMethod void QInputMethod::reset()
voidsetInputItemRectangle(const QRectF rect)Method void QInputMethod::setInputItemRectangle(const QRectF &rect)
voidsetInputItemTransform(const QTransform transform)Method void QInputMethod::setInputItemTransform(const QTransform &transform)
voidsetVisible(bool visible)Method void QInputMethod::setVisible(bool visible)
voidshowMethod void QInputMethod::show()
voidupdate(Qt_QFlags_InputMethodQuery queries)Method void QInputMethod::update(QFlags<Qt::InputMethodQuery> queries)
[const]boolvisibleMethod bool QInputMethod::isVisible()
[signal]voidvisibleChangedSignal declaration for QInputMethod::visibleChanged()

Public static methods and constants

[static,const]QInputMethod_ActionClickEnum constant QInputMethod::Click
[static,const]QInputMethod_ActionContextMenuEnum constant QInputMethod::ContextMenu
variantqueryFocusObject(const Qt_InputMethodQuery query,
variant argument)
Static method QVariant QInputMethod::queryFocusObject(Qt::InputMethodQuery query, QVariant argument)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QInputMethod::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QInputMethod::trUtf8(const char *s, const char *c, int n)

Detailed description

Click

Signature: [static,const] QInputMethod_Action Click

Description: Enum constant QInputMethod::Click

Python specific notes:
The object exposes a readable attribute 'Click'. This is the getter.

ContextMenu

Signature: [static,const] QInputMethod_Action ContextMenu

Description: Enum constant QInputMethod::ContextMenu

Python specific notes:
The object exposes a readable attribute 'ContextMenu'. This is the getter.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

animating

Signature: [const] bool animating

Description: Method bool QInputMethod::isAnimating()

Python specific notes:
The object exposes a readable attribute 'animating'. This is the getter.

animatingChanged

Signature: [signal] void animatingChanged

Description: Signal declaration for QInputMethod::animatingChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'animatingChanged'. This is the getter.
The object exposes a writable attribute 'animatingChanged'. This is the setter.

commit

Signature: void commit

Description: Method void QInputMethod::commit()

cursorRectangle

Signature: [const] QRectF cursorRectangle

Description: Method QRectF QInputMethod::cursorRectangle()

Python specific notes:
The object exposes a readable attribute 'cursorRectangle'. This is the getter.

cursorRectangleChanged

Signature: [signal] void cursorRectangleChanged

Description: Signal declaration for QInputMethod::cursorRectangleChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'cursorRectangleChanged'. This is the getter.
The object exposes a writable attribute 'cursorRectangleChanged'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QInputMethod::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

hide

Signature: void hide

Description: Method void QInputMethod::hide()

inputDirection

Signature: [const] Qt_LayoutDirection inputDirection

Description: Method Qt::LayoutDirection QInputMethod::inputDirection()

Python specific notes:
The object exposes a readable attribute 'inputDirection'. This is the getter.

inputDirectionChanged

Signature: [signal] void inputDirectionChanged (const Qt_LayoutDirection newDirection)

Description: Signal declaration for QInputMethod::inputDirectionChanged(Qt::LayoutDirection newDirection)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'inputDirectionChanged'. This is the getter.
The object exposes a writable attribute 'inputDirectionChanged'. This is the setter.

inputItemRectangle

Signature: [const] QRectF inputItemRectangle

Description: Method QRectF QInputMethod::inputItemRectangle()

Python specific notes:
The object exposes a readable attribute 'inputItemRectangle'. This is the getter.

inputItemRectangle=

Signature: void inputItemRectangle= (const QRectF rect)

Description: Method void QInputMethod::setInputItemRectangle(const QRectF &rect)

Python specific notes:
The object exposes a writable attribute 'inputItemRectangle'. This is the setter.

inputItemTransform

Signature: [const] QTransform inputItemTransform

Description: Method QTransform QInputMethod::inputItemTransform()

Python specific notes:
The object exposes a readable attribute 'inputItemTransform'. This is the getter.

inputItemTransform=

Signature: void inputItemTransform= (const QTransform transform)

Description: Method void QInputMethod::setInputItemTransform(const QTransform &transform)

Python specific notes:
The object exposes a writable attribute 'inputItemTransform'. This is the setter.

invokeAction

Signature: void invokeAction (const QInputMethod_Action a, int cursorPosition)

Description: Method void QInputMethod::invokeAction(QInputMethod::Action a, int cursorPosition)

isAnimating?

Signature: [const] bool isAnimating?

Description: Method bool QInputMethod::isAnimating()

Python specific notes:
The object exposes a readable attribute 'animating'. This is the getter.

isVisible?

Signature: [const] bool isVisible?

Description: Method bool QInputMethod::isVisible()

Python specific notes:
The object exposes a readable attribute 'visible'. This is the getter.

keyboardRectangle

Signature: [const] QRectF keyboardRectangle

Description: Method QRectF QInputMethod::keyboardRectangle()

Python specific notes:
The object exposes a readable attribute 'keyboardRectangle'. This is the getter.

keyboardRectangleChanged

Signature: [signal] void keyboardRectangleChanged

Description: Signal declaration for QInputMethod::keyboardRectangleChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'keyboardRectangleChanged'. This is the getter.
The object exposes a writable attribute 'keyboardRectangleChanged'. This is the setter.

locale

Signature: [const] QLocale locale

Description: Method QLocale QInputMethod::locale()

Python specific notes:
The object exposes a readable attribute 'locale'. This is the getter.

localeChanged

Signature: [signal] void localeChanged

Description: Signal declaration for QInputMethod::localeChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'localeChanged'. This is the getter.
The object exposes a writable attribute 'localeChanged'. This is the setter.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QInputMethod::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

queryFocusObject

Signature: [static] variant queryFocusObject (const Qt_InputMethodQuery query, variant argument)

Description: Static method QVariant QInputMethod::queryFocusObject(Qt::InputMethodQuery query, QVariant argument)

This method is static and can be called without an instance.

reset

Signature: void reset

Description: Method void QInputMethod::reset()

setInputItemRectangle

Signature: void setInputItemRectangle (const QRectF rect)

Description: Method void QInputMethod::setInputItemRectangle(const QRectF &rect)

Python specific notes:
The object exposes a writable attribute 'inputItemRectangle'. This is the setter.

setInputItemTransform

Signature: void setInputItemTransform (const QTransform transform)

Description: Method void QInputMethod::setInputItemTransform(const QTransform &transform)

Python specific notes:
The object exposes a writable attribute 'inputItemTransform'. This is the setter.

setVisible

Signature: void setVisible (bool visible)

Description: Method void QInputMethod::setVisible(bool visible)

show

Signature: void show

Description: Method void QInputMethod::show()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QInputMethod::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QInputMethod::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

update

Signature: void update (Qt_QFlags_InputMethodQuery queries)

Description: Method void QInputMethod::update(QFlags<Qt::InputMethodQuery> queries)

visible

Signature: [const] bool visible

Description: Method bool QInputMethod::isVisible()

Python specific notes:
The object exposes a readable attribute 'visible'. This is the getter.

visibleChanged

Signature: [signal] void visibleChanged

Description: Signal declaration for QInputMethod::visibleChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'visibleChanged'. This is the getter.
The object exposes a writable attribute 'visibleChanged'. This is the setter.