1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QEVENTLOOP_H
41#define QEVENTLOOP_H
42
43#include <QtCore/qobject.h>
44
45QT_BEGIN_NAMESPACE
46
47
48class QEventLoopPrivate;
49
50class Q_CORE_EXPORT QEventLoop : public QObject
51{
52 Q_OBJECT
53 Q_DECLARE_PRIVATE(QEventLoop)
54
55public:
56 explicit QEventLoop(QObject *parent = nullptr);
57 ~QEventLoop();
58
59 enum ProcessEventsFlag {
60 AllEvents = 0x00,
61 ExcludeUserInputEvents = 0x01,
62 ExcludeSocketNotifiers = 0x02,
63 WaitForMoreEvents = 0x04,
64 X11ExcludeTimers = 0x08,
65 EventLoopExec = 0x20,
66 DialogExec = 0x40
67 };
68 Q_DECLARE_FLAGS(ProcessEventsFlags, ProcessEventsFlag)
69
70 bool processEvents(ProcessEventsFlags flags = AllEvents);
71 void processEvents(ProcessEventsFlags flags, int maximumTime);
72
73 int exec(ProcessEventsFlags flags = AllEvents);
74 void exit(int returnCode = 0);
75 bool isRunning() const;
76
77 void wakeUp();
78
79 bool event(QEvent *event) override;
80
81public Q_SLOTS:
82 void quit();
83};
84
85Q_DECLARE_OPERATORS_FOR_FLAGS(QEventLoop::ProcessEventsFlags)
86
87
88class QEventLoopLockerPrivate;
89
90class Q_CORE_EXPORT QEventLoopLocker
91{
92public:
93 QEventLoopLocker();
94 explicit QEventLoopLocker(QEventLoop *loop);
95 explicit QEventLoopLocker(QThread *thread);
96 ~QEventLoopLocker();
97
98private:
99 Q_DISABLE_COPY(QEventLoopLocker)
100 QEventLoopLockerPrivate *d_ptr;
101};
102
103QT_END_NAMESPACE
104
105#endif // QEVENTLOOP_H
106