![]() |
Qt 6.x
The Qt SDK
|
\inmodule QtCore More...
#include <qabstracteventdispatcher.h>
Classes | |
class | TimerInfo |
\inmodule QtCore More... | |
Signals | |
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. | |
![]() | |
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 | |
QAbstractEventDispatcher (QObject *parent=nullptr) | |
Constructs a new event dispatcher with the given parent. | |
~QAbstractEventDispatcher () | |
Destroys the event dispatcher. | |
virtual bool | processEvents (QEventLoop::ProcessEventsFlags flags)=0 |
Processes pending events that match flags until there are no more events to process. | |
virtual void | registerSocketNotifier (QSocketNotifier *notifier)=0 |
Registers notifier with the event loop. | |
virtual void | unregisterSocketNotifier (QSocketNotifier *notifier)=0 |
Unregisters notifier from the event dispatcher. | |
int | registerTimer (qint64 interval, Qt::TimerType timerType, QObject *object) |
Registers a timer with the specified interval and timerType for the given object and returns the timer id. | |
virtual void | registerTimer (int timerId, qint64 interval, Qt::TimerType timerType, QObject *object)=0 |
Register a timer with the specified timerId, interval, and timerType for the given object. | |
virtual bool | unregisterTimer (int timerId)=0 |
Unregisters the timer with the given timerId. | |
virtual bool | unregisterTimers (QObject *object)=0 |
Unregisters all the timers associated with the given object. | |
virtual QList< TimerInfo > | registeredTimers (QObject *object) const =0 |
Returns a list of registered timers for object. | |
virtual int | remainingTime (int timerId)=0 |
Returns the remaining time in milliseconds with the given timerId. | |
virtual void | wakeUp ()=0 |
\threadsafe | |
virtual void | interrupt ()=0 |
Interrupts event dispatching. | |
virtual void | startingUp () |
virtual void | closingDown () |
void | installNativeEventFilter (QAbstractNativeEventFilter *filterObj) |
\variable QAbstractEventDispatcher::TimerInfo::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(). | |
![]() | |
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 | 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. | |
void | moveToThread (QThread *thread) |
Changes the thread affinity for this object and its children. | |
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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
template<typename T > | |
T | findChild (const QString &aName=QString(), 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 (const QString &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 > | |
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 QAbstractEventDispatcher * | instance (QThread *thread=nullptr) |
Returns a pointer to the event dispatcher object for the specified thread. | |
![]() | |
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 | |
QAbstractEventDispatcher (QAbstractEventDispatcherPrivate &, QObject *parent) | |
![]() | |
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) | |
Additional Inherited Members | |
![]() | |
void | deleteLater () |
\threadsafe | |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
![]() | |
QString | objectName |
the name of this object | |
![]() | |
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) | |
\inmodule QtCore
The QAbstractEventDispatcher class provides an interface to manage Qt's event queue.
An event dispatcher receives events from the window system and other sources. It then sends them to the QCoreApplication or QApplication instance for processing and delivery. QAbstractEventDispatcher provides fine-grained control over event delivery.
For simple control of event processing use QCoreApplication::processEvents().
For finer control of the application's event loop, call instance() and call functions on the QAbstractEventDispatcher object that is returned. If you want to use your own instance of QAbstractEventDispatcher or of a QAbstractEventDispatcher subclass, you must install it with QCoreApplication::setEventDispatcher() or QThread::setEventDispatcher() before a default event dispatcher has been installed.
The main event loop is started by calling QCoreApplication::exec(), and stopped by calling QCoreApplication::exit(). Local event loops can be created using QEventLoop.
Programs that perform long operations can call processEvents() with a bitwise OR combination of various QEventLoop::ProcessEventsFlag values to control which events should be delivered.
QAbstractEventDispatcher also allows the integration of an external event loop with the Qt event loop.
Definition at line 16 of file qabstracteventdispatcher.h.
Constructs a new event dispatcher with the given parent.
Definition at line 119 of file qabstracteventdispatcher.cpp.
QAbstractEventDispatcher::~QAbstractEventDispatcher | ( | ) |
Destroys the event dispatcher.
Definition at line 132 of file qabstracteventdispatcher.cpp.
|
protected |
Definition at line 125 of file qabstracteventdispatcher.cpp.
|
signal |
This signal is emitted before the event loop calls a function that could block.
Referenced by QEventDispatcherGlib::processEvents(), QEventDispatcherUNIX::processEvents(), and QEventDispatcherWin32::processEvents().
|
signal |
This signal is emitted after the event loop returns from a function that could block.
Referenced by QCocoaEventDispatcher::processEvents(), QEventDispatcherGlib::processEvents(), QEventDispatcherUNIX::processEvents(), QEventDispatcherWasm::processEvents(), and QEventDispatcherWin32::processEvents().
|
virtual |
Reimplemented in QEventDispatcherWin32.
Definition at line 297 of file qabstracteventdispatcher.cpp.
Referenced by QCoreApplication::~QCoreApplication().
bool QAbstractEventDispatcher::filterNativeEvent | ( | const QByteArray & | eventType, |
void * | message, | ||
qintptr * | result | ||
) |
Sends message through the event filters that were set by installNativeEventFilter().
This function returns true
as soon as an event filter returns true
, and false otherwise to indicate that the processing of the event should continue.
Subclasses of QAbstractEventDispatcher must call this function for all messages received from the system to ensure compatibility with any extensions that may be used in the application. The type of event eventType is specific to the platform plugin chosen at run-time, and can be used to cast message to the right type. The result pointer is only used on Windows, and corresponds to the LRESULT pointer.
Note that the type of message is platform dependent. See QAbstractNativeEventFilter for details.
Definition at line 412 of file qabstracteventdispatcher.cpp.
Referenced by QXcbConnection::handleXcbError(), QXcbGlxIntegration::handleXcbEvent(), QCocoaEventDispatcher::processEvents(), and QEventDispatcherWin32::processEvents().
void QAbstractEventDispatcher::installNativeEventFilter | ( | QAbstractNativeEventFilter * | filterObj | ) |
\variable QAbstractEventDispatcher::TimerInfo::timerId
The timer's unique id.
\variable QAbstractEventDispatcher::TimerInfo::interval
The timer's interval.
\variable QAbstractEventDispatcher::TimerInfo::timerType
The timer's type
Installs an event filter filterObj for all native events received by the application.
The event filter filterObj receives events via its \l {QAbstractNativeEventFilter::}{nativeEventFilter()} function, which is called for all events received by all threads.
The \l {QAbstractNativeEventFilter::}{nativeEventFilter()} function should return true if the event should be filtered, (in this case, stopped). It should return false to allow normal Qt processing to continue: the native event can then be translated into a QEvent and handled by the standard Qt \l{QEvent} {event} filtering, e.g. QObject::installEventFilter().
If multiple event filters are installed, the filter that was installed last is activated first.
For maximum portability, you should always try to use QEvent objects and QObject::installEventFilter() whenever possible.
Definition at line 359 of file qabstracteventdispatcher.cpp.
References d.
Referenced by QQnxWindowGrabber::QQnxWindowGrabber(), QCoreApplication::installNativeEventFilter(), and QBenchmarkEvent::start().
|
static |
Returns a pointer to the event dispatcher object for the specified thread.
If thread is \nullptr, the current thread is used. If no event dispatcher exists for the specified thread, this function returns \nullptr.
{Note:} If Qt is built without thread support, the thread argument is ignored.
Definition at line 144 of file qabstracteventdispatcher.cpp.
References QThreadData::current(), QThreadData::get2(), and QObject::thread().
Referenced by QWindowsFileSystemWatcherEngine::QWindowsFileSystemWatcherEngine(), QAbstractNativeEventFilter::~QAbstractNativeEventFilter(), QXcbConnection::handleXcbError(), QXcbConnection::handleXcbEvent(), QXcbGlxIntegration::handleXcbEvent(), QCoreApplication::installNativeEventFilter(), QTimer::remainingTime(), QCoreApplication::removeNativeEventFilter(), QEventDispatcherWasm::socketSelect(), QBenchmarkEvent::start(), QBasicTimer::start(), QBasicTimer::stop(), and QBenchmarkEvent::stop().
|
pure virtual |
Interrupts event dispatching.
The event dispatcher will return from processEvents() as soon as possible.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
|
pure virtual |
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
\endlist
If the QEventLoop::WaitForMoreEvents flag is not set in flags, and no events are available, this function will return immediately.
{Note:} This function does not process events continuously; it returns after all available events are processed.
Implemented in QCocoaEventDispatcher, QEventDispatcherCoreFoundation, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherWasm, QEventDispatcherWin32, QPAEventDispatcherGlib, QUnixEventDispatcherQPA, QWindowsGuiEventDispatcher, QAndroidEventDispatcher, QIOSJumpingEventDispatcher, and QXcbUnixEventDispatcher.
|
pure virtual |
Returns a list of registered timers for object.
The TimerInfo struct has timerId
, interval
, and timerType
members.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
Referenced by QObject::event().
|
pure virtual |
Registers notifier with the event loop.
Subclasses must implement this method to tie a socket notifier into another event loop.
Implemented in QCocoaEventDispatcher, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, QEventDispatcherWin32, and QEventDispatcherGlib.
|
pure virtual |
Register a timer with the specified timerId, interval, and timerType for the given object.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
int QAbstractEventDispatcher::registerTimer | ( | qint64 | interval, |
Qt::TimerType | timerType, | ||
QObject * | object | ||
) |
Registers a timer with the specified interval and timerType for the given object and returns the timer id.
Definition at line 211 of file qabstracteventdispatcher.cpp.
References QAbstractEventDispatcherPrivate::allocateTimerId(), and registerTimer().
Referenced by registerTimer(), and QBasicTimer::start().
|
pure virtual |
Returns the remaining time in milliseconds with the given timerId.
If the timer is inactive, the returned value will be -1. If the timer is overdue, the returned value will be 0.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
Referenced by QTimer::remainingTime().
void QAbstractEventDispatcher::removeNativeEventFilter | ( | QAbstractNativeEventFilter * | filter | ) |
Removes the event filter filter from this object.
The request is ignored if such an event filter has not been installed.
All event filters for this object are automatically removed when this object is destroyed.
It is always safe to remove an event filter, even during event filter filter activation (that is, even from within the \l {QAbstractNativeEventFilter::}{nativeEventFilter()} function).
Definition at line 382 of file qabstracteventdispatcher.cpp.
Referenced by QAbstractNativeEventFilter::~QAbstractNativeEventFilter(), QQnxWindowGrabber::~QQnxWindowGrabber(), QCoreApplication::removeNativeEventFilter(), and QBenchmarkEvent::stop().
|
virtual |
Reimplemented in QEventDispatcherCoreFoundation, and QEventDispatcherWin32.
Definition at line 291 of file qabstracteventdispatcher.cpp.
Referenced by QCoreApplication::QCoreApplication(), QGuiApplication::QGuiApplication(), and QApplicationPrivate::init().
|
pure virtual |
Unregisters notifier from the event dispatcher.
Subclasses must reimplement this method to tie a socket notifier into another event loop. Reimplementations must call the base implementation.
Implemented in QCocoaEventDispatcher, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, QEventDispatcherWin32, and QEventDispatcherGlib.
|
pure virtual |
Unregisters the timer with the given timerId.
Returns true
if successful; otherwise returns false
.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
Referenced by QBasicTimer::stop().
|
pure virtual |
Unregisters all the timers associated with the given object.
Returns true
if all timers were successful removed; otherwise returns false
.
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherUNIX, QEventDispatcherCoreFoundation, QEventDispatcherWasm, and QEventDispatcherWin32.
Referenced by QObject::event().
|
pure virtual |
\threadsafe
Wakes up the event loop.
\omit
On Unix and Glib event dispatchers, if the dispatcher is already awake when this function is called, it is ensured that the current iteration won't block waiting for more events, but will instead do another event loop iteration.
\endomit
Implemented in QCocoaEventDispatcher, QEventDispatcherGlib, QEventDispatcherCoreFoundation, QEventDispatcherUNIX, QEventDispatcherWasm, and QEventDispatcherWin32.
Referenced by QCoreApplication::postEvent(), and QXcbEventQueue::wakeUpDispatcher().