<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- finalstate.cpp -->
<title>FinalState QML Type | Qt QML 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="qtqml-index.html">Qt QML</a></td><td ><a href="qtqml-qmlmodule.html">QML Types</a></td><td >FinalState 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="#details">Detailed Description</a></li>
<li class="level2"><a href="#example-usage">Example Usage</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">FinalState QML Type</h1>
<span class="subtitle"></span>
<!-- $$$FinalState-brief -->
<p>Provides a final state. <a href="#details">More...</a></p>
<!-- @@@FinalState -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQml.StateMachine 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.4</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtqml-statemachine-qabstractstate.html">QAbstractState</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtqml-statemachine-finalstate-members.html">List of all members, including inherited members</a></li>
</ul>
<!-- $$$FinalState-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A final state is used to communicate that (part of) a <a href="qml-qtqml-statemachine-statemachine.html">StateMachine</a> has finished its work. When a final top-level state is entered, the state machine's <a href="qml-qtqml-statemachine-state.html#finished-signal">finished</a>() signal is emitted. In general, when a final substate (a child of a State) is entered, the parent state's <a href="qml-qtqml-statemachine-state.html#finished-signal">finished</a>() signal is emitted. <a href="qml-qtqml-statemachine-finalstate.html">FinalState</a> is part of <a href="qmlstatemachine.html">The Declarative State Machine Framework</a>.</p>
<p>To use a final state, you create a <a href="qml-qtqml-statemachine-finalstate.html">FinalState</a> object and add a transition to it from another state.</p>
<a name="example-usage"></a>
<h2 id="example-usage">Example Usage</h2>
<pre class="qml">
import QtQuick 2.0
import QtQml.StateMachine 1.0 as DSM
<span class="type">Rectangle</span> {
<span class="type">DSM</span>.StateMachine {
<span class="name">id</span>: <span class="name">stateMachine</span>
<span class="name">initialState</span>: <span class="name">state</span>
<span class="name">running</span>: <span class="number">true</span>
<span class="type">DSM</span>.State {
<span class="name">id</span>: <span class="name">state</span>
<span class="type">DSM</span>.TimeoutTransition {
<span class="name">targetState</span>: <span class="name">finalState</span>
<span class="name">timeout</span>: <span class="number">200</span>
}
}
<span class="type">DSM</span>.FinalState {
<span class="name">id</span>: <span class="name">finalState</span>
}
<span class="name">onFinished</span>: <span class="name">console</span>.<span class="name">log</span>(<span class="string">"state finished"</span>)
}
}
</pre>
<br style="clear: both" /><p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html">StateMachine</a> and <a href="qml-qtqml-statemachine-state.html">State</a>.</p>
<!-- @@@FinalState -->
</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>
