<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmouseeventtransition.cpp --> <title>QMouseEventTransition Class | Qt Widgets 5.12.6</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.12</td><td ><a href="qtwidgets-index.html">Qt Widgets</a></td><td ><a href="qtwidgets-module.html">C++ Classes</a></td><td >QMouseEventTransition</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtwidgets-index.html">Qt 5.12.6 Reference Documentation</a></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="#public-functions">Public Functions</a></li> <li class="level1"><a href="#static-public-members">Static Public Members</a></li> <li class="level1"><a href="#reimplemented-protected-functions">Reimplemented Protected Functions</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">QMouseEventTransition Class</h1> <!-- $$$QMouseEventTransition-brief --> <p>The <a href="qmouseeventtransition.html">QMouseEventTransition</a> class provides a transition for mouse events. <a href="#details">More...</a></p> <!-- @@@QMouseEventTransition --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMouseEventTransition></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += widgets</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.6</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qeventtransition.html">QEventTransition</a></td></tr></table></div><ul> <li><a href="qmouseeventtransition-members.html">List of all members, including inherited members</a></li> <li><a href="qmouseeventtransition-obsolete.html">Obsolete members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qmouseeventtransition.html#button-prop">button</a></b> : Qt::MouseButton</li> <li class="fn"><b><a href="qmouseeventtransition.html#modifierMask-prop">modifierMask</a></b> : Qt::KeyboardModifiers</li> </ul> <ul> <li class="fn">2 properties inherited from <a href="../qtcore/qeventtransition.html#properties">QEventTransition</a></li> <li class="fn">4 properties inherited from <a href="../qtcore/qabstracttransition.html#properties">QAbstractTransition</a></li> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li> </ul> <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="qmouseeventtransition.html#QMouseEventTransition">QMouseEventTransition</a></b>(QState *<i>sourceState</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#QMouseEventTransition-1">QMouseEventTransition</a></b>(QObject *<i>object</i>, QEvent::Type <i>type</i>, Qt::MouseButton <i>button</i>, QState *<i>sourceState</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#dtor.QMouseEventTransition">~QMouseEventTransition</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::MouseButton </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#button">button</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPainterPath </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#hitTestPath">hitTestPath</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::KeyboardModifiers </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#modifierMask">modifierMask</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#setButton">setButton</a></b>(Qt::MouseButton <i>button</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#setHitTestPath">setHitTestPath</a></b>(const QPainterPath &<i>path</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#setModifierMask">setModifierMask</a></b>(Qt::KeyboardModifiers <i>modifierMask</i>)</td></tr> </table></div> <ul> <li class="fn">4 public functions inherited from <a href="../qtcore/qeventtransition.html#public-functions">QEventTransition</a></li> <li class="fn">11 public functions inherited from <a href="../qtcore/qabstracttransition.html#public-functions">QAbstractTransition</a></li> <li class="fn">31 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li> </ul> <a name="static-public-members"></a> <h2 id="static-public-members">Static Public Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <ul> <li class="fn">9 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> </ul> <a name="reimplemented-protected-functions"></a> <h2 id="reimplemented-protected-functions">Reimplemented Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#eventTest">eventTest</a></b>(QEvent *<i>event</i>) override</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmouseeventtransition.html#onTransition">onTransition</a></b>(QEvent *<i>event</i>) override</td></tr> </table></div> <ul> <li class="fn">3 protected functions inherited from <a href="../qtcore/qeventtransition.html#protected-functions">QEventTransition</a></li> <li class="fn">3 protected functions inherited from <a href="../qtcore/qabstracttransition.html#protected-functions">QAbstractTransition</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li> <li class="fn">3 signals inherited from <a href="../qtcore/qabstracttransition.html#signals">QAbstractTransition</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> <li class="fn">3 protected functions inherited from <a href="../qtcore/qeventtransition.html#protected-functions">QEventTransition</a></li> <li class="fn">3 protected functions inherited from <a href="../qtcore/qabstracttransition.html#protected-functions">QAbstractTransition</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QMouseEventTransition-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qmouseeventtransition.html">QMouseEventTransition</a> class provides a transition for mouse events.</p> <p><a href="qmouseeventtransition.html">QMouseEventTransition</a> is part of <a href="../qtcore/statemachine-api.html">The State Machine Framework</a>.</p> </div> <p><b>See also </b><a href="../qtcore/qstate.html#addTransition-3">QState::addTransition</a>().</p> <!-- @@@QMouseEventTransition --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$button-prop$$$button$$$setButtonQt::MouseButton --> <h3 class="fn" id="button-prop"><a name="button-prop"></a><span class="name">button</span> : <span class="type"><a href="../qtcore/qt.html#MouseButton-enum">Qt::MouseButton</a></span></h3> <p>This property holds the button that this mouse event transition is associated with</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::MouseButton </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmouseeventtransition.html#button">button</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmouseeventtransition.html#setButton">setButton</a></b></span>(Qt::MouseButton <i>button</i>)</td></tr> </table></div> <!-- @@@button --> <!-- $$$modifierMask-prop$$$modifierMask$$$setModifierMaskQt::KeyboardModifiers --> <h3 class="fn" id="modifierMask-prop"><a name="modifierMask-prop"></a><span class="name">modifierMask</span> : <span class="type"><a href="../qtcore/qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span></h3> <p>This property holds the keyboard modifier mask that this mouse event transition checks for</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::KeyboardModifiers </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmouseeventtransition.html#modifierMask">modifierMask</a></b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmouseeventtransition.html#setModifierMask">setModifierMask</a></b></span>(Qt::KeyboardModifiers <i>modifierMask</i>)</td></tr> </table></div> <!-- @@@modifierMask --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMouseEventTransition[overload1]$$$QMouseEventTransitionQState* --> <h3 class="fn" id="QMouseEventTransition"><a name="QMouseEventTransition"></a>QMouseEventTransition::<span class="name">QMouseEventTransition</span>(<span class="type"><a href="../qtcore/qstate.html">QState</a></span> *<i>sourceState</i> = nullptr)</h3> <p>Constructs a new mouse event transition with the given <i>sourceState</i>.</p> <!-- @@@QMouseEventTransition --> <!-- $$$QMouseEventTransition$$$QMouseEventTransitionQObject*QEvent::TypeQt::MouseButtonQState* --> <h3 class="fn" id="QMouseEventTransition-1"><a name="QMouseEventTransition-1"></a>QMouseEventTransition::<span class="name">QMouseEventTransition</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>object</i>, <span class="type"><a href="../qtcore/qevent.html#Type-enum">QEvent::Type</a></span> <i>type</i>, <span class="type"><a href="../qtcore/qt.html#MouseButton-enum">Qt::MouseButton</a></span> <i>button</i>, <span class="type"><a href="../qtcore/qstate.html">QState</a></span> *<i>sourceState</i> = nullptr)</h3> <p>Constructs a new mouse event transition for events of the given <i>type</i> for the given <i>object</i>, with the given <i>button</i> and <i>sourceState</i>.</p> <!-- @@@QMouseEventTransition --> <!-- $$$~QMouseEventTransition[overload1]$$$~QMouseEventTransition --> <h3 class="fn" id="dtor.QMouseEventTransition"><a name="dtor.QMouseEventTransition"></a><code>[virtual] </code>QMouseEventTransition::<span class="name">~QMouseEventTransition</span>()</h3> <p>Destroys this mouse event transition.</p> <!-- @@@~QMouseEventTransition --> <!-- $$$button --> <h3 class="fn" id="button"><a name="button"></a><span class="type"><a href="../qtcore/qt.html#MouseButton-enum">Qt::MouseButton</a></span> QMouseEventTransition::<span class="name">button</span>() const</h3> <p>Returns the button that this mouse event transition checks for.</p> <p><b>Note:</b> Getter function for property <a href="qmouseeventtransition.html#button-prop">button</a>. </p><p><b>See also </b><a href="qmouseeventtransition.html#setButton">setButton</a>().</p> <!-- @@@button --> <!-- $$$eventTest[overload1]$$$eventTestQEvent* --> <h3 class="fn" id="eventTest"><a name="eventTest"></a><code>[override virtual protected] </code><span class="type">bool</span> QMouseEventTransition::<span class="name">eventTest</span>(<span class="type"><a href="../qtcore/qevent.html">QEvent</a></span> *<i>event</i>)</h3> <p>Reimplemented from <a href="../qtcore/qeventtransition.html#eventTest">QEventTransition::eventTest</a>().</p> <!-- @@@eventTest --> <!-- $$$hitTestPath[overload1]$$$hitTestPath --> <h3 class="fn" id="hitTestPath"><a name="hitTestPath"></a><span class="type"><a href="../qtgui/qpainterpath.html">QPainterPath</a></span> QMouseEventTransition::<span class="name">hitTestPath</span>() const</h3> <p>Returns the hit test path for this mouse event transition.</p> <p><b>See also </b><a href="qmouseeventtransition.html#setHitTestPath">setHitTestPath</a>().</p> <!-- @@@hitTestPath --> <!-- $$$modifierMask --> <h3 class="fn" id="modifierMask"><a name="modifierMask"></a><span class="type"><a href="../qtcore/qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> QMouseEventTransition::<span class="name">modifierMask</span>() const</h3> <p>Returns the keyboard modifier mask that this mouse event transition checks for.</p> <p><b>Note:</b> Getter function for property <a href="qmouseeventtransition.html#modifierMask-prop">modifierMask</a>. </p><p><b>See also </b><a href="qmouseeventtransition.html#setModifierMask">setModifierMask</a>().</p> <!-- @@@modifierMask --> <!-- $$$onTransition[overload1]$$$onTransitionQEvent* --> <h3 class="fn" id="onTransition"><a name="onTransition"></a><code>[override virtual protected] </code><span class="type">void</span> QMouseEventTransition::<span class="name">onTransition</span>(<span class="type"><a href="../qtcore/qevent.html">QEvent</a></span> *<i>event</i>)</h3> <p>Reimplemented from <a href="../qtcore/qeventtransition.html#onTransition">QEventTransition::onTransition</a>().</p> <!-- @@@onTransition --> <!-- $$$setButton --> <h3 class="fn" id="setButton"><a name="setButton"></a><span class="type">void</span> QMouseEventTransition::<span class="name">setButton</span>(<span class="type"><a href="../qtcore/qt.html#MouseButton-enum">Qt::MouseButton</a></span> <i>button</i>)</h3> <p>Sets the <i>button</i> that this mouse event transition will check for.</p> <p><b>Note:</b> Setter function for property <a href="qmouseeventtransition.html#button-prop">button</a>. </p><p><b>See also </b><a href="qmouseeventtransition.html#button">button</a>().</p> <!-- @@@setButton --> <!-- $$$setHitTestPath[overload1]$$$setHitTestPathconstQPainterPath& --> <h3 class="fn" id="setHitTestPath"><a name="setHitTestPath"></a><span class="type">void</span> QMouseEventTransition::<span class="name">setHitTestPath</span>(const <span class="type"><a href="../qtgui/qpainterpath.html">QPainterPath</a></span> &<i>path</i>)</h3> <p>Sets the hit test path for this mouse event transition to <i>path</i>. If a valid path has been set, the transition will only trigger if the mouse event position (<a href="../qtgui/qmouseevent.html#pos">QMouseEvent::pos</a>()) is inside the path.</p> <p><b>See also </b><a href="qmouseeventtransition.html#hitTestPath">hitTestPath</a>() and <a href="../qtgui/qpainterpath.html#contains-2">QPainterPath::contains</a>().</p> <!-- @@@setHitTestPath --> <!-- $$$setModifierMask --> <h3 class="fn" id="setModifierMask"><a name="setModifierMask"></a><span class="type">void</span> QMouseEventTransition::<span class="name">setModifierMask</span>(<span class="type"><a href="../qtcore/qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> <i>modifierMask</i>)</h3> <p>Sets the keyboard modifier mask that this mouse event transition will check for to <i>modifierMask</i>.</p> <p><b>Note:</b> Setter function for property <a href="qmouseeventtransition.html#modifierMask-prop">modifierMask</a>. </p><p><b>See also </b><a href="qmouseeventtransition.html#modifierMask">modifierMask</a>().</p> <!-- @@@setModifierMask --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 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>