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 | #include "qabstractnativeeventfilter.h" |
41 | #include "qabstracteventdispatcher.h" |
42 | |
43 | QT_BEGIN_NAMESPACE |
44 | |
45 | /*! |
46 | \class QAbstractNativeEventFilter |
47 | \inmodule QtCore |
48 | \since 5.0 |
49 | |
50 | \brief The QAbstractNativeEventFilter class provides an interface for receiving native |
51 | events, such as MSG or XCB event structs. |
52 | */ |
53 | |
54 | /*! |
55 | Creates a native event filter. |
56 | |
57 | By default this doesn't do anything. Remember to install it on the application |
58 | object. |
59 | */ |
60 | QAbstractNativeEventFilter::QAbstractNativeEventFilter() |
61 | { |
62 | Q_UNUSED(d); |
63 | } |
64 | |
65 | /*! |
66 | Destroys the native event filter. |
67 | |
68 | This automatically removes it from the application. |
69 | */ |
70 | QAbstractNativeEventFilter::~QAbstractNativeEventFilter() |
71 | { |
72 | QAbstractEventDispatcher *eventDispatcher = QAbstractEventDispatcher::instance(); |
73 | if (eventDispatcher) |
74 | eventDispatcher->removeNativeEventFilter(filterObj: this); |
75 | } |
76 | |
77 | // ### fixme Qt 6: result will be qintptr * |
78 | /*! |
79 | \fn bool QAbstractNativeEventFilter::nativeEventFilter(const QByteArray &eventType, void *message, long *result) |
80 | |
81 | This method is called for every native event. |
82 | |
83 | \note The filter function here receives native messages, |
84 | for example, MSG or XCB event structs. |
85 | |
86 | It is called by the QPA platform plugin. On Windows, it is called by |
87 | the event dispatcher. |
88 | |
89 | The type of event \a eventType is specific to the platform plugin chosen at run-time, |
90 | and can be used to cast \a message to the right type. |
91 | |
92 | On X11, \a eventType is set to "xcb_generic_event_t", and the \a message can be casted |
93 | to a xcb_generic_event_t pointer. |
94 | |
95 | On Windows, \a eventType is set to "windows_generic_MSG" for messages sent to toplevel windows, |
96 | and "windows_dispatcher_MSG" for system-wide messages such as messages from a registered hot key. |
97 | In both cases, the \a message can be casted to a MSG pointer. |
98 | The \a result pointer is only used on Windows, and corresponds to the LRESULT pointer. |
99 | |
100 | On macOS, \a eventType is set to "mac_generic_NSEvent", and the \a message can be casted to an NSEvent pointer. |
101 | |
102 | In your reimplementation of this function, if you want to filter |
103 | the \a message out, i.e. stop it being handled further, return |
104 | true; otherwise return false. |
105 | |
106 | \b {Linux example} |
107 | \snippet code/src_corelib_kernel_qabstractnativeeventfilter.cpp 0 |
108 | |
109 | \b {macOS example} |
110 | |
111 | mycocoaeventfilter.h: |
112 | \snippet code/src_corelib_kernel_qabstractnativeeventfilter.h 0 |
113 | |
114 | mycocoaeventfilter.mm: |
115 | \snippet code/src_corelib_kernel_qabstractnativeeventfilter.mm 0 |
116 | |
117 | myapp.pro: |
118 | \snippet code/src_corelib_kernel_qabstractnativeeventfilter.pro 0 |
119 | */ |
120 | |
121 | QT_END_NAMESPACE |
122 | |