<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquickstategroup.cpp --> <title>StateGroup 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 >StateGroup 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="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">StateGroup QML Type</h1> <span class="subtitle"></span> <!-- $$$StateGroup-brief --> <p>Provides built-in state support for non-Item types <a href="#details">More...</a></p> <!-- @@@StateGroup --> <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-stategroup-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-stategroup.html#state-prop">state</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtquick-stategroup.html#states-prop">states</a></b></b> : list<State></li> <li class="fn"><b><b><a href="qml-qtquick-stategroup.html#transitions-prop">transitions</a></b></b> : list<Transition></li> </ul> <!-- $$$StateGroup-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>Item (and all derived types) provides built in support for states and transitions via its <a href="qml-qtquick-item.html#state-prop">state</a>, <a href="qml-qtquick-item.html#states-prop">states</a> and <a href="qml-qtquick-item.html#transitions-prop">transitions</a> properties. <a href="qml-qtquick-stategroup.html">StateGroup</a> provides an easy way to use this support in other (non-Item-derived) types.</p> <pre class="qml"> <span class="type">MyCustomObject</span> { <span class="type"><a href="qml-qtquick-stategroup.html">StateGroup</a></span> { <span class="name">id</span>: <span class="name">myStateGroup</span> <span class="name">states</span>: <span class="name">State</span> { <span class="name">name</span>: <span class="string">"state1"</span> <span class="comment">// ...</span> } <span class="name">transitions</span>: <span class="name">Transition</span> { <span class="comment">// ...</span> } } <span class="name">onSomethingHappened</span>: <span class="name">myStateGroup</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">"state1"</span>; } </pre> <p><b>See also </b><a href="qtquick-statesanimations-states.html">Qt Quick States</a>, <a href="qtquick-statesanimations-animations.html">Transitions</a>, and Qt QML.</p> <!-- @@@StateGroup --> <h2>Property Documentation</h2> <!-- $$$state --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="state-prop"> <td class="tblQmlPropNode"><p> <a name="state-prop"></a><span class="name">state</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the name of the current state of the state group.</p> <p>This property is often used in scripts to change between states. For example:</p> <pre class="js"> <span class="keyword">function</span> <span class="name">toggle</span>() { <span class="keyword">if</span> (<span class="name">button</span>.<span class="name">state</span> <span class="operator">==</span> <span class="string">'On'</span>) <span class="name">button</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">'Off'</span>; <span class="keyword">else</span> <span class="name">button</span>.<span class="name">state</span> <span class="operator">=</span> <span class="string">'On'</span>; } </pre> <p>If the state group is in its base state (i.e. no explicit state has been set), <code>state</code> will be a blank string. Likewise, you can return a state group to its base state by setting its current state to <code>''</code>.</p> <p><b>See also </b><a href="qtquick-statesanimations-states.html">Qt Quick States</a>.</p> </div></div><!-- @@@state --> <br/> <!-- $$$states --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="states-prop"> <td class="tblQmlPropNode"><p> <a name="states-prop"></a><span class="name">states</span> : <span class="type">list</span><<span class="type"><a href="qml-qtquick-state.html">State</a></span>></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds a list of states defined by the state group.</p> <pre class="qml"> <span class="type"><a href="qml-qtquick-stategroup.html">StateGroup</a></span> { <span class="name">states</span>: [ <span class="type"><a href="qml-qtquick-state.html">State</a></span> { <span class="comment">// State definition...</span> }, <span class="type"><a href="qml-qtquick-state.html">State</a></span> { <span class="comment">// ...</span> } <span class="comment">// Other states...</span> ] } </pre> <p><b>See also </b><a href="qtquick-statesanimations-states.html">Qt Quick States</a>.</p> </div></div><!-- @@@states --> <br/> <!-- $$$transitions --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="transitions-prop"> <td class="tblQmlPropNode"><p> <a name="transitions-prop"></a><span class="name">transitions</span> : <span class="type">list</span><<span class="type"><a href="qml-qtquick-transition.html">Transition</a></span>></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds a list of transitions defined by the state group.</p> <pre class="qml"> <span class="type"><a href="qml-qtquick-stategroup.html">StateGroup</a></span> { <span class="name">transitions</span>: [ <span class="type"><a href="qml-qtquick-transition.html">Transition</a></span> { <span class="comment">// ...</span> }, <span class="type"><a href="qml-qtquick-transition.html">Transition</a></span> { <span class="comment">// ...</span> } <span class="comment">// ...</span> ] } </pre> <p><b>See also </b><a href="qtquick-statesanimations-animations.html">Transitions</a>.</p> </div></div><!-- @@@transitions --> <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>