QEventLoop Class

The QEventLoop class provides a means of entering and leaving an event loop. More...

Header: #include <QEventLoop>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Inherits: QObject

Public Types

enum ProcessEventsFlag { AllEvents, ExcludeUserInputEvents, ExcludeSocketNotifiers, WaitForMoreEvents }
flags ProcessEventsFlags

Public Functions

QEventLoop(QObject *parent = nullptr)
virtual ~QEventLoop()
int exec(QEventLoop::ProcessEventsFlags flags = AllEvents)
bool isRunning() const
bool processEvents(QEventLoop::ProcessEventsFlags flags = AllEvents)
void processEvents(QEventLoop::ProcessEventsFlags flags, int maxTime)
(since 6.7) void processEvents(QEventLoop::ProcessEventsFlags flags, QDeadlineTimer deadline)
void wakeUp()

Reimplemented Public Functions

virtual bool event(QEvent *event) override

Public Slots

void exit(int returnCode = 0)
void quit()

Detailed Description

At any time, you can create a QEventLoop object and call exec() on it to start a local event loop. From within the event loop, calling exit() will force exec() to return.

See also QAbstractEventDispatcher.

Member Type Documentation

enum QEventLoop::ProcessEventsFlag
flags QEventLoop::ProcessEventsFlags

This enum controls the types of events processed by the processEvents() functions.

QEventLoop::AllEvents0x00All events. Note that DeferredDelete events are processed specially. See QObject::deleteLater() for more details.
QEventLoop::ExcludeUserInputEvents0x01Do not process user input events, such as ButtonPress and KeyPress. Note that the events are not discarded; they will be delivered the next time processEvents() is called without the ExcludeUserInputEvents flag.
QEventLoop::ExcludeSocketNotifiers0x02Do not process socket notifier events. Note that the events are not discarded; they will be delivered the next time processEvents() is called without the ExcludeSocketNotifiers flag.
QEventLoop::WaitForMoreEvents0x04Wait for events if no pending events are available.

The ProcessEventsFlags type is a typedef for QFlags<ProcessEventsFlag>. It stores an OR combination of ProcessEventsFlag values.

See also processEvents().

Member Function Documentation

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

Constructs an event loop object with the given parent.

[virtual noexcept] QEventLoop::~QEventLoop()

Destroys the event loop object.

[override virtual] bool QEventLoop::event(QEvent *event)

Reimplements: QObject::event(QEvent *e).

int QEventLoop::exec(QEventLoop::ProcessEventsFlags flags = AllEvents)

Enters the main event loop and waits until exit() is called. Returns the value that was passed to exit().

If flags are specified, only events of the types allowed by the flags will be processed.

It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets.

Generally speaking, no user interaction can take place before calling exec(). As a special case, modal widgets like QMessageBox can be used before calling exec(), because modal widgets use their own local event loop.

To make your application perform idle processing (i.e. executing a special function whenever there are no pending events), use a QTimer with 0 timeout. More sophisticated idle processing schemes can be achieved using processEvents().

See also QCoreApplication::quit(), exit(), and processEvents().

[slot] void QEventLoop::exit(int returnCode = 0)

Tells the event loop to exit with a return code.

After this function has been called, the event loop returns from the call to exec(). The exec() function returns returnCode.

By convention, a returnCode of 0 means success, and any non-zero value indicates an error.

Note that unlike the C library function of the same name, this function does return to the caller – it is event processing that stops.

See also QCoreApplication::quit(), quit(), and exec().

bool QEventLoop::isRunning() const

Returns true if the event loop is running; otherwise returns false. The event loop is considered running from the time when exec() is called until exit() is called.

See also exec() and exit().

bool QEventLoop::processEvents(QEventLoop::ProcessEventsFlags flags = AllEvents)

Processes some pending events that match flags. Returns true if pending events were handled; 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; i.e. by using the ExcludeUserInputEvents flag.

This function is simply a wrapper for QAbstractEventDispatcher::processEvents(). See the documentation for that function for details.

void QEventLoop::processEvents(QEventLoop::ProcessEventsFlags flags, int maxTime)

This is an overloaded function.

Process pending events that match flags for a maximum of maxTime milliseconds, or until there are no more events to process, whichever is shorter.

Equivalent to calling:

processEvents(flags, QDeadlineTimer(maxTime));

[since 6.7] void QEventLoop::processEvents(QEventLoop::ProcessEventsFlags flags, QDeadlineTimer deadline)

Process pending events that match flags until deadline has expired, or until there are no more events to process, whichever happens first. This function is especially useful if you have a long running operation and want to show its progress without allowing user input, i.e. by using the ExcludeUserInputEvents flag.


  • This function does not process events continuously; it returns after all available events are processed.
  • Specifying the WaitForMoreEvents flag makes no sense and will be ignored.

This function was introduced in Qt 6.7.

[slot] void QEventLoop::quit()

Tells the event loop to exit normally.

Same as exit(0).

See also QCoreApplication::quit() and exit().

void QEventLoop::wakeUp()

Wakes up the event loop.

See also QAbstractEventDispatcher::wakeUp().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.