#include <qquickinputmethod_p.h>

Inheritance diagram for QQuickInputMethod:

Collaboration diagram for QQuickInputMethod:

Public Slots
void	commit ()
void	hide ()
void	invokeAction (QInputMethod::Action a, int cursorPosition)
void	reset ()
void	show ()
void	update (Qt::InputMethodQueries queries)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	anchorRectangleChanged ()
void	animatingChanged ()
void	cursorRectangleChanged ()
void	inputDirectionChanged (Qt::LayoutDirection newDirection)
void	inputItemClipRectangleChanged ()
void	keyboardRectangleChanged ()
void	localeChanged ()
void	visibleChanged ()
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
	QQuickInputMethod (QObject *parent=nullptr)
	\qmlsingletontype InputMethod \inqmlmodule QtQuick
QRectF	anchorRectangle () const
QRectF	cursorRectangle () const
Qt::LayoutDirection	inputDirection () const
QRectF	inputItemClipRectangle () const
QRectF	inputItemRectangle () const
void	setInputItemRectangle (const QRectF &rect)
QTransform	inputItemTransform () const
void	setInputItemTransform (const QTransform &transform)
bool	isAnimating () const
bool	isVisible () const
void	setVisible (bool visible)
QRectF	keyboardRectangle () const
QLocale	locale () 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 event)
	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 &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	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 id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
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 *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=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 *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) 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`.

Properties
QML_SINGLETONQRectF	cursorRectangle
QRectF	anchorRectangle
QRectF	keyboardRectangle
QRectF	inputItemClipRectangle
bool	visible
bool	animating
QLocale	locale
Qt::LayoutDirection	inputDirection
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 type=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 type=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 &)
	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)
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 *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	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 *object)
	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 *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 29 of file qquickinputmethod_p.h.

Constructor & Destructor Documentation

◆ QQuickInputMethod()

QT_BEGIN_NAMESPACE QQuickInputMethod::QQuickInputMethod ( QObject * parent = nullptr )

explicit

\qmlsingletontype InputMethod \inqmlmodule QtQuick

Provides access to \l QInputMethod for QML applications.

The InputMethod singleton allows access to application's \l QInputMethod object and all its properties and slots. See the \l QInputMethod documentation for further details.

Since: 6.4

\qmlproperty rect InputMethod::cursorRectangle

Input item's cursor rectangle in window coordinates.

The cursor rectangle is often used by various text editing controls like text prediction popups for following the text being typed.

\qmlproperty rect InputMethod::anchorRectangle

Input item's anchor rectangle in window coordinates.

The anchor rectangle is often used by various text editing controls like text prediction popups for following the text selection.

\qmlproperty rect InputMethod::keyboardRectangle

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.

\qmlproperty rect InputMethod::inputItemClipRectangle

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

\qmlproperty bool InputMethod::visible

Virtual keyboard's visibility on the screen

The value of this property remains false for devices with no virtual keyboards.

See also: show(), hide()

\qmlproperty bool InputMethod::animating

True when the virtual keyboard is being opened or closed.

The value of this property 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.

\qmlproperty Locale InputMethod::locale

Current input locale.

\qmlproperty enumeration InputMethod::inputDirection

Current input direction.

Possible values:

\value Qt.LeftToRight (default) Items are laid out from left to right. \value Qt.RightToLeft Items are laid out from right to left.

\qmlmethod void InputMethod::commit()

Commits the word that the 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.

\qmlmethod void InputMethod::hide()

Requests the virtual keyboard to close.

Normally applications should not need to call this function, as the keyboard should close automatically when the text editor loses focus, for example when the parent view is closed.

\qmlmethod void InputMethod::invokeAction(var 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.

See also: QInputMethod::Action

\qmlmethod void InputMethod::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.

\qmlmethod void InputMethod::show()

Requests the virtual keyboard to open. If the platform doesn't provide a virtual keyboard the visibility remains false.

Normally applications should not need to call this function, as the keyboard should open automatically when the text editor gains focus.

\qmlmethod void InputMethod::update(enumeration queries)

Called by the input item to inform the platform input methods when there have been state changes in the editor's input method query attributes. When calling the function queries parameter has to be used to tell what has changed. An input method can use this to make queries for attributes it is interested in 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.

See also: Qt::InputMethodQueries

Definition at line 161 of file qquickinputmethod.cpp.

Member Function Documentation

◆ anchorRectangle()

QRectF QQuickInputMethod::anchorRectangle ( ) const

Definition at line 205 of file qquickinputmethod.cpp.

◆ anchorRectangleChanged

void QQuickInputMethod::anchorRectangleChanged ( )

signal

◆ animatingChanged

void QQuickInputMethod::animatingChanged ( )

signal

◆ commit

void QQuickInputMethod::commit ( )

slot

Definition at line 180 of file qquickinputmethod.cpp.

◆ cursorRectangle()

QRectF QQuickInputMethod::cursorRectangle ( ) const

Definition at line 209 of file qquickinputmethod.cpp.

◆ cursorRectangleChanged

void QQuickInputMethod::cursorRectangleChanged ( )

signal

◆ hide

void QQuickInputMethod::hide ( )

slot

Definition at line 184 of file qquickinputmethod.cpp.

◆ inputDirection()

Qt::LayoutDirection QQuickInputMethod::inputDirection ( ) const

Definition at line 213 of file qquickinputmethod.cpp.

◆ inputDirectionChanged

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

signal

◆ inputItemClipRectangle()

QRectF QQuickInputMethod::inputItemClipRectangle ( ) const

Definition at line 217 of file qquickinputmethod.cpp.

◆ inputItemClipRectangleChanged

void QQuickInputMethod::inputItemClipRectangleChanged ( )

signal

◆ inputItemRectangle()

QRectF QQuickInputMethod::inputItemRectangle ( ) const

Definition at line 222 of file qquickinputmethod.cpp.

◆ inputItemTransform()

QTransform QQuickInputMethod::inputItemTransform ( ) const

Definition at line 231 of file qquickinputmethod.cpp.

◆ invokeAction

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

slot

Definition at line 188 of file qquickinputmethod.cpp.

◆ isAnimating()

bool QQuickInputMethod::isAnimating ( ) const

Definition at line 240 of file qquickinputmethod.cpp.

◆ isVisible()

bool QQuickInputMethod::isVisible ( ) const

Definition at line 245 of file qquickinputmethod.cpp.

◆ keyboardRectangle()

QRectF QQuickInputMethod::keyboardRectangle ( ) const

Definition at line 254 of file qquickinputmethod.cpp.

◆ keyboardRectangleChanged

void QQuickInputMethod::keyboardRectangleChanged ( )

signal

◆ locale()

QLocale QQuickInputMethod::locale ( ) const

Definition at line 258 of file qquickinputmethod.cpp.

◆ localeChanged

void QQuickInputMethod::localeChanged ( )

signal

◆ reset

void QQuickInputMethod::reset ( )

slot

Definition at line 192 of file qquickinputmethod.cpp.

◆ setInputItemRectangle()

void QQuickInputMethod::setInputItemRectangle ( const QRectF & rect )

Definition at line 226 of file qquickinputmethod.cpp.

◆ setInputItemTransform()

void QQuickInputMethod::setInputItemTransform ( const QTransform & transform )

Definition at line 235 of file qquickinputmethod.cpp.

◆ setVisible()

void QQuickInputMethod::setVisible ( bool visible )

Definition at line 249 of file qquickinputmethod.cpp.

◆ show

void QQuickInputMethod::show ( )

slot

Definition at line 196 of file qquickinputmethod.cpp.

◆ update

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

slot

Definition at line 200 of file qquickinputmethod.cpp.

◆ visibleChanged

void QQuickInputMethod::visibleChanged ( )

signal

Property Documentation

◆ anchorRectangle

QRectF QQuickInputMethod::anchorRectangle

read

Definition at line 37 of file qquickinputmethod_p.h.

◆ animating

bool QQuickInputMethod::animating

read

Definition at line 41 of file qquickinputmethod_p.h.

◆ cursorRectangle

QML_SINGLETONQRectF QQuickInputMethod::cursorRectangle

read

Definition at line 36 of file qquickinputmethod_p.h.

◆ inputDirection

Qt::LayoutDirection QQuickInputMethod::inputDirection

read

Definition at line 43 of file qquickinputmethod_p.h.

◆ inputItemClipRectangle

QRectF QQuickInputMethod::inputItemClipRectangle

read

Definition at line 39 of file qquickinputmethod_p.h.

◆ keyboardRectangle

QRectF QQuickInputMethod::keyboardRectangle

read

Definition at line 38 of file qquickinputmethod_p.h.

◆ locale

QLocale QQuickInputMethod::locale

read

Definition at line 42 of file qquickinputmethod_p.h.

◆ visible

bool QQuickInputMethod::visible

read

Definition at line 40 of file qquickinputmethod_p.h.

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

qtdeclarative/src/quick/util/qquickinputmethod_p.h (01cd43d30e3ca2c4dd94a4a4711604adb9417517)
qtdeclarative/src/quick/util/qquickinputmethod.cpp (1d646455ec5a1fffc8c0dbd2545326fc039b6fda)

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickInputMethod()

Member Function Documentation

◆ anchorRectangle()

◆ anchorRectangleChanged

◆ animatingChanged

◆ commit

◆ cursorRectangle()

◆ cursorRectangleChanged

◆ hide

◆ inputDirection()

◆ inputDirectionChanged

◆ inputItemClipRectangle()

◆ inputItemClipRectangleChanged

◆ inputItemRectangle()

◆ inputItemTransform()

◆ invokeAction

◆ isAnimating()

◆ isVisible()

◆ keyboardRectangle()

◆ keyboardRectangleChanged

◆ locale()

◆ localeChanged

◆ reset

◆ setInputItemRectangle()

◆ setInputItemTransform()

◆ setVisible()

◆ show

◆ update

◆ visibleChanged

Property Documentation

◆ anchorRectangle

◆ animating

◆ cursorRectangle

◆ inputDirection

◆ inputItemClipRectangle

◆ keyboardRectangle

◆ locale

◆ visible