<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmouseevent.cpp --> <title>QMouseEvent Class | 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-cpp.html">C++ Classes</a></td><td >QMouseEvent</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="#public-types">Public Types</a></li> <li class="level1"><a href="#properties">Properties</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#related-non-members">Related Non-Members</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">QMouseEvent Class</h1> <span class="small-subtitle">(<a href="qt3dinput-qmouseevent.html">Qt3DInput::QMouseEvent</a>)<br/></span> <!-- $$$QMouseEvent-brief --> <p>The Qt3DCore::QMouseEvent contains parameters that describe a mouse event. <a href="#details">More...</a></p> <!-- @@@QMouseEvent --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <Qt3DInput/QMouseEvent></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dinput</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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-input-mouseevent.html">MouseEvent</a></td></tr></table></div><ul> <li><a href="qt3dinput-qmouseevent-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#Buttons-enum">Buttons</a></b> { LeftButton, RightButton, MiddleButton, BackButton, NoButton }</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#Modifiers-enum">Modifiers</a></b> { NoModifier, ShiftModifier, ControlModifier, AltModifier, MetaModifier, KeypadModifier }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <div class="table"><table class="propsummary"> <tr><td class="topAlign"><ul> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#accepted-prop">accepted</a></b> : bool</li> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#button-prop">button</a></b> : const Qt3DInput::QMouseEvent::Buttons</li> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#buttons-prop">buttons</a></b> : const int</li> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#modifiers-prop">modifiers</a></b> : const Qt3DInput::QMouseEvent::Modifiers</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#wasHeld-prop">wasHeld</a></b> : const bool</li> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#x-prop">x</a></b> : const int</li> <li class="fn"><b><a href="qt3dinput-qmouseevent.html#y-prop">y</a></b> : const int</li> </ul> </td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#QMouseEvent">QMouseEvent</a></b>(const QMouseEvent &<i>e</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#dtor.QMouseEvent">~QMouseEvent</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Buttons </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#button">button</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#buttons">buttons</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#isAccepted">isAccepted</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Modifiers </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#modifiers">modifiers</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#setAccepted">setAccepted</a></b>(bool <i>accepted</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QEvent::Type </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#type">type</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#wasHeld-prop">wasHeld</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#x">x</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#y">y</a></b>() const</td></tr> </table></div> <a name="related-non-members"></a> <h2 id="related-non-members">Related Non-Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qt3dinput-qmouseevent.html#QMouseEventPtr-typedef">QMouseEventPtr</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QMouseEvent-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The Qt3DCore::QMouseEvent contains parameters that describe a mouse event.</p> <p>Mouse events occur when a mouse button is pressed and the ray traversing the view, originating from the mouse position intersects with one or more elements of the scene.</p> </div> <p><b>See also </b><a href="qt3dinput-qkeyevent.html">QKeyEvent</a>, <a href="qt3dinput-qwheelevent.html">QWheelEvent</a>, and <a href="qt3dinput-qmousehandler.html">QMouseHandler</a>.</p> <!-- @@@QMouseEvent --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$Buttons$$$LeftButton$$$RightButton$$$MiddleButton$$$BackButton$$$NoButton --> <h3 class="fn" id="Buttons-enum"><a name="Buttons-enum"></a>enum QMouseEvent::<span class="name">Buttons</span></h3> <div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::LeftButton</code></td><td class="topAlign tblval"><code>Qt::LeftButton</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::RightButton</code></td><td class="topAlign tblval"><code>Qt::RightButton</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::MiddleButton</code></td><td class="topAlign tblval"><code>Qt::MiddleButton</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::BackButton</code></td><td class="topAlign tblval"><code>Qt::BackButton</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::NoButton</code></td><td class="topAlign tblval"><code>Qt::NoButton</code></td></tr> </table></div> <!-- @@@Buttons --> <!-- $$$Modifiers$$$NoModifier$$$ShiftModifier$$$ControlModifier$$$AltModifier$$$MetaModifier$$$KeypadModifier --> <h3 class="fn" id="Modifiers-enum"><a name="Modifiers-enum"></a>enum QMouseEvent::<span class="name">Modifiers</span></h3> <div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::NoModifier</code></td><td class="topAlign tblval"><code>Qt::NoModifier</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::ShiftModifier</code></td><td class="topAlign tblval"><code>Qt::ShiftModifier</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::ControlModifier</code></td><td class="topAlign tblval"><code>Qt::ControlModifier</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::AltModifier</code></td><td class="topAlign tblval"><code>Qt::AltModifier</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::MetaModifier</code></td><td class="topAlign tblval"><code>Qt::MetaModifier</code></td></tr> <tr><td class="topAlign"><code>Qt3DInput::QMouseEvent::KeypadModifier</code></td><td class="topAlign tblval"><code>Qt::KeypadModifier</code></td></tr> </table></div> <!-- @@@Modifiers --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$accepted-prop$$$isAccepted$$$setAcceptedbool --> <h3 class="fn" id="accepted-prop"><a name="accepted-prop"></a><span class="name">accepted</span> : <span class="type">bool</span></h3> <p>Specifies if the mouse event has been accepted</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#isAccepted">isAccepted</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#setAccepted">setAccepted</a></b></span>(bool <i>accepted</i>)</td></tr> </table></div> <!-- @@@accepted --> <!-- $$$button-prop$$$button --> <h3 class="fn" id="button-prop"><a name="button-prop"></a><span class="name">button</span> : const <span class="type">Qt3DInput::QMouseEvent::Buttons</span></h3> <p>Specifies the button triggering the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Buttons </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#button">button</a></b></span>() const</td></tr> </table></div> <!-- @@@button --> <!-- $$$buttons-prop$$$buttons --> <h3 class="fn" id="buttons-prop"><a name="buttons-prop"></a><span class="name">buttons</span> : const <span class="type">int</span></h3> <p>Specifies the button triggering the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#buttons">buttons</a></b></span>() const</td></tr> </table></div> <!-- @@@buttons --> <!-- $$$modifiers-prop$$$modifiers --> <h3 class="fn" id="modifiers-prop"><a name="modifiers-prop"></a><span class="name">modifiers</span> : const <span class="type">Qt3DInput::QMouseEvent::Modifiers</span></h3> <p>Specifies if any modifiers were applied to the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Modifiers </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#modifiers">modifiers</a></b></span>() const</td></tr> </table></div> <!-- @@@modifiers --> <!-- $$$wasHeld-prop$$$wasHeld --> <h3 class="fn" id="wasHeld-prop"><a name="wasHeld-prop"></a><span class="name">wasHeld</span> : const <span class="type">bool</span></h3> <p>Specifies if a mouse button was held down during the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>wasHeld</b></span>() const</td></tr> </table></div> <!-- @@@wasHeld --> <!-- $$$x-prop$$$x --> <h3 class="fn" id="x-prop"><a name="x-prop"></a><span class="name">x</span> : const <span class="type">int</span></h3> <p>Specifies The X coordinate of the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#x">x</a></b></span>() const</td></tr> </table></div> <!-- @@@x --> <!-- $$$y-prop$$$y --> <h3 class="fn" id="y-prop"><a name="y-prop"></a><span class="name">y</span> : const <span class="type">int</span></h3> <p>Specifies The y coordinate of the mouse event</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dinput-qmouseevent.html#y">y</a></b></span>() const</td></tr> </table></div> <!-- @@@y --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMouseEvent[overload1]$$$QMouseEventconstQMouseEvent& --> <h3 class="fn" id="QMouseEvent"><a name="QMouseEvent"></a>QMouseEvent::<span class="name">QMouseEvent</span>(const <span class="type"><a href="qt3dinput-qmouseevent.html#QMouseEvent">QMouseEvent</a></span> &<i>e</i>)</h3> <p>Constructs a new <a href="qt3dinput-qmouseevent.html">QMouseEvent</a> instance for the <a href="qt3dinput-qmouseevent.html">QMouseEvent</a> <i>e</i>.</p> <!-- @@@QMouseEvent --> <!-- $$$~QMouseEvent[overload1]$$$~QMouseEvent --> <h3 class="fn" id="dtor.QMouseEvent"><a name="dtor.QMouseEvent"></a>QMouseEvent::<span class="name">~QMouseEvent</span>()</h3> <p>Destroys the instance of QMouseEvent.</p><!-- @@@~QMouseEvent --> <!-- $$$button --> <h3 class="fn" id="button"><a name="button"></a><span class="type"><a href="qt3dinput-qmouseevent.html#Buttons-enum">Buttons</a></span> QMouseEvent::<span class="name">button</span>() const</h3> <p>Returns the mouse button of the mouse event.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#button-prop">button</a>. </p><!-- @@@button --> <!-- $$$buttons --> <h3 class="fn" id="buttons"><a name="buttons"></a><span class="type">int</span> QMouseEvent::<span class="name">buttons</span>() const</h3> <p>Returns a bitfield to be used to check for mouse buttons that may be accompanying the mouse event.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#buttons-prop">buttons</a>. </p><!-- @@@buttons --> <!-- $$$isAccepted --> <h3 class="fn" id="isAccepted"><a name="isAccepted"></a><span class="type">bool</span> QMouseEvent::<span class="name">isAccepted</span>() const</h3> <p>Returns whether the event was accepted.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#accepted-prop">accepted</a>. </p><!-- @@@isAccepted --> <!-- $$$modifiers --> <h3 class="fn" id="modifiers"><a name="modifiers"></a><span class="type"><a href="qt3dinput-qmouseevent.html#Modifiers-enum">Modifiers</a></span> QMouseEvent::<span class="name">modifiers</span>() const</h3> <p>Returns the keyboard modifiers that may be accompanying the mouse event.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#modifiers-prop">modifiers</a>. </p><!-- @@@modifiers --> <!-- $$$setAccepted --> <h3 class="fn" id="setAccepted"><a name="setAccepted"></a><span class="type">void</span> QMouseEvent::<span class="name">setAccepted</span>(<span class="type">bool</span> <i>accepted</i>)</h3> <p>Sets the event as accepted if <i>accepted</i> is true.</p> <p><b>Note: </b>When an event is accepted, it will prevent further propagation to other listeners.</p><p><b>Note:</b> Setter function for property <a href="qt3dinput-qmouseevent.html#accepted-prop">accepted</a>. </p><p><b>See also </b><a href="qt3dinput-qmouseevent.html#isAccepted">isAccepted</a>().</p> <!-- @@@setAccepted --> <!-- $$$type[overload1]$$$type --> <h3 class="fn" id="type"><a name="type"></a><span class="type">QEvent::Type</span> QMouseEvent::<span class="name">type</span>() const</h3> <p>Returns the QEvent::Type of the event.</p> <!-- @@@type --> <!-- $$$x --> <h3 class="fn" id="x"><a name="x"></a><span class="type">int</span> QMouseEvent::<span class="name">x</span>() const</h3> <p>Returns the x position of the mouse event.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#x-prop">x</a>. </p><!-- @@@x --> <!-- $$$y --> <h3 class="fn" id="y"><a name="y"></a><span class="type">int</span> QMouseEvent::<span class="name">y</span>() const</h3> <p>Returns the y position of the mouse event.</p> <p><b>Note:</b> Getter function for property <a href="qt3dinput-qmouseevent.html#y-prop">y</a>. </p><!-- @@@y --> </div> <div class="relnonmem"> <h2>Related Non-Members</h2> <!-- $$$QMouseEventPtr --> <h3 class="fn" id="QMouseEventPtr-typedef"><a name="QMouseEventPtr-typedef"></a>typedef Qt3DInput::<span class="name">QMouseEventPtr</span></h3> <p>A shared pointer for <a href="qt3dinput-qmouseevent.html">QMouseEvent</a>.</p> <!-- @@@QMouseEventPtr --> </div> </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>