qtdeclarative5-doc-html 5.9.5-0ubuntu1 / usr / share / qt5 / doc / qtquick / qml-qtquick-mouseevent.html

This file is indexed.

/usr/share/qt5/doc/qtquick/qml-qtquick-mouseevent.html is in qtdeclarative5-doc-html 5.9.5-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickevents.cpp -->
  <title>MouseEvent QML Type | Qt Quick 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >MouseEvent QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">MouseEvent QML Type</h1>
<span class="subtitle"></span>
<!-- $$$MouseEvent-brief -->
<p>Provides information about a mouse event <a href="#details">More...</a></p>
<!-- @@@MouseEvent -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.7</td></tr></table></div><ul>
<li><a href="qml-qtquick-mouseevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#accepted-prop">accepted</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#button-prop">button</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#buttons-prop">buttons</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#modifiers-prop">modifiers</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#source-prop">source</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#wasHeld-prop">wasHeld</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#x-prop">x</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-mouseevent.html#y-prop">y</a></b></b> : real</li>
</ul>
<!-- $$$MouseEvent-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The position of the mouse can be found via the <a href="qml-qtquick-mouseevent.html#x-prop">x</a> and <a href="qml-qtquick-mouseevent.html#y-prop">y</a> properties. The button that caused the event is available via the <a href="qml-qtquick-mouseevent.html#button-prop">button</a> property.</p>
<p><b>See also </b><a href="qml-qtquick-mousearea.html">MouseArea</a>.</p>
<!-- @@@MouseEvent -->
<h2>Property Documentation</h2>
<!-- $$$accepted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accepted-prop">
<td class="tblQmlPropNode"><p>
<a name="accepted-prop"></a><span class="name">accepted</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Setting <i>accepted</i> to true prevents the mouse event from being propagated to items below this item.</p>
<p>Generally, if the item acts on the mouse event then it should be accepted so that items lower in the stacking order do not also respond to the same event.</p>
</div></div><!-- @@@accepted -->
<br/>
<!-- $$$button -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="button-prop">
<td class="tblQmlPropNode"><p>
<a name="button-prop"></a><span class="name">button</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the button that caused the event. It can be one of:</p>
<ul>
<li>Qt.LeftButton</li>
<li>Qt.RightButton</li>
<li>Qt.MiddleButton</li>
</ul>
</div></div><!-- @@@button -->
<br/>
<!-- $$$buttons -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="buttons-prop">
<td class="tblQmlPropNode"><p>
<a name="buttons-prop"></a><span class="name">buttons</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>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.</p>
<p>It contains a bitwise combination of:</p>
<ul>
<li>Qt.LeftButton</li>
<li>Qt.RightButton</li>
<li>Qt.MiddleButton</li>
</ul>
</div></div><!-- @@@buttons -->
<br/>
<!-- $$$modifiers -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="modifiers-prop">
<td class="tblQmlPropNode"><p>
<a name="modifiers-prop"></a><span class="name">modifiers</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the keyboard modifier flags that existed immediately before the event occurred.</p>
<p>It contains a bitwise combination of:</p>
<ul>
<li>Qt.NoModifier - No modifier key is pressed.</li>
<li>Qt.ShiftModifier - A Shift key on the keyboard is pressed.</li>
<li>Qt.ControlModifier - A Ctrl key on the keyboard is pressed.</li>
<li>Qt.AltModifier - An Alt key on the keyboard is pressed.</li>
<li>Qt.MetaModifier - A Meta key on the keyboard is pressed.</li>
<li>Qt.KeypadModifier - A keypad button is pressed.</li>
</ul>
<p>For example, to react to a Shift key + Left mouse button click:</p>
<pre class="qml">

  <span class="type"><a href="qml-qtquick-mousearea.html">MouseArea</a></span> {
      <span class="name">onClicked</span>: {
          <span class="keyword">if</span> ((<span class="name">mouse</span>.<span class="name">button</span> <span class="operator">==</span> <span class="name">Qt</span>.<span class="name">LeftButton</span>) <span class="operator">&amp;&amp;</span> (<span class="name">mouse</span>.<span class="name">modifiers</span> <span class="operator">&amp;</span> <span class="name">Qt</span>.<span class="name">ShiftModifier</span>))
              <span class="name">doSomething</span>();
      }
  }

</pre>
</div></div><!-- @@@modifiers -->
<br/>
<!-- $$$source -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="source-prop">
<td class="tblQmlPropNode"><p>
<a name="source-prop"></a><span class="name">source</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the source of the mouse event.</p>
<p>The mouse event source can be used to distinguish between genuine and artificial mouse events. When using other pointing devices such as touchscreens and graphics tablets, if the application does not make use of the actual touch or tablet events, mouse events may be synthesized by the operating system or by Qt itself.</p>
<p>The value can be one of:</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Qt.MouseEventNotSynthesized</code></td><td class="topAlign">The most common value. On platforms where such information is available, this value indicates that the event represents a genuine mouse event from the system.</td></tr>
<tr><td class="topAlign"><code>Qt.MouseEventSynthesizedBySystem</code></td><td class="topAlign">Indicates that the mouse event was synthesized from a touch or tablet event by the platform.</td></tr>
<tr><td class="topAlign"><code>Qt.MouseEventSynthesizedByQt</code></td><td class="topAlign">Indicates that the mouse event was synthesized from an unhandled touch or tablet event by Qt.</td></tr>
<tr><td class="topAlign"><code>Qt.MouseEventSynthesizedByApplication</code></td><td class="topAlign">Indicates that the mouse event was synthesized by the application. This allows distinguishing application-generated mouse events from the ones that are coming from the system or are synthesized by Qt.</td></tr>
</table></div>
<p>For example, to react only to events which come from an actual mouse:</p>
<pre class="qml">

  <span class="type"><a href="qml-qtquick-mousearea.html">MouseArea</a></span> {
      <span class="name">onPressed</span>: <span class="keyword">if</span> (<span class="name">mouse</span>.<span class="name">source</span> <span class="operator">!==</span> <span class="name">Qt</span>.<span class="name">MouseEventNotSynthesized</span>) {
          <span class="name">mouse</span>.<span class="name">accepted</span> <span class="operator">=</span> <span class="number">false</span>
      }

      <span class="name">onClicked</span>: <span class="name">doSomething</span>()
  }

</pre>
<p>If the handler for the press event rejects the event, it will be propagated further, and then another Item underneath can handle synthesized events from touchscreens. For example, if a Flickable is used underneath (and the <a href="qml-qtquick-mousearea.html">MouseArea</a> is not a child of the Flickable), it can be useful for the <a href="qml-qtquick-mousearea.html">MouseArea</a> to handle genuine mouse events in one way, while allowing touch events to fall through to the Flickable underneath, so that the ability to flick on a touchscreen is retained. In that case the ability to drag the Flickable via mouse would be lost, but it does not prevent Flickable from receiving mouse wheel events.</p>
<p>This QML property was introduced in  Qt 5.7.</p>
</div></div><!-- @@@source -->
<br/>
<!-- $$$wasHeld -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="wasHeld-prop">
<td class="tblQmlPropNode"><p>
<a name="wasHeld-prop"></a><span class="name">wasHeld</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property is true if the mouse button has been held pressed longer the threshold (800ms).</p>
</div></div><!-- @@@wasHeld -->
<br/>
<!-- $$$x -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="x-prop">
<td class="tblQmlPropNode"><p>
<a name="x-prop"></a><span class="name">x</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties hold the coordinates of the position supplied by the mouse event.</p>
</div></div><!-- @@@x -->
<br/>
<!-- $$$y -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="y-prop">
<td class="tblQmlPropNode"><p>
<a name="y-prop"></a><span class="name">y</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties hold the coordinates of the position supplied by the mouse event.</p>
</div></div><!-- @@@y -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.