Sophie

Sophie

distrib > Mageia > 6 > armv5tl > media > core-updates > by-pkgid > 768f7d9f703884aa2562bf0a651086df > files > 367

qtbase5-doc-5.9.4-1.1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qeventtransition.cpp -->
  <title>QEventTransition Class | Qt Core 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="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QEventTransition</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="#public-functions">Public Functions</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>
<li class="level2"><a href="#subclassing">Subclassing</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QEventTransition Class</h1>
<!-- $$$QEventTransition-brief -->
<p>The <a href="qeventtransition.html">QEventTransition</a> class provides a <a href="qobject.html">QObject</a>-specific transition for Qt events. <a href="#details">More...</a></p>
<!-- @@@QEventTransition -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QEventTransition&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</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="qabstracttransition.html">QAbstractTransition</a></td></tr></table></div><ul>
<li><a href="qeventtransition-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><a href="qeventtransition.html#eventSource-prop">eventSource</a></b> : QObject *</li>
<li class="fn"><b><a href="qeventtransition.html#eventType-prop">eventType</a></b> : QEvent::Type</li>
</ul>
<ul>
<li class="fn">4 properties inherited from <a href="qabstracttransition.html#properties">QAbstractTransition</a></li>
<li class="fn">1 property inherited from <a href="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="qeventtransition.html#QEventTransition">QEventTransition</a></b>(QState *<i>sourceState</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#QEventTransition-1">QEventTransition</a></b>(QObject *<i>object</i>, QEvent::Type <i>type</i>, QState *<i>sourceState</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#dtor.QEventTransition">~QEventTransition</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject *</td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#eventSource">eventSource</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QEvent::Type </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#eventType">eventType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#setEventSource">setEventSource</a></b>(QObject *<i>object</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#setEventType">setEventType</a></b>(QEvent::Type <i>type</i>)</td></tr>
</table></div>
<ul>
<li class="fn">11 public functions inherited from <a href="qabstracttransition.html#public-functions">QAbstractTransition</a></li>
<li class="fn">32 public functions inherited from <a href="qobject.html#public-functions">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="qeventtransition.html#event">event</a></b>(QEvent *<i>e</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#eventTest">eventTest</a></b>(QEvent *<i>event</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qeventtransition.html#onTransition">onTransition</a></b>(QEvent *<i>event</i>)</td></tr>
</table></div>
<ul>
<li class="fn">3 protected functions inherited from <a href="qabstracttransition.html#protected-functions">QAbstractTransition</a></li>
<li class="fn">9 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">3 signals inherited from <a href="qabstracttransition.html#signals">QAbstractTransition</a></li>
<li class="fn">2 signals inherited from <a href="qobject.html#signals">QObject</a></li>
<li class="fn">11 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">3 protected functions inherited from <a href="qabstracttransition.html#protected-functions">QAbstractTransition</a></li>
<li class="fn">9 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QEventTransition-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qeventtransition.html">QEventTransition</a> class provides a <a href="qobject.html">QObject</a>-specific transition for Qt events.</p>
<p>A <a href="qeventtransition.html">QEventTransition</a> object binds an event to a particular <a href="qobject.html">QObject</a>. <a href="qeventtransition.html">QEventTransition</a> is part of <a href="statemachine-api.html">The State Machine Framework</a>.</p>
<p>Example:</p>
<pre class="cpp">

  <span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span> <span class="operator">*</span>button <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>;
  <span class="type"><a href="qstate.html">QState</a></span> <span class="operator">*</span>s1 <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>;
  <span class="type"><a href="qstate.html">QState</a></span> <span class="operator">*</span>s2 <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>;
  <span class="comment">// If in s1 and the button receives an Enter event, transition to s2</span>
  <span class="type"><a href="qeventtransition.html#QEventTransition">QEventTransition</a></span> <span class="operator">*</span>enterTransition <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qeventtransition.html#QEventTransition">QEventTransition</a></span>(button<span class="operator">,</span> <span class="type"><a href="qevent.html">QEvent</a></span><span class="operator">::</span>Enter);
  enterTransition<span class="operator">-</span><span class="operator">&gt;</span>setTargetState(s2);
  s1<span class="operator">-</span><span class="operator">&gt;</span>addTransition(enterTransition);
  <span class="comment">// If in s2 and the button receives an Exit event, transition back to s1</span>
  <span class="type"><a href="qeventtransition.html#QEventTransition">QEventTransition</a></span> <span class="operator">*</span>leaveTransition <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qeventtransition.html#QEventTransition">QEventTransition</a></span>(button<span class="operator">,</span> <span class="type"><a href="qevent.html">QEvent</a></span><span class="operator">::</span>Leave);
  leaveTransition<span class="operator">-</span><span class="operator">&gt;</span>setTargetState(s1);
  s2<span class="operator">-</span><span class="operator">&gt;</span>addTransition(leaveTransition);

</pre>
<a name="subclassing"></a>
<h3 >Subclassing</h3>
<p>When reimplementing the <a href="qeventtransition.html#eventTest">eventTest</a>() function, you should first call the base implementation to verify that the event is a <a href="qstatemachine-wrappedevent.html">QStateMachine::WrappedEvent</a> for the proper object and event type. You may then cast the event to a <a href="qstatemachine-wrappedevent.html">QStateMachine::WrappedEvent</a> and get the original event by calling <a href="qstatemachine-wrappedevent.html#event">QStateMachine::WrappedEvent::event</a>(), and perform additional checks on that object.</p>
</div>
<p><b>See also </b><a href="qstate.html#addTransition">QState::addTransition</a>().</p>
<!-- @@@QEventTransition -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$eventSource-prop$$$eventSource$$$setEventSourceQObject* -->
<h3 class="fn" id="eventSource-prop"><a name="eventSource-prop"></a><span class="name">eventSource</span> : <span class="type"><a href="qobject.html#QObject">QObject</a></span> *</h3>
<p>This property holds the event source that this event transition is associated with</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QObject *</td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qeventtransition.html#eventSource">eventSource</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qeventtransition.html#setEventSource">setEventSource</a></b></span>(QObject *<i>object</i>)</td></tr>
</table></div>
<!-- @@@eventSource -->
<!-- $$$eventType-prop$$$eventType$$$setEventTypeQEvent::Type -->
<h3 class="fn" id="eventType-prop"><a name="eventType-prop"></a><span class="name">eventType</span> : <span class="type"><a href="qevent.html#Type-enum">QEvent::Type</a></span></h3>
<p>This property holds the type of event that this event transition is associated with</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QEvent::Type </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qeventtransition.html#eventType">eventType</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qeventtransition.html#setEventType">setEventType</a></b></span>(QEvent::Type <i>type</i>)</td></tr>
</table></div>
<!-- @@@eventType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QEventTransition[overload1]$$$QEventTransitionQState* -->
<h3 class="fn" id="QEventTransition"><a name="QEventTransition"></a>QEventTransition::<span class="name">QEventTransition</span>(<span class="type"><a href="qstate.html">QState</a></span> *<i>sourceState</i> = Q_NULLPTR)</h3>
<p>Constructs a new <a href="qeventtransition.html">QEventTransition</a> object with the given <i>sourceState</i>.</p>
<!-- @@@QEventTransition -->
<!-- $$$QEventTransition$$$QEventTransitionQObject*QEvent::TypeQState* -->
<h3 class="fn" id="QEventTransition-1"><a name="QEventTransition-1"></a>QEventTransition::<span class="name">QEventTransition</span>(<span class="type"><a href="qobject.html#QObject">QObject</a></span> *<i>object</i>, <span class="type"><a href="qevent.html#Type-enum">QEvent::Type</a></span> <i>type</i>, <span class="type"><a href="qstate.html">QState</a></span> *<i>sourceState</i> = Q_NULLPTR)</h3>
<p>Constructs a new <a href="qeventtransition.html">QEventTransition</a> object associated with events of the given <i>type</i> for the given <i>object</i>, and with the given <i>sourceState</i>.</p>
<!-- @@@QEventTransition -->
<!-- $$$~QEventTransition[overload1]$$$~QEventTransition -->
<h3 class="fn" id="dtor.QEventTransition"><a name="dtor.QEventTransition"></a>QEventTransition::<span class="name">~QEventTransition</span>()</h3>
<p>Destroys this <a href="qobject.html">QObject</a> event transition.</p>
<!-- @@@~QEventTransition -->
<!-- $$$event[overload1]$$$eventQEvent* -->
<h3 class="fn" id="event"><a name="event"></a><code>[virtual protected] </code><span class="type">bool</span> QEventTransition::<span class="name">event</span>(<span class="type"><a href="qevent.html">QEvent</a></span> *<i>e</i>)</h3>
<p>Reimplemented from <a href="qobject.html#event">QObject::event</a>().</p>
<!-- @@@event -->
<!-- $$$eventSource -->
<h3 class="fn" id="eventSource"><a name="eventSource"></a><span class="type"><a href="qobject.html#QObject">QObject</a></span> *QEventTransition::<span class="name">eventSource</span>() const</h3>
<p>Returns the event source associated with this event transition.</p>
<p><b>Note:</b> Getter function for property <a href="qeventtransition.html#eventSource-prop">eventSource</a>. </p><p><b>See also </b><a href="qeventtransition.html#setEventSource">setEventSource</a>().</p>
<!-- @@@eventSource -->
<!-- $$$eventTest[overload1]$$$eventTestQEvent* -->
<h3 class="fn" id="eventTest"><a name="eventTest"></a><code>[virtual protected] </code><span class="type">bool</span> QEventTransition::<span class="name">eventTest</span>(<span class="type"><a href="qevent.html">QEvent</a></span> *<i>event</i>)</h3>
<p>Reimplemented from <a href="qabstracttransition.html#eventTest">QAbstractTransition::eventTest</a>().</p>
<!-- @@@eventTest -->
<!-- $$$eventType -->
<h3 class="fn" id="eventType"><a name="eventType"></a><span class="type"><a href="qevent.html#Type-enum">QEvent::Type</a></span> QEventTransition::<span class="name">eventType</span>() const</h3>
<p>Returns the event type that this event transition is associated with.</p>
<p><b>Note:</b> Getter function for property <a href="qeventtransition.html#eventType-prop">eventType</a>. </p><p><b>See also </b><a href="qeventtransition.html#setEventType">setEventType</a>().</p>
<!-- @@@eventType -->
<!-- $$$onTransition[overload1]$$$onTransitionQEvent* -->
<h3 class="fn" id="onTransition"><a name="onTransition"></a><code>[virtual protected] </code><span class="type">void</span> QEventTransition::<span class="name">onTransition</span>(<span class="type"><a href="qevent.html">QEvent</a></span> *<i>event</i>)</h3>
<p>Reimplemented from <a href="qabstracttransition.html#onTransition">QAbstractTransition::onTransition</a>().</p>
<!-- @@@onTransition -->
<!-- $$$setEventSource -->
<h3 class="fn" id="setEventSource"><a name="setEventSource"></a><span class="type">void</span> QEventTransition::<span class="name">setEventSource</span>(<span class="type"><a href="qobject.html#QObject">QObject</a></span> *<i>object</i>)</h3>
<p>Sets the event source associated with this event transition to be the given <i>object</i>.</p>
<p><b>Note:</b> Setter function for property <a href="qeventtransition.html#eventSource-prop">eventSource</a>. </p><p><b>See also </b><a href="qeventtransition.html#eventSource">eventSource</a>().</p>
<!-- @@@setEventSource -->
<!-- $$$setEventType -->
<h3 class="fn" id="setEventType"><a name="setEventType"></a><span class="type">void</span> QEventTransition::<span class="name">setEventType</span>(<span class="type"><a href="qevent.html#Type-enum">QEvent::Type</a></span> <i>type</i>)</h3>
<p>Sets the event <i>type</i> that this event transition is associated with.</p>
<p><b>Note:</b> Setter function for property <a href="qeventtransition.html#eventType-prop">eventType</a>. </p><p><b>See also </b><a href="qeventtransition.html#eventType">eventType</a>().</p>
<!-- @@@setEventType -->
</div>
        </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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional