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
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qfxevents_p.h"
QT_BEGIN_NAMESPACE
/*!
\qmlclass KeyEvent QFxKeyEvent
\brief The KeyEvent object provides information about a key event.
For example, the following changes the Item's state property when the Enter
key is pressed:
\qml
Item {
focus: true
onKeyPress: { if (event.key == Qt.Key_Enter) state = 'ShowDetails'; }
}
\endqml
The \l KeyActions object could also be used to achieve the above with
a clearer syntax.
\sa KeyActions
*/
/*!
\internal
\class QFxKeyEvent
*/
/*!
\qmlproperty int KeyEvent::key
This property holds the code of the key that was pressed or released.
See \l {Qt::Key}{Qt.Key} for the list of keyboard codes. These codes are
independent of the underlying window system. Note that this
function does not distinguish between capital and non-capital
letters, use the text() function (returning the Unicode text the
key generated) for this purpose.
A value of either 0 or \l {Qt::Key_unknown}{Qt.Key_Unknown} means that the event is not
the result of a known key; for example, it may be the result of
a compose sequence, a keyboard macro, or due to key event
compression.
*/
/*!
\qmlproperty string KeyEvent::text
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 \c key will contain a valid value
*/
/*!
\qmlproperty bool KeyEvent::isAutoRepeat
This property holds whether this event comes from an auto-repeating key.
*/
/*!
\qmlproperty int KeyEvent::count
This property holds the number of keys involved in this event. If \l KeyEvent::text
is not empty, this is simply the length of the string.
*/
/*!
\qmlclass MouseEvent QFxMouseEvent
\brief The MouseEvent object provides information about a mouse event.
The position of the mouse can be found via the x and y properties.
The button that caused the event is available via the button property.
*/
/*!
\internal
\class QFxMouseEvent
*/
/*!
\qmlproperty int MouseEvent::x
\qmlproperty int MouseEvent::y
These properties hold the position of the mouse event.
*/
/*!
\qmlproperty enum MouseEvent::button
This property holds the button that caused the event. It can be one of:
\list
\o Qt.LeftButton
\o Qt.RightButton
\o Qt.MidButton
\endlist
*/
/*!
\qmlproperty int MouseEvent::buttons
This property holds the mouse buttons pressed when the event was generated.
For mouse move events, this is all buttons that are pressed down. For mouse
press and double click events this includes the button that caused the event.
For mouse release events this excludes the button that caused the event.
It contains a bitwise combination of:
\list
\o Qt.LeftButton
\o Qt.RightButton
\o Qt.MidButton
\endlist
*/
/*!
\qmlproperty int MouseEvent::modifiers
This property holds the keyboard modifier flags that existed immediately
before the event occurred.
It contains a bitwise combination of:
\list
\o Qt.NoModifier - No modifier key is pressed.
\o Qt.ShiftModifier - A Shift key on the keyboard is pressed.
\o Qt.ControlModifier - A Ctrl key on the keyboard is pressed.
\o Qt.AltModifier - An Alt key on the keyboard is pressed.
\o Qt.MetaModifier - A Meta key on the keyboard is pressed.
\o Qt.KeypadModifier - A keypad button is pressed.
\endlist
For example, to react to a Shift key + Left mouse button click:
\qml
MouseRegion {
onClick: { if (mouse.button == Qt.LeftButton && mouse.modifiers & Qt.ShiftModifier) doSomething(); }
}
\endqml
*/
QML_DEFINE_NOCREATE_TYPE(QFxKeyEvent);
QML_DEFINE_NOCREATE_TYPE(QFxMouseEvent);
QT_END_NAMESPACE
|
