Event dispatcher for Windows. More...

#include <qwindowsguieventdispatcher_p.h>

Inheritance diagram for QWindowsGuiEventDispatcher:

Collaboration diagram for QWindowsGuiEventDispatcher:

Public Member Functions
	QWindowsGuiEventDispatcher (QObject *parent=nullptr)

bool QT_ENSURE_STACK_ALIGNED_FOR_SSE	processEvents (QEventLoop::ProcessEventsFlags flags) override
	Processes pending events that match flags until there are no more events to process.

void	sendPostedEvents () override

Public Member Functions inherited from QEventDispatcherWin32
	QEventDispatcherWin32 (QObject *parent=nullptr)

	~QEventDispatcherWin32 ()

void	registerSocketNotifier (QSocketNotifier *notifier) override
	Registers notifier with the event loop.

void	unregisterSocketNotifier (QSocketNotifier *notifier) override
	Unregisters notifier from the event dispatcher.

void	registerTimer (int timerId, qint64 interval, Qt::TimerType timerType, QObject *object) override

bool	unregisterTimer (int timerId) override

bool	unregisterTimers (QObject *object) override
	Unregisters all the timers associated with the given object.

QList< TimerInfo >	registeredTimers (QObject *object) const override

int	remainingTime (int timerId) override

void	wakeUp () override
	\threadsafe

void	interrupt () override
	Interrupts event dispatching.

void	startingUp () override

void	closingDown () override

bool	event (QEvent *e) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

HWND	internalHwnd ()

Public Member Functions inherited from QAbstractEventDispatcher
	QAbstractEventDispatcher (QObject *parent=nullptr)
	Constructs a new event dispatcher with the given parent.

	~QAbstractEventDispatcher ()
	Destroys the event dispatcher.

Qt::TimerId	registerTimer (Duration interval, Qt::TimerType timerType, QObject *object)

virtual void	registerTimer (Qt::TimerId timerId, Duration interval, Qt::TimerType timerType, QObject *object)=0

virtual bool	unregisterTimer (Qt::TimerId timerId)=0

virtual QList< TimerInfoV2 >	timersForObject (QObject *object) const =0

virtual Duration	remainingTime (Qt::TimerId timerId) const =0
	Returns the remaining time of the timer with the given timerId.

void	installNativeEventFilter (QAbstractNativeEventFilter *filterObj)
	\variable QAbstractEventDispatcher::TimerInfoV2::timerId

void	removeNativeEventFilter (QAbstractNativeEventFilter *filterObj)
	Removes the event filter filter from this object.

bool	filterNativeEvent (const QByteArray &eventType, void message, qintptr result)
	Sends message through the event filters that were set by installNativeEventFilter().

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	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	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 const char *	windowsMessageName (UINT msg)

Static Public Member Functions inherited from QAbstractEventDispatcher
static QAbstractEventDispatcher *	instance (QThread *thread=nullptr)
	Returns a pointer to the event dispatcher object for the specified thread.

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 QAbstractEventDispatcher
using	Duration = std::chrono::nanoseconds
	A {std::chrono::duration} type that is used in various API in this class.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QAbstractEventDispatcher
void	aboutToBlock ()
	This signal is emitted before the event loop calls a function that could block.

void	awake ()
	This signal is emitted after the event loop returns from a function that could block.

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 QEventDispatcherWin32
	QEventDispatcherWin32 (QEventDispatcherWin32Private &dd, QObject *parent=nullptr)

void	doUnregisterSocketNotifier (QSocketNotifier *notifier)

Protected Member Functions inherited from QAbstractEventDispatcher
	QAbstractEventDispatcher (QAbstractEventDispatcherPrivate &, QObject *parent)

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

Event dispatcher for Windows.

Maintains a global stack storing the current event dispatcher and its processing flags for access from the Windows procedure qWindowsWndProc. Handling the QPA gui events should be done from within the qWindowsWndProc to ensure correct processing of messages.

Definition at line 23 of file qwindowsguieventdispatcher_p.h.

Constructor & Destructor Documentation

◆ QWindowsGuiEventDispatcher()

QWindowsGuiEventDispatcher::QWindowsGuiEventDispatcher ( QObject * parent = nullptr )

explicit

Definition at line 26 of file qwindowsguieventdispatcher.cpp.

References QStringLiteral, and QObject::setObjectName().

Here is the call graph for this function:

Member Function Documentation

◆ processEvents()

bool QWindowsGuiEventDispatcher::processEvents ( QEventLoop::ProcessEventsFlags flags )

overridevirtual

Processes pending events that match flags until there are no more events to process.

Returns true if an event was processed; otherwise returns false.

This function is especially useful if you have a long running operation, and want to show its progress without allowing user input by using the QEventLoop::ExcludeUserInputEvents flag.

If the QEventLoop::WaitForMoreEvents flag is set in flags, the behavior of this function is as follows:

\list