1/****************************************************************************
2**
3** Copyright (C) 2020 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 QABSTRACTEVENTDISPATCHER_H
41#define QABSTRACTEVENTDISPATCHER_H
42
43#include <QtCore/qobject.h>
44#include <QtCore/qeventloop.h>
45
46QT_BEGIN_NAMESPACE
47
48class QAbstractNativeEventFilter;
49class QAbstractEventDispatcherPrivate;
50class QSocketNotifier;
51
52#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
53class QWinEventNotifier;
54#endif
55
56class Q_CORE_EXPORT QAbstractEventDispatcher : public QObject
57{
58 Q_OBJECT
59 Q_DECLARE_PRIVATE(QAbstractEventDispatcher)
60
61public:
62 struct TimerInfo
63 {
64 int timerId;
65 int interval;
66 Qt::TimerType timerType;
67
68 inline TimerInfo(int id, int i, Qt::TimerType t)
69 : timerId(id), interval(i), timerType(t)
70 { }
71 };
72
73 explicit QAbstractEventDispatcher(QObject *parent = nullptr);
74 ~QAbstractEventDispatcher();
75
76 static QAbstractEventDispatcher *instance(QThread *thread = nullptr);
77
78 virtual bool processEvents(QEventLoop::ProcessEventsFlags flags) = 0;
79
80 virtual void registerSocketNotifier(QSocketNotifier *notifier) = 0;
81 virtual void unregisterSocketNotifier(QSocketNotifier *notifier) = 0;
82
83 int registerTimer(qint64 interval, Qt::TimerType timerType, QObject *object);
84 virtual void registerTimer(int timerId, qint64 interval, Qt::TimerType timerType, QObject *object) = 0;
85 virtual bool unregisterTimer(int timerId) = 0;
86 virtual bool unregisterTimers(QObject *object) = 0;
87 virtual QList<TimerInfo> registeredTimers(QObject *object) const = 0;
88
89 virtual int remainingTime(int timerId) = 0;
90
91#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
92 virtual bool registerEventNotifier(QWinEventNotifier *notifier) = 0;
93 virtual void unregisterEventNotifier(QWinEventNotifier *notifier) = 0;
94#endif
95
96 virtual void wakeUp() = 0;
97 virtual void interrupt() = 0;
98
99 virtual void startingUp();
100 virtual void closingDown();
101
102 void installNativeEventFilter(QAbstractNativeEventFilter *filterObj);
103 void removeNativeEventFilter(QAbstractNativeEventFilter *filterObj);
104 bool filterNativeEvent(const QByteArray &eventType, void *message, qintptr *result);
105
106Q_SIGNALS:
107 void aboutToBlock();
108 void awake();
109
110protected:
111 QAbstractEventDispatcher(QAbstractEventDispatcherPrivate &,
112 QObject *parent);
113};
114
115Q_DECLARE_TYPEINFO(QAbstractEventDispatcher::TimerInfo, Q_PRIMITIVE_TYPE);
116
117QT_END_NAMESPACE
118
119#endif // QABSTRACTEVENTDISPATCHER_H
120