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

#include <qinputmethod.h>

Inheritance diagram for QInputMethod:

Collaboration diagram for QInputMethod:

Public Types
enum	Action { Click , ContextMenu }
	Indicates the kind of action performed by the user. More...

Public Slots
void	show ()
	Requests virtual keyboard to open.
void	hide ()
	Requests virtual keyboard to close.
void	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.
void	reset ()
	Resets the input method state.
void	commit ()
	Commits the word user is currently composing to the editor.
void	invokeAction (Action aa, 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.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	cursorRectangleChanged ()
void	anchorRectangleChanged ()
void	keyboardRectangleChanged ()
void	inputItemClipRectangleChanged ()
void	visibleChanged ()
void	animatingChanged ()
void	localeChanged ()
void	inputDirectionChanged (Qt::LayoutDirection newDirection)
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
QTransform	inputItemTransform () const
	Returns the transformation from input item coordinates to the window coordinates.
void	setInputItemTransform (const QTransform &transformtransform)
	Sets the transformation from input item coordinates to window coordinates to be transform.
QRectF	inputItemRectangle () const
void	setInputItemRectangle (const QRectF &rect)
QRectF	cursorRectangle () const
QRectF	anchorRectangle () const
QRectF	keyboardRectangle () const
QRectF	inputItemClipRectangle () const
bool	isVisible () const
void	setVisible (bool visible)
	Controls the keyboard visibility.
bool	isAnimating () const
QLocale	locale () const
Qt::LayoutDirection	inputDirection () const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent eventevent)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &namename)
	Sets the object's name to name.
void	setObjectName (QAnyStringView namename)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int idid)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId idid)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *objobj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType typetype=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *namename, const QVariant &valuevalue)
	Sets the value of the object's name property to value.
bool	setProperty (const char *namename, QVariant &&valuevalue)
QVariant	property (const char *namename) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static QVariant	queryFocusObject (Qt::InputMethodQuery queryquery, const QVariant &argument)
	Sends query to the current focus object with parameters argument and returns the result.
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType typetype=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType typetype=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}.
static bool	disconnect (QMetaObject::Connection &)
static bool	disconnect (QMetaObject::Connection &&conn)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Properties
QRectF	cursorRectangle
	Input item's cursor rectangle in window coordinates.
QRectF	anchorRectangle
	Input item's anchor rectangle in window coordinates.
QRectF	keyboardRectangle
	Virtual keyboard's geometry in window coordinates.
QRectF	inputItemClipRectangle
	Input item's clipped rectangle in window coordinates.
bool	visible
	Virtual keyboard's visibility on the screen.
bool	animating
	True when the virtual keyboard is being opened or closed.
QLocale	locale
	Current input locale.
Qt::LayoutDirection	inputDirection
	Current input direction.
Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QGuiApplication
class	QGuiApplicationPrivate
class	QPlatformInputContext

Additional Inherited Members
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *eventevent)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *objectobject)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *objobj, const QString &namename)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *objobj, const QString &namename)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

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

\inmodule QtGui

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 \l{QmlGlobalQtObject}{Qt global object} as Qt.inputMethod property.

Text editors receive input from the input method through QInputMethodEvent, and the input method queries their state through QInputMethodQueryEvent. For information about supporting input methods in a custom text editor, see QInputMethodEvent.

Definition at line 19 of file qinputmethod.h.

Member Enumeration Documentation

◆ Action

enum QInputMethod::Action

Indicates the kind of action performed by the user.

\value Click A normal click/tap \value ContextMenu A context menu click/tap (e.g. right-button or tap-and-hold)

See also: invokeAction()

Enumerator
Click
ContextMenu

Definition at line 48 of file qinputmethod.h.

Member Function Documentation

◆ anchorRectangle()

QRectF QInputMethod::anchorRectangle ( ) const

Definition at line 132 of file qinputmethod.cpp.

◆ anchorRectangleChanged

void QInputMethod::anchorRectangleChanged ( )

signal

◆ animatingChanged

void QInputMethod::animatingChanged ( )

signal

◆ commit

void QInputMethod::commit ( )

slot

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.

Definition at line 330 of file qinputmethod.cpp.

◆ cursorRectangle()

QRectF QInputMethod::cursorRectangle ( ) const

Definition at line 119 of file qinputmethod.cpp.

◆ cursorRectangleChanged

void QInputMethod::cursorRectangleChanged ( )

signal

◆ hide

void QInputMethod::hide ( )

slot

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.

Definition at line 190 of file qinputmethod.cpp.

◆ inputDirection()

Qt::LayoutDirection QInputMethod::inputDirection ( ) const

Definition at line 264 of file qinputmethod.cpp.

◆ inputDirectionChanged

void QInputMethod::inputDirectionChanged ( Qt::LayoutDirection newDirection )

signal

◆ inputItemClipRectangle()

QRectF QInputMethod::inputItemClipRectangle ( ) const

Definition at line 161 of file qinputmethod.cpp.

◆ inputItemClipRectangleChanged

void QInputMethod::inputItemClipRectangleChanged ( )

signal

◆ inputItemRectangle()

QRectF QInputMethod::inputItemRectangle ( ) const

Since: 5.1

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

See also: setInputItemRectangle()

Definition at line 80 of file qinputmethod.cpp.

◆ inputItemTransform()

QTransform QInputMethod::inputItemTransform ( ) const

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

Definition at line 50 of file qinputmethod.cpp.

◆ invokeAction

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

slot

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.

Definition at line 354 of file qinputmethod.cpp.

◆ isAnimating()

bool QInputMethod::isAnimating ( ) const

Definition at line 238 of file qinputmethod.cpp.

◆ isVisible()

bool QInputMethod::isVisible ( ) const

Definition at line 207 of file qinputmethod.cpp.

◆ keyboardRectangle()

QRectF QInputMethod::keyboardRectangle ( ) const

Definition at line 145 of file qinputmethod.cpp.

◆ keyboardRectangleChanged

void QInputMethod::keyboardRectangleChanged ( )

signal

◆ locale()

QLocale QInputMethod::locale ( ) const

Definition at line 251 of file qinputmethod.cpp.

◆ localeChanged

void QInputMethod::localeChanged ( )

signal

◆ queryFocusObject()

QVariant QInputMethod::queryFocusObject	(	Qt::InputMethodQuery	query,
		const QVariant &	argument )

static

Sends query to the current focus object with parameters argument and returns the result.

If the focus object has an invokable method with the signature {inputMethodQuery(Qt::InputMethodQuery, QVariant)}, that method is called with query and argument. If the focus object has no such method, or the method returns an invalid QVariant, a QInputMethodQueryEvent for query is sent to the focus object instead, and argument is ignored.

Definition at line 398 of file qinputmethod.cpp.

◆ reset

void QInputMethod::reset ( )

slot

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.

Definition at line 314 of file qinputmethod.cpp.

◆ setInputItemRectangle()

void QInputMethod::setInputItemRectangle ( const QRectF & rect )

Since: 5.1

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.

Definition at line 93 of file qinputmethod.cpp.

◆ setInputItemTransform()

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.

Definition at line 61 of file qinputmethod.cpp.

◆ setVisible()

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: show(), hide()

Definition at line 223 of file qinputmethod.cpp.

◆ show

void QInputMethod::show ( )

slot

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.

Definition at line 175 of file qinputmethod.cpp.

◆ update

void QInputMethod::update ( Qt::InputMethodQueries queries )

slot

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.

Definition at line 284 of file qinputmethod.cpp.

◆ visibleChanged

void QInputMethod::visibleChanged ( )

signal

◆ QGuiApplication

friend class QGuiApplication

friend

Definition at line 85 of file qinputmethod.h.

◆ QGuiApplicationPrivate

friend class QGuiApplicationPrivate

friend

Definition at line 86 of file qinputmethod.h.

◆ QPlatformInputContext

friend class QPlatformInputContext

friend

Definition at line 87 of file qinputmethod.h.

Property Documentation

◆ anchorRectangle

QRectF QInputMethod::anchorRectangle

read

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.

Definition at line 24 of file qinputmethod.h.

◆ animating

bool QInputMethod::animating

read

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.

Definition at line 28 of file qinputmethod.h.

◆ cursorRectangle

QRectF QInputMethod::cursorRectangle

read

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.

Definition at line 23 of file qinputmethod.h.

◆ inputDirection

Qt::LayoutDirection QInputMethod::inputDirection

read

Current input direction.

Definition at line 30 of file qinputmethod.h.

◆ inputItemClipRectangle

QRectF QInputMethod::inputItemClipRectangle

read

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

Definition at line 26 of file qinputmethod.h.

◆ keyboardRectangle

QRectF QInputMethod::keyboardRectangle

read

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.

Definition at line 25 of file qinputmethod.h.

◆ locale

QLocale QInputMethod::locale

read

Current input locale.

Definition at line 29 of file qinputmethod.h.

◆ visible

bool QInputMethod::visible

read

Virtual keyboard's visibility on the screen.

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

See also: show(), hide()

Definition at line 27 of file qinputmethod.h.

The documentation for this class was generated from the following files:

qtbase/src/gui/kernel/qinputmethod.h (3fa3e0362f36607707e24cb1dea31dce30254b4a)
qtbase/src/gui/kernel/qinputmethod.cpp (9c5844927ac3fc963d25e65586e611dbd5c78b86)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Action

Member Function Documentation

◆ anchorRectangle()

◆ anchorRectangleChanged

◆ animatingChanged

◆ commit

◆ cursorRectangle()

◆ cursorRectangleChanged

◆ hide

◆ inputDirection()

◆ inputDirectionChanged

◆ inputItemClipRectangle()

◆ inputItemClipRectangleChanged

◆ inputItemRectangle()

◆ inputItemTransform()

◆ invokeAction

◆ isAnimating()

◆ isVisible()

◆ keyboardRectangle()

◆ keyboardRectangleChanged

◆ locale()

◆ localeChanged

◆ queryFocusObject()

◆ reset

◆ setInputItemRectangle()

◆ setInputItemTransform()

◆ setVisible()

◆ show

◆ update

◆ visibleChanged

Friends And Related Symbol Documentation

◆ QGuiApplication

◆ QGuiApplicationPrivate

◆ QPlatformInputContext

Property Documentation

◆ anchorRectangle

◆ animating

◆ cursorRectangle

◆ inputDirection

◆ inputItemClipRectangle

◆ keyboardRectangle

◆ locale

◆ visible