<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmousehandler.cpp --> <title>MouseHandler QML Type | Qt 3D 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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-core-qmlmodule.html">QML Types</a></td><td >MouseHandler QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#signals">Signals</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">MouseHandler QML Type</h1> <span class="subtitle"></span> <!-- $$$MouseHandler-brief --> <p>Provides mouse event notification <a href="#details">More...</a></p> <!-- @@@MouseHandler --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Input 2.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-mousehandler.html"><a href="qt3dinput-qmousehandler.html">QMouseHandler</a></td></tr></table></div><ul> <li><a href="qml-qt3d-input-mousehandler-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-qt3d-input-mousehandler.html#containsMouse-prop">containsMouse</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt3d-input-mousehandler.html#sourceDevice-prop">sourceDevice</a></b></b> : MouseDevice</li> </ul> <a name="signals"></a> <h2 id="signals">Signals</h2> <ul> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#clicked-signal">clicked</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#doubleClicked-signal">doubleClicked</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#entered-signal">entered</a></b></b>()</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#exited-signal">exited</a></b></b>()</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#positionChanged-signal">positionChanged</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#pressAndHold-signal">pressAndHold</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#pressed-signal">pressed</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#released-signal">released</a></b></b>(MouseEvent <i>mouse</i>)</li> <li class="fn">void <b><b><a href="qml-qt3d-input-mousehandler.html#wheel-signal">wheel</a></b></b>(MouseEvent <i>mouse</i>)</li> </ul> <!-- $$$MouseHandler-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p><b>See also </b><a href="qml-qt3d-input-mousedevice.html">MouseDevice</a> and <a href="qml-qt3d-input-mouseevent.html">MouseEvent</a>.</p> <!-- @@@MouseHandler --> <h2>Property Documentation</h2> <!-- $$$containsMouse --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="containsMouse-prop"> <td class="tblQmlPropNode"><p> <a name="containsMouse-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">containsMouse</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Holds <code>true</code> if the QMouseHandler currently contains the mouse.</p> </div></div><!-- @@@containsMouse --> <br/> <!-- $$$sourceDevice --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="sourceDevice-prop"> <td class="tblQmlPropNode"><p> <a name="sourceDevice-prop"></a><span class="name">sourceDevice</span> : <span class="type"><a href="qml-qt3d-input-mousedevice.html">MouseDevice</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Holds the current mouse source device of the <a href="qml-qt3d-input-mousehandler.html">MouseHandler</a> instance.</p> </div></div><!-- @@@sourceDevice --> <br/> <h2>Signal Documentation</h2> <!-- $$$clicked --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="clicked-signal"> <td class="tblQmlFuncNode"><p> <a name="clicked-signal"></a><span class="type">void</span> <span class="name">clicked</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse button is clicked with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@clicked --> <br/> <!-- $$$doubleClicked --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="doubleClicked-signal"> <td class="tblQmlFuncNode"><p> <a name="doubleClicked-signal"></a><span class="type">void</span> <span class="name">doubleClicked</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse button is double clicked with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@doubleClicked --> <br/> <!-- $$$entered --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="entered-signal"> <td class="tblQmlFuncNode"><p> <a name="entered-signal"></a><span class="type">void</span> <span class="name">entered</span>()</p></td></tr> </table></div> </div><div class="qmldoc"></div></div><!-- @@@entered --> <br/> <!-- $$$exited --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="exited-signal"> <td class="tblQmlFuncNode"><p> <a name="exited-signal"></a><span class="type">void</span> <span class="name">exited</span>()</p></td></tr> </table></div> </div><div class="qmldoc"></div></div><!-- @@@exited --> <br/> <!-- $$$positionChanged --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="positionChanged-signal"> <td class="tblQmlFuncNode"><p> <a name="positionChanged-signal"></a><span class="type">void</span> <span class="name">positionChanged</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the mouse position changes with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@positionChanged --> <br/> <!-- $$$pressAndHold --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pressAndHold-signal"> <td class="tblQmlFuncNode"><p> <a name="pressAndHold-signal"></a><span class="type">void</span> <span class="name">pressAndHold</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse button is pressed and held down with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@pressAndHold --> <br/> <!-- $$$pressed --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pressed-signal"> <td class="tblQmlFuncNode"><p> <a name="pressed-signal"></a><span class="type">void</span> <span class="name">pressed</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse button is pressed with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@pressed --> <br/> <!-- $$$released --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="released-signal"> <td class="tblQmlFuncNode"><p> <a name="released-signal"></a><span class="type">void</span> <span class="name">released</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when a mouse button is released with the event details being contained within <i>mouse</i></p> </div></div><!-- @@@released --> <br/> <!-- $$$wheel --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="wheel-signal"> <td class="tblQmlFuncNode"><p> <a name="wheel-signal"></a><span class="type">void</span> <span class="name">wheel</span>(<span class="type"><a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></span> <i>mouse</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the mouse wheel is used with the event details being contained within <i>wheel</i></p> </div></div><!-- @@@wheel --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</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>