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 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 virtual bool hasPendingEvents() = 0; // ### Qt6: remove, mark final or make protected
80
81 virtual void registerSocketNotifier(QSocketNotifier *notifier) = 0;
82 virtual void unregisterSocketNotifier(QSocketNotifier *notifier) = 0;
83
84#if QT_DEPRECATED_SINCE(5,0)
85 QT_DEPRECATED inline int registerTimer(int interval, QObject *object)
86 { return registerTimer(interval, Qt::CoarseTimer, object); }
87 QT_DEPRECATED inline void registerTimer(int timerId, int interval, QObject *object)
88 { registerTimer(timerId, interval, Qt::CoarseTimer, object); }
89#endif
90 // ### Qt6: change interval range to qint64 (or use QDeadlineTimer)
91 int registerTimer(int interval, Qt::TimerType timerType, QObject *object);
92 virtual void registerTimer(int timerId, int interval, Qt::TimerType timerType, QObject *object) = 0;
93 virtual bool unregisterTimer(int timerId) = 0;
94 virtual bool unregisterTimers(QObject *object) = 0;
95 virtual QList<TimerInfo> registeredTimers(QObject *object) const = 0;
96
97 virtual int remainingTime(int timerId) = 0;
98
99#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC)
100 virtual bool registerEventNotifier(QWinEventNotifier *notifier) = 0;
101 virtual void unregisterEventNotifier(QWinEventNotifier *notifier) = 0;
102#endif
103
104 virtual void wakeUp() = 0;
105 virtual void interrupt() = 0;
106 virtual void flush() = 0; // ### Qt6: remove, mark final or make protected
107
108 virtual void startingUp();
109 virtual void closingDown();
110
111 void installNativeEventFilter(QAbstractNativeEventFilter *filterObj);
112 void removeNativeEventFilter(QAbstractNativeEventFilter *filterObj);
113 bool filterNativeEvent(const QByteArray &eventType, void *message, long *result);
114#if QT_DEPRECATED_SINCE(5, 0)
115 QT_DEPRECATED bool filterEvent(void *message)
116 { return filterNativeEvent("", message, nullptr); }
117#endif
118
119Q_SIGNALS:
120 void aboutToBlock();
121 void awake();
122
123protected:
124 QAbstractEventDispatcher(QAbstractEventDispatcherPrivate &,
125 QObject *parent);
126};
127
128Q_DECLARE_TYPEINFO(QAbstractEventDispatcher::TimerInfo, (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0) ? Q_PRIMITIVE_TYPE : Q_RELOCATABLE_TYPE));
129
130QT_END_NAMESPACE
131
132#endif // QABSTRACTEVENTDISPATCHER_H
133