The QPlatformInputContext class abstracts the input method dependent data and composing state. More...

#include <qplatforminputcontext.h>

Inheritance diagram for QPlatformInputContext:

Collaboration diagram for QPlatformInputContext:

Public Types
enum	Capability { HiddenTextCapability = 0x1 }

Public Member Functions
	QPlatformInputContext ()
	~QPlatformInputContext ()
virtual bool	isValid () const
	Returns input context validity.
virtual bool	hasCapability (Capability capability) const
	Returns whether the implementation supports capability.
virtual void	reset ()
	Method to be called when input method needs to be reset.
virtual void	commit ()
virtual void	update (Qt::InputMethodQueries)
	Notification on editor updates.
virtual void	invokeAction (QInputMethod::Action, int cursorPosition)
	Called when the word currently being composed in the input item is tapped by the user.
virtual bool	filterEvent (const QEvent *event)
	This function can be reimplemented to filter input events.
virtual QRectF	keyboardRect () const
	This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates.
void	emitKeyboardRectChanged ()
	Active QPlatformInputContext is responsible for providing keyboardRectangle property to QInputMethod.
virtual bool	isAnimating () const
	This function can be reimplemented to return true whenever input method is animating shown or hidden.
void	emitAnimatingChanged ()
	Active QPlatformInputContext is responsible for providing animating property to QInputMethod.
virtual void	showInputPanel ()
	Request to show input panel.
virtual void	hideInputPanel ()
	Request to hide input panel.
virtual bool	isInputPanelVisible () const
	Returns input panel visibility status.
void	emitInputPanelVisibleChanged ()
	Active QPlatformInputContext is responsible for providing visible property to QInputMethod.
virtual QLocale	locale () const
void	emitLocaleChanged ()
virtual Qt::LayoutDirection	inputDirection () const
void	emitInputDirectionChanged (Qt::LayoutDirection newDirection)
virtual void	setFocusObject (QObject *object)
	This virtual method gets called to notify updated focus to object.
bool	inputMethodAccepted () const
	Returns `true` if current focus object supports input method events.
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`.

Static Public Member Functions
static void	setSelectionOnFocusObject (const QPointF &anchorPos, const QPointF &cursorPos)
	QPlatformInputContext::setSelectionOnFocusObject.
static QVariant	queryFocusObject (Qt::InputMethodQuery query, QPointF position)
	QPlatformInputContext::queryFocusObject.
static QRectF	inputItemRectangle ()
	QPlatformInputContext::inputItemRectangle.
static QRectF	inputItemClipRectangle ()
	QPlatformInputContext::inputItemClipRectangle.
static QRectF	cursorRectangle ()
	QPlatformInputContext::cursorRectangle.
static QRectF	anchorRectangle ()
	QPlatformInputContext::anchorRectangle.
static QRectF	keyboardRectangle ()
	QPlatformInputContext::keyboardRectangle.
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)

Friends
class	QGuiApplication
class	QGuiApplicationPrivate
class	QInputMethod

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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.
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
Properties inherited from QObject
QString	objectName
	the name of this object
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

The QPlatformInputContext class abstracts the input method dependent data and composing state.

Since: 5.0

\preliminary

An input method is responsible for inputting complex text that cannot be inputted via simple keymap. It converts a sequence of input events (typically key events) into a text string through the input method specific converting process. The class of the processes are widely ranging from simple finite state machine to complex text translator that pools a whole paragraph of a text with text editing capability to perform grammar and semantic analysis.

To abstract such different input method specific intermediate information, Qt offers the QPlatformInputContext as base class. The concept is well known as 'input context' in the input method domain. An input context is created for a text widget in response to a demand. It is ensured that an input context is prepared for an input method before input to a text widget.

QPlatformInputContext provides an interface the actual input methods can derive from by reimplementing methods.

See also: QInputMethod

Definition at line 24 of file qplatforminputcontext.h.

Member Enumeration Documentation

◆ Capability

enum QPlatformInputContext::Capability

Enumerator
HiddenTextCapability

Definition at line 30 of file qplatforminputcontext.h.

Constructor & Destructor Documentation

◆ QPlatformInputContext()

QPlatformInputContext::QPlatformInputContext ( )

Definition at line 48 of file qplatforminputcontext.cpp.

◆ ~QPlatformInputContext()

QPlatformInputContext::~QPlatformInputContext ( )

Definition at line 61 of file qplatforminputcontext.cpp.

Member Function Documentation

◆ anchorRectangle()

QRectF QPlatformInputContext::anchorRectangle ( )

static

QPlatformInputContext::anchorRectangle.

Returns the anchor rectangle for the currently active window and input methiod in native window coordinates.

Definition at line 338 of file qplatforminputcontext.cpp.

◆ commit()

void QPlatformInputContext::commit ( )

virtual

Reimplemented in QAndroidInputContext, QCocoaInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, and QtWaylandClient::QWaylandInputMethodContext.

Definition at line 92 of file qplatforminputcontext.cpp.

◆ cursorRectangle()

QRectF QPlatformInputContext::cursorRectangle ( )

static

QPlatformInputContext::cursorRectangle.

Returns the cursor rectangle for the currently active window and input methiod in native window coordinates.

Definition at line 326 of file qplatforminputcontext.cpp.

◆ emitAnimatingChanged()

void QPlatformInputContext::emitAnimatingChanged ( )

Active QPlatformInputContext is responsible for providing animating property to QInputMethod.

In addition of providing the value in isAnimation function, it also needs to call this emit function whenever the property changes.

Definition at line 162 of file qplatforminputcontext.cpp.

◆ emitInputDirectionChanged()

void QPlatformInputContext::emitInputDirectionChanged ( Qt::LayoutDirection newDirection )

Definition at line 217 of file qplatforminputcontext.cpp.

◆ emitInputPanelVisibleChanged()

void QPlatformInputContext::emitInputPanelVisibleChanged ( )

Active QPlatformInputContext is responsible for providing visible property to QInputMethod.

In addition of providing the value in isInputPanelVisible function, it also needs to call this emit function whenever the property changes.

Definition at line 194 of file qplatforminputcontext.cpp.

◆ emitKeyboardRectChanged()

void QPlatformInputContext::emitKeyboardRectChanged ( )

Active QPlatformInputContext is responsible for providing keyboardRectangle property to QInputMethod.

In addition of providing the value in keyboardRect function, it also needs to call this emit function whenever the property changes.

Definition at line 143 of file qplatforminputcontext.cpp.

◆ emitLocaleChanged()

void QPlatformInputContext::emitLocaleChanged ( )

Definition at line 204 of file qplatforminputcontext.cpp.

◆ filterEvent()

bool QPlatformInputContext::filterEvent ( const QEvent * event )

virtual

This function can be reimplemented to filter input events.

Return true if the event has been consumed. Otherwise, the unfiltered event will be forwarded to widgets as ordinary way. Although the input events have accept() and ignore() methods, leave it untouched.

Reimplemented in QComposeInputContext, QIBusPlatformInputContext, QQnxInputContext, and QQnxInputContext.

Definition at line 123 of file qplatforminputcontext.cpp.

◆ hasCapability()

bool QPlatformInputContext::hasCapability ( Capability capability ) const

virtual

Returns whether the implementation supports capability.

Since: 5.4

Reimplemented in QIBusPlatformInputContext, and QWindowsInputContext.

Definition at line 78 of file qplatforminputcontext.cpp.

◆ hideInputPanel()

void QPlatformInputContext::hideInputPanel ( )

virtual

Request to hide input panel.

Reimplemented in PlatformInputContext, QAndroidInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, QWasmInputContext, and QWindowsInputContext.

Definition at line 177 of file qplatforminputcontext.cpp.

◆ inputDirection()

Qt::LayoutDirection QPlatformInputContext::inputDirection ( ) const

virtual

Reimplemented in PlatformInputContext, QtWaylandClient::QWaylandInputContext, and QtWaylandClient::QWaylandInputMethodContext.

Definition at line 212 of file qplatforminputcontext.cpp.

◆ inputItemClipRectangle()

QRectF QPlatformInputContext::inputItemClipRectangle ( )

static

QPlatformInputContext::inputItemClipRectangle.

Returns the input item clip rectangle for the currently active window and input methiod in native window coordinates.

Definition at line 314 of file qplatforminputcontext.cpp.

◆ inputItemRectangle()

QRectF QPlatformInputContext::inputItemRectangle ( )

static

QPlatformInputContext::inputItemRectangle.

Returns the input item rectangle for the currently active window and input methiod in native window coordinates.

Definition at line 301 of file qplatforminputcontext.cpp.

◆ inputMethodAccepted()

bool QPlatformInputContext::inputMethodAccepted ( ) const

Returns true if current focus object supports input method events.

Definition at line 238 of file qplatforminputcontext.cpp.

◆ invokeAction()

void QPlatformInputContext::invokeAction	(	QInputMethod::Action	action,
		int	cursorPosition )

virtual

Called when the word currently being composed in the input item is tapped by the user.

Input methods often use this information to offer more word suggestions to the user.

Reimplemented in PlatformInputContext, QAndroidInputContext, QIBusPlatformInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWindowsInputContext.

Definition at line 108 of file qplatforminputcontext.cpp.

◆ isAnimating()

bool QPlatformInputContext::isAnimating ( ) const

virtual

This function can be reimplemented to return true whenever input method is animating shown or hidden.

Default implementation returns false.

Reimplemented in QAndroidInputContext, and QIOSInputContext.

Definition at line 152 of file qplatforminputcontext.cpp.

◆ isInputPanelVisible()

bool QPlatformInputContext::isInputPanelVisible ( ) const

virtual

Returns input panel visibility status.

Default implementation returns false.

Reimplemented in PlatformInputContext, QAndroidInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWindowsInputContext.

Definition at line 184 of file qplatforminputcontext.cpp.

◆ isValid()

bool QPlatformInputContext::isValid ( ) const

virtual

Returns input context validity.

Deriving implementations should return true.

Reimplemented in QAndroidInputContext, QCocoaInputContext, QComposeInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWasmInputContext.

Definition at line 68 of file qplatforminputcontext.cpp.

◆ keyboardRect()

QRectF QPlatformInputContext::keyboardRect ( ) const

virtual

This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates.

Default implementation returns invalid rectangle.

Reimplemented in QAndroidInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWindowsInputContext.

Definition at line 133 of file qplatforminputcontext.cpp.

◆ keyboardRectangle()

QRectF QPlatformInputContext::keyboardRectangle ( )

static

QPlatformInputContext::keyboardRectangle.

Returns the keyboard rectangle for the currently active window and input methiod in native window coordinates.

Definition at line 350 of file qplatforminputcontext.cpp.

◆ locale()

QLocale QPlatformInputContext::locale ( ) const

virtual

Reimplemented in PlatformInputContext, QCocoaInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWindowsInputContext.

Definition at line 199 of file qplatforminputcontext.cpp.

◆ queryFocusObject()

QVariant QPlatformInputContext::queryFocusObject	(	Qt::InputMethodQuery	query,
		QPointF	nativePosition )

static

QPlatformInputContext::queryFocusObject.

Queries the current foucus object with a window position in native pixels.

Definition at line 287 of file qplatforminputcontext.cpp.

◆ reset()

void QPlatformInputContext::reset ( )

virtual

Method to be called when input method needs to be reset.

Called by QInputMethod::reset(). No further QInputMethodEvents should be sent as response.

Reimplemented in QAndroidInputContext, QCocoaInputContext, QComposeInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, and QWindowsInputContext.

Definition at line 88 of file qplatforminputcontext.cpp.

◆ setFocusObject()

void QPlatformInputContext::setFocusObject ( QObject * object )

virtual

This virtual method gets called to notify updated focus to object.

Warning: Input methods must not call this function directly.

Reimplemented in QAndroidInputContext, QCocoaInputContext, QComposeInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, QWasmInputContext, and QWindowsInputContext.

Definition at line 230 of file qplatforminputcontext.cpp.

◆ setSelectionOnFocusObject()

void QPlatformInputContext::setSelectionOnFocusObject	(	const QPointF &	nativeAnchorPos,
		const QPointF &	nativeCursorPos )

static

QPlatformInputContext::setSelectionOnFocusObject.

Parameters

anchorPos	Beginning of selection in currently active window native coordinates
cursorPos	End of selection in currently active window native coordinates

Definition at line 255 of file qplatforminputcontext.cpp.

◆ showInputPanel()

void QPlatformInputContext::showInputPanel ( )

virtual

Request to show input panel.

Reimplemented in PlatformInputContext, QAndroidInputContext, QIOSInputContext, QQnxInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, QWasmInputContext, and QWindowsInputContext.

Definition at line 170 of file qplatforminputcontext.cpp.

◆ update()

void QPlatformInputContext::update ( Qt::InputMethodQueries )

virtual

Notification on editor updates.

Called by QInputMethod::update().

Reimplemented in PlatformInputContext, QAndroidInputContext, QComposeInputContext, QIBusPlatformInputContext, QIOSInputContext, QQnxInputContext, QtWaylandClient::QWaylandInputContext, QtWaylandClient::QWaylandInputMethodContext, QWasmInputContext, and QWindowsInputContext.

Definition at line 99 of file qplatforminputcontext.cpp.

◆ QGuiApplication

friend class QGuiApplication

friend

Definition at line 73 of file qplatforminputcontext.h.

◆ QGuiApplicationPrivate

friend class QGuiApplicationPrivate

friend

Definition at line 74 of file qplatforminputcontext.h.

◆ QInputMethod

friend class QInputMethod

friend

Definition at line 75 of file qplatforminputcontext.h.

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

qtbase/src/gui/kernel/qplatforminputcontext.h (3fa3e0362f36607707e24cb1dea31dce30254b4a)
qtbase/src/gui/kernel/qplatforminputcontext.cpp (3fa3e0362f36607707e24cb1dea31dce30254b4a)

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Capability

Constructor & Destructor Documentation

◆ QPlatformInputContext()

◆ ~QPlatformInputContext()

Member Function Documentation

◆ anchorRectangle()

◆ commit()

◆ cursorRectangle()

◆ emitAnimatingChanged()

◆ emitInputDirectionChanged()

◆ emitInputPanelVisibleChanged()

◆ emitKeyboardRectChanged()

◆ emitLocaleChanged()

◆ filterEvent()

◆ hasCapability()

◆ hideInputPanel()

◆ inputDirection()

◆ inputItemClipRectangle()

◆ inputItemRectangle()

◆ inputMethodAccepted()

◆ invokeAction()

◆ isAnimating()

◆ isInputPanelVisible()

◆ isValid()

◆ keyboardRect()

◆ keyboardRectangle()

◆ locale()

◆ queryFocusObject()

◆ reset()

◆ setFocusObject()

◆ setSelectionOnFocusObject()

◆ showInputPanel()

◆ update()

Friends And Related Symbol Documentation

◆ QGuiApplication

◆ QGuiApplicationPrivate

◆ QInputMethod