Windows Input context implementation. More...

#include <qwindowsinputcontext.h>

Inheritance diagram for QWindowsInputContext:

Collaboration diagram for QWindowsInputContext:

Public Member Functions
	QWindowsInputContext ()
	~QWindowsInputContext () override
bool	hasCapability (Capability capability) const override
	Returns whether the implementation supports capability.
QLocale	locale () const override
void	reset () override
	Cancels a composition.
void	update (Qt::InputMethodQueries) override
	Moves the candidate window along with microfocus of the focus object.
void	invokeAction (QInputMethod::Action, int cursorPosition) override
	Called when the word currently being composed in the input item is tapped by the user.
void	setFocusObject (QObject *object) override
	This virtual method gets called to notify updated focus to object.
QRectF	keyboardRect () const override
	This function can be reimplemented to return virtual keyboard rectangle in currently active window coordinates.
bool	isInputPanelVisible () const override
	Returns input panel visibility status.
void	showInputPanel () override
	Request to show input panel.
void	hideInputPanel () override
	Request to hide input panel.
bool	startComposition (HWND hwnd)
bool	composition (HWND hwnd, LPARAM lParam)
	Notify focus object about markup or final text.
bool	endComposition (HWND hwnd)
bool	isComposing () const
int	reconvertString (RECONVERTSTRING *reconv)
	Determines the string for reconversion with selection.
bool	handleIME_Request (WPARAM wparam, LPARAM lparam, LRESULT *result)
void	handleInputLanguageChanged (WPARAM wparam, LPARAM lparam)
Public Member Functions inherited from QPlatformInputContext
	QPlatformInputContext ()
	~QPlatformInputContext ()
virtual bool	isValid () const
	Returns input context validity.
virtual void	commit ()
virtual bool	filterEvent (const QEvent *event)
	This function can be reimplemented to filter input events.
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.
void	emitInputPanelVisibleChanged ()
	Active QPlatformInputContext is responsible for providing visible property to QInputMethod.
void	emitLocaleChanged ()
virtual Qt::LayoutDirection	inputDirection () const
void	emitInputDirectionChanged (Qt::LayoutDirection newDirection)
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	isQmlObjectType () const
	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	setWindowsImeEnabled (QWindowsWindow *platformWindow, bool enabled)
Static Public Member Functions inherited from QPlatformInputContext
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)

Additional Inherited Members
Public Types inherited from QPlatformInputContext
enum	Capability { HiddenTextCapability = 0x1 }
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

Windows Input context implementation.

Handles input of foreign characters (particularly East Asian) languages.

Definition at line 18 of file qwindowsinputcontext.h.

Constructor & Destructor Documentation

◆ QWindowsInputContext()

QWindowsInputContext::QWindowsInputContext ( )

explicit

Definition at line 128 of file qwindowsinputcontext.cpp.

References QWindowsInputContext().

Referenced by QWindowsInputContext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~QWindowsInputContext()

QWindowsInputContext::~QWindowsInputContext ( )

override

Definition at line 140 of file qwindowsinputcontext.cpp.

Member Function Documentation

◆ composition()

bool QWindowsInputContext::composition	(	HWND	hwnd,
		LPARAM	lParam )

Notify focus object about markup or final text.

Definition at line 479 of file qwindowsinputcontext.cpp.

◆ endComposition()

bool QWindowsInputContext::endComposition ( HWND hwnd )

Definition at line 531 of file qwindowsinputcontext.cpp.

References reset().

Here is the call graph for this function:

◆ handleIME_Request()

bool QWindowsInputContext::handleIME_Request	(	WPARAM	wparam,
		LPARAM	lparam,
		LRESULT *	result )

Definition at line 586 of file qwindowsinputcontext.cpp.

◆ handleInputLanguageChanged()

void QWindowsInputContext::handleInputLanguageChanged	(	WPARAM	wparam,
		LPARAM	lparam )

Definition at line 606 of file qwindowsinputcontext.cpp.

◆ hasCapability()

bool QWindowsInputContext::hasCapability ( Capability capability ) const

overridevirtual

Returns whether the implementation supports capability.

Since: 5.4

Reimplemented from QPlatformInputContext.

Definition at line 146 of file qwindowsinputcontext.cpp.

◆ hideInputPanel()

void QWindowsInputContext::hideInputPanel ( )

overridevirtual

Request to hide input panel.

Reimplemented from QPlatformInputContext.

Definition at line 245 of file qwindowsinputcontext.cpp.

◆ invokeAction()

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

overridevirtual

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 from QPlatformInputContext.

Definition at line 337 of file qwindowsinputcontext.cpp.

References reset().

Here is the call graph for this function:

◆ isComposing()

bool QWindowsInputContext::isComposing ( ) const

inline

Definition at line 53 of file qwindowsinputcontext.h.

◆ isInputPanelVisible()

bool QWindowsInputContext::isInputPanelVisible ( ) const

overridevirtual

Returns input panel visibility status.

Default implementation returns false.

Reimplemented from QPlatformInputContext.

Definition at line 203 of file qwindowsinputcontext.cpp.

◆ keyboardRect()

QRectF QWindowsInputContext::keyboardRect ( ) const

overridevirtual

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

Default implementation returns invalid rectangle.

Reimplemented from QPlatformInputContext.

Definition at line 192 of file qwindowsinputcontext.cpp.

◆ locale()

QLocale QWindowsInputContext::locale ( ) const

inlineoverridevirtual

Reimplemented from QPlatformInputContext.

Definition at line 38 of file qwindowsinputcontext.h.

◆ reconvertString()

int QWindowsInputContext::reconvertString ( RECONVERTSTRING * reconv )

Determines the string for reconversion with selection.

This is triggered twice by WM_IME_REQUEST, first with reconv=0 to determine the length and later with a reconv struct to obtain the string with the position of the selection to be reconverted.

Obtains the text from the focus object and marks the word for selection (might not be entirely correct for Japanese).

Definition at line 632 of file qwindowsinputcontext.cpp.

◆ reset()

void QWindowsInputContext::reset ( )

overridevirtual

Cancels a composition.

Reimplemented from QPlatformInputContext.

Definition at line 161 of file qwindowsinputcontext.cpp.

Referenced by endComposition(), invokeAction(), and setFocusObject().

Here is the caller graph for this function:

◆ setFocusObject()

void QWindowsInputContext::setFocusObject ( QObject * object )

overridevirtual

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

Warning: Input methods must not call this function directly.

Reimplemented from QPlatformInputContext.

Definition at line 177 of file qwindowsinputcontext.cpp.

References reset().

Here is the call graph for this function:

◆ setWindowsImeEnabled()

void QWindowsInputContext::setWindowsImeEnabled	(	QWindowsWindow *	platformWindow,
		bool	enabled )

static

Definition at line 265 of file qwindowsinputcontext.cpp.

Referenced by QWindowsContext::windowsProc().

Here is the caller graph for this function:

◆ showInputPanel()

void QWindowsInputContext::showInputPanel ( )

overridevirtual

Request to show input panel.

Reimplemented from QPlatformInputContext.

Definition at line 220 of file qwindowsinputcontext.cpp.

◆ startComposition()

bool QWindowsInputContext::startComposition ( HWND hwnd )

Definition at line 411 of file qwindowsinputcontext.cpp.

◆ update()

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

overridevirtual

Moves the candidate window along with microfocus of the focus object.

Reimplemented from QPlatformInputContext.

Definition at line 282 of file qwindowsinputcontext.cpp.

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

qtbase/src/plugins/platforms/windows/qwindowsinputcontext.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/plugins/platforms/windows/qwindowsinputcontext.cpp (3a38de71da13103fbe5bdf6b822263e282e68368)

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWindowsInputContext()

◆ ~QWindowsInputContext()

Member Function Documentation

◆ composition()

◆ endComposition()

◆ handleIME_Request()

◆ handleInputLanguageChanged()

◆ hasCapability()

◆ hideInputPanel()

◆ invokeAction()

◆ isComposing()

◆ isInputPanelVisible()

◆ keyboardRect()

◆ locale()

◆ reconvertString()

◆ reset()

◆ setFocusObject()

◆ setWindowsImeEnabled()

◆ showInputPanel()

◆ startComposition()

◆ update()