1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
/****************************************************************************
**
** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qkeyevent.h"
QT_BEGIN_NAMESPACE
namespace Qt3DInput {
//Qt6: Move this into a QtQmlGui module and merge it with QQuickKeyEvent
/*!
\class Qt3DInput::QKeyEvent
\inmodule Qt3DInput
\brief QKeyEvent event type send by KeyBoardHandler.
\since 5.5
\brief Contains parameters that describe a key event
*/
/*!
\qmltype KeyEvent
\inqmlmodule Qt3D.Input
\instantiates Qt3DInput::QKeyEvent
\brief QML frontend for QKeyEvent C++ class.
\since 5.5
\brief Contains parameters that describe a key event
The KeyEvent QML type cannot be directly created. Objects of this type
are used as signal parameters in KeyboardHandler.
*/
/*!
* \typedef Qt3DInput::QKeyEventPtr
* \relates Qt3DInput::QKeyEvent
*
* A shared pointer for QKeyEvent.
*/
QKeyEvent::QKeyEvent(QEvent::Type type, int key, Qt::KeyboardModifiers modifiers, const QString &text, bool autorep, ushort count)
: QObject()
, m_event(type, key, modifiers, text, autorep, count)
{
m_event.setAccepted(false);
}
QKeyEvent::QKeyEvent(const QT_PREPEND_NAMESPACE(QKeyEvent) &ke)
: QObject()
, m_event(ke)
{
m_event.setAccepted(false);
}
/*! \internal */
QKeyEvent::~QKeyEvent()
{
}
/*!
\qmlproperty int Qt3D.Input::KeyEvent::key
\readonly
This property holds the code of the key that was pressed or released.
See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes.
\sa {QtQuick::KeyEvent::key}{KeyEvent.key}
*/
/*!
\qmlproperty string Qt3D.Input::KeyEvent::text
\readonly
This property holds the Unicode text that the key generated. The text
returned can be an empty string in cases where modifier keys, such as
Shift, Control, Alt, and Meta, are being pressed or released. In such
cases \l key will contain a valid value.
*/
/*!
\qmlproperty int Qt3D.Input::KeyEvent::modifiers
\readonly
This property holds the keyboard modifier flags that existed immediately
before the event occurred.
\sa {QtQuick::KeyEvent::modifiers}{KeyEvent.modifiers}
*/
/*!
\qmlproperty bool Qt3D.Input::KeyEvent::isAutoRepeat
\readonly
Holds whether this event comes from an auto-repeating key.
*/
/*!
\qmlproperty int Qt3D.Input::KeyEvent::count
\readonly
Holds the number of keys involved in this event. If \l text is not empty,
this is simply the length of the string.
*/
/*!
\qmlproperty quint32 Qt3D.Input::KeyEvent::nativeScanCode
\readonly
This property contains the native scan code of the key that was pressed.
It is passed through from QKeyEvent unchanged.
\sa QKeyEvent::nativeScanCode()
*/
/*!
\qmlproperty bool Qt3D.Input::KeyEvent::accepted
Setting \e accepted to \c true prevents the key event from being propagated
to the item's parent.
Generally, if the item acts on the key event then it should be accepted so
that ancestor items do not also respond to the same event.
*/
/*!
\qmlmethod bool Qt3D.Input::KeyEvent::matches(StandardKey key)
Returns \c true if the key event matches the given standard \a key; otherwise
returns \c false.
\sa QKeySequence::StandardKey
*/
/*!
\property Qt3DInput::QKeyEvent::key
\readonly
This property holds the code of the key that was pressed or released.
See \l [CPP] {Qt::Key}{Qt.Key} for the list of keyboard codes.
\b {See also} \l [QtGui] {QKeyEvent::key()}.
*/
/*!
\property Qt3DInput::QKeyEvent::text
\readonly
This property holds the Unicode text that the key generated. The text
returned can be an empty string in cases where modifier keys, such as
Shift, Control, Alt, and Meta, are being pressed or released. In such
cases \l key will contain a valid value.
*/
/*!
\property Qt3DInput::QKeyEvent::modifiers
\readonly
This property holds the keyboard modifier flags that existed immediately
before the event occurred.
\b {See also} \l [QtGui] {QKeyEvent::modifiers()}.
*/
/*!
\property Qt3DInput::QKeyEvent::isAutoRepeat
\readonly
Holds whether this event comes from an auto-repeating key.
*/
/*!
\property Qt3DInput::QKeyEvent::count
\readonly
Holds the number of keys involved in this event. If \l text is not empty,
this is simply the length of the string.
*/
/*!
\property Qt3DInput::QKeyEvent::nativeScanCode
\readonly
This property contains the native scan code of the key that was pressed.
It is passed through from QKeyEvent unchanged.
*/
/*!
\property Qt3DInput::QKeyEvent::accepted
Setting \e accepted to \c true prevents the key event from being propagated
to the item's parent.
Generally, if the item acts on the key event then it should be accepted so
that ancestor items do not also respond to the same event.
*/
/*!
\fn bool Qt3DInput::QKeyEvent::matches(QKeySequence::StandardKey key_) const
Returns \c true if the key event matches the given standard key \a key_; otherwise
returns \c false.
\sa QKeySequence::StandardKey
*/
/*!
\fn QEvent::Type Qt3DInput::QKeyEvent::type() const
Returns the type of the event.
*/
} // namespace Qt3DInput
QT_END_NAMESPACE
|
