QAbstractEventDispatcher Class

Member Function Documentation

[explicit] QAbstractEventDispatcher::QAbstractEventDispatcher(QObject *parent = nullptr)

Constructs a new event dispatcher with the given parent.

[virtual noexcept] QAbstractEventDispatcher::~QAbstractEventDispatcher()

Destroys the event dispatcher.

[signal] void QAbstractEventDispatcher::aboutToBlock()

This signal is emitted before the event loop calls a function that could block.

See also awake().

[signal] void QAbstractEventDispatcher::awake()

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

See also wakeUp() and aboutToBlock().

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.

See also installNativeEventFilter() and QAbstractNativeEventFilter::nativeEventFilter().

void QAbstractEventDispatcher::installNativeEventFilter(QAbstractNativeEventFilter *filterObj)

Installs an event filter filterObj for all native events received by the application.

The event filter filterObj receives events via its nativeEventFilter() function, which is called for all events received by all threads.

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

See also QObject::installEventFilter().

[static] QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread = nullptr)

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.

[pure virtual] void QAbstractEventDispatcher::interrupt()

Interrupts event dispatching. The event dispatcher will return from processEvents() as soon as possible.

[pure virtual] bool QAbstractEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags)

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:

• If events are available, this function returns after processing them.
• If no events are available, this function will wait until more are available and return after processing newly available events.

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.

[pure virtual] void QAbstractEventDispatcher::registerSocketNotifier(QSocketNotifier *notifier)

Registers notifier with the event loop. Subclasses must implement this method to tie a socket notifier into another event loop.

[since 6.8] void QAbstractEventDispatcher::registerTimer(Qt::TimerId timerId, QAbstractEventDispatcher::Duration interval, Qt::TimerType timerType, QObject *object)

Register a timer with the specified timerId, interval, and timerType for the given object.

This function was introduced in Qt 6.8.

See also unregisterTimer() and timersForObject().

[pure virtual] void QAbstractEventDispatcher::registerTimer(int timerId, qint64 interval, Qt::TimerType timerType, QObject *object)

Register a timer with the specified timerId, interval, and timerType for the given object.

[since 6.8] Qt::TimerId QAbstractEventDispatcher::registerTimer(QAbstractEventDispatcher::Duration interval, Qt::TimerType timerType, QObject *object)

This is an overloaded function.

Registers a timer with the specified interval and timerType for the given object and returns the timer id.

This function was introduced in Qt 6.8.

[pure virtual] QList<QAbstractEventDispatcher::TimerInfo> QAbstractEventDispatcher::registeredTimers(QObject *object) const

Returns a list of registered timers for object. The TimerInfo struct has timerId, interval, and timerType members.

See also Qt::TimerType.

[pure virtual] int QAbstractEventDispatcher::remainingTime(int timerId)

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.

See also Qt::TimerType.

QAbstractEventDispatcher::Duration QAbstractEventDispatcher::remainingTime(Qt::TimerId timerId) const

Returns the remaining time of the timer with the given timerId. If the timer is inactive, the returned value will be negative. If the timer is overdue, the returned value will be 0.

See also Qt::TimerType, registerTimer(), and unregisterTimer().

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 nativeEventFilter() function).

See also installNativeEventFilter() and QAbstractNativeEventFilter.

[since 6.8] QList<QAbstractEventDispatcher::TimerInfoV2> QAbstractEventDispatcher::timersForObject(QObject *object) const

Returns a list of registered timers for object. The TimerInfoV2 struct has timerId, interval, and timerType members.

This function was introduced in Qt 6.8.

See also Qt::TimerType, registerTimer(), and unregisterTimer().

[pure virtual] void QAbstractEventDispatcher::unregisterSocketNotifier(QSocketNotifier *notifier)

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.

[since 6.8] bool QAbstractEventDispatcher::unregisterTimer(Qt::TimerId timerId)

Unregisters the timer with the given timerId. Returns true if successful; otherwise returns false.

This function was introduced in Qt 6.8.

See also registerTimer() and unregisterTimers().

[pure virtual] bool QAbstractEventDispatcher::unregisterTimer(int timerId)

Unregisters the timer with the given timerId. Returns true if successful; otherwise returns false.

See also registerTimer() and unregisterTimers().

[pure virtual] bool QAbstractEventDispatcher::unregisterTimers(QObject *object)

Unregisters all the timers associated with the given object. Returns true if all timers were successfully removed; otherwise returns false.

See also unregisterTimer() and registeredTimers().

[pure virtual] void QAbstractEventDispatcher::wakeUp()

Wakes up the event loop.

Note: This function is thread-safe.

See also awake().