/usr/share/qt5/doc/qtqml/qml-qtqml-statemachine-statemachine.html is in qtdeclarative5-doc-html 5.5.1-2ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- statemachine.cpp -->
<title>StateMachine QML Type | Qt QML 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtqml-index.html">Qt QML</a></li>
<li><a href="qtqml-qmlmodule.html">QML Types</a></li>
<li>StateMachine QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<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">StateMachine QML Type</h1>
<span class="subtitle"></span>
<!-- $$$StateMachine-brief -->
<p>Provides a hierarchical finite state machine. <a href="#details">More...</a></p>
<!-- @@@StateMachine -->
<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-state.html">State</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtqml-statemachine-statemachine-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-qtqml-statemachine-statemachine.html#errorString-prop">errorString</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#globalRestorePolicy-prop">globalRestorePolicy</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#running-prop">running</a></b></b> : bool</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#started-signal">started</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#stopped-signal">stopped</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#start-method">start</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtqml-statemachine-statemachine.html#stop-method">stop</a></b></b>()</li>
</ul>
<!-- $$$StateMachine-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qtqml-statemachine-statemachine.html">StateMachine</a> is based on the concepts and notation of <a href="http://www.wisdom.weizmann.ac.il/~dharel/SCANNED.PAPERS/Statecharts.pdf">Statecharts</a>. <a href="qml-qtqml-statemachine-statemachine.html">StateMachine</a> is part of <a href="qmlstatemachine.html">The Declarative State Machine Framework</a>.</p>
<p>A state machine manages a set of states and transitions between those states; these states and transitions define a state graph. Once a state graph has been built, the state machine can execute it. <a href="qml-qtqml-statemachine-statemachine.html">StateMachine</a>'s execution algorithm is based on the <a href="http://www.w3.org/TR/scxml/">State Chart XML (SCXML)</a> algorithm. The framework's <a href="qmlstatemachine.html">overview</a> gives several state graphs and the code to build them.</p>
<p>Before the machine can be started, the <a href="qml-qtqml-statemachine-state.html#initialState-prop">initialState</a> must be set. The initial state is the state that the machine enters when started. You can then set running property to true or <a href="qml-qtqml-statemachine-statemachine.html#start-method">start()</a> the state machine. The started signal is emitted when the initial state is entered.</p>
<p>The state machine processes events and takes transitions until a top-level final state is entered; the state machine then emits the finished() signal. You can also <a href="qml-qtqml-statemachine-statemachine.html#stop-method">stop()</a> the state machine explicitly (you can also set running property to false). The stopped signal is emitted in this case.</p>
<a name="example-usage"></a>
<h2 id="example-usage">Example Usage</h2>
<p>The following snippet shows a state machine that will finish when a button is clicked:</p>
<pre class="qml">import QtQuick 2.0
import QtQml.StateMachine 1.0 as DSM
<span class="type">Rectangle</span> {
<span class="type">Button</span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">id</span>: <span class="name">button</span>
<span class="name">text</span>: <span class="string">"Finish state"</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>.SignalTransition {
<span class="name">targetState</span>: <span class="name">finalState</span>
<span class="name">signal</span>: <span class="name">button</span>.<span class="name">clicked</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">Qt</span>.<span class="name">quit</span>()
}
}
}</pre>
<p>If an error is encountered, the machine will look for an <a href="qml-qtqml-statemachine-state.html#errorState-prop">errorState</a>, and if one is available, it will enter this state. After the error state is entered, the type of the error can be retrieved with error(). The execution of the state graph will not stop when the error state is entered. If no error state applies to the erroneous state, the machine will stop executing and an error message will be printed to the console.</p>
<br style="clear: both" /><p><b>See also </b><a href="qml-qtqml-statemachine-qabstractstate.html">QAbstractState</a>, <a href="qml-qtqml-statemachine-state.html">State</a>, <a href="qml-qtqml-statemachine-signaltransition.html">SignalTransition</a>, <a href="qml-qtqml-statemachine-timeouttransition.html">TimeoutTransition</a>, <a href="qml-qtqml-statemachine-historystate.html">HistoryState</a>, and <a href="qmlstatemachine.html">The Declarative State Machine Framework</a>.</p>
<!-- @@@StateMachine -->
<h2>Property Documentation</h2>
<!-- $$$errorString -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="errorString-prop"><td class="tblQmlPropNode"><p><a name="errorString-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">errorString</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>The error string of this state machine.</p>
</div></div><!-- @@@errorString -->
<br/>
<!-- $$$globalRestorePolicy -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="globalRestorePolicy-prop"><td class="tblQmlPropNode"><p><a name="globalRestorePolicy-prop"></a><span class="name">globalRestorePolicy</span> : <span class="type">enumeration</span></p></td></tr></table></div></div><div class="qmldoc"><p>The restore policy for states of this state machine.</p>
<p>The default value of this property is QState.DontRestoreProperties.</p>
<p>This enum specifies the restore policy type. The restore policy takes effect when the machine enters a state which sets one or more properties. If the restore policy is set to QState.RestoreProperties, the state machine will save the original value of the property before the new value is set.</p>
<p>Later, when the machine either enters a state which does not set a value for the given property, the property will automatically be restored to its initial value.</p>
<p>Only one initial value will be saved for any given property. If a value for a property has already been saved by the state machine, it will not be overwritten until the property has been successfully restored.</p>
<ul>
<li>QState.DontRestoreProperties The state machine should not save the initial values of properties and restore them later.</li>
<li>QState.RestoreProperties The state machine should save the initial values of properties and restore them later.</li>
</ul>
</div></div><!-- @@@globalRestorePolicy -->
<br/>
<!-- $$$running -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="running-prop"><td class="tblQmlPropNode"><p><a name="running-prop"></a><span class="name">running</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>The running state of this state machine.</p>
<p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html#start-method">start()</a> and <a href="qml-qtqml-statemachine-statemachine.html#stop-method">stop()</a>.</p>
</div></div><!-- @@@running -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$started -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="started-signal"><td class="tblQmlFuncNode"><p><a name="started-signal"></a><span class="name">started</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the state machine has entered its initial state (<a href="qml-qtqml-statemachine-state.html#initialState-prop">State::initialState</a>).</p>
<p>The corresponding handler is <code>onStarted</code>.</p>
<p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html#running-prop">running</a>, <a href="qml-qtqml-statemachine-statemachine.html#start-method">start()</a>, and <a href="qml-qtqml-statemachine-state.html#finished-signal">State::finished</a>.</p>
</div></div><!-- @@@started -->
<br/>
<!-- $$$stopped -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="stopped-signal"><td class="tblQmlFuncNode"><p><a name="stopped-signal"></a><span class="name">stopped</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>This signal is emitted when the state machine has stopped.</p>
<p>The corresponding handler is <code>onStopped</code>.</p>
<p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html#running-prop">running</a>, <a href="qml-qtqml-statemachine-statemachine.html#stop-method">stop()</a>, and <a href="qml-qtqml-statemachine-state.html#finished-signal">State::finished</a>.</p>
</div></div><!-- @@@stopped -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$start -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="start-method"><td class="tblQmlFuncNode"><p><a name="start-method"></a><span class="name">start</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Starts this state machine. The machine will reset its configuration and transition to the initial state. When a final top-level state (<a href="qml-qtqml-statemachine-finalstate.html">FinalState</a>) is entered, the machine will emit the finished() signal.</p>
<p><b>Note: </b>A state machine will not run without a running event loop, such as the main application event loop started with QCoreApplication::exec() or QApplication::exec().</p><p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html#started-signal">started</a>, <a href="qml-qtqml-statemachine-state.html#finished-signal">State::finished</a>, <a href="qml-qtqml-statemachine-statemachine.html#stop-method">stop()</a>, <a href="qml-qtqml-statemachine-state.html#initialState-prop">State::initialState</a>, and <a href="qml-qtqml-statemachine-statemachine.html#running-prop">running</a>.</p>
</div></div><!-- @@@start -->
<br/>
<!-- $$$stop -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="stop-method"><td class="tblQmlFuncNode"><p><a name="stop-method"></a><span class="name">stop</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Stops this state machine. The state machine will stop processing events and then emit the stopped signal.</p>
<p><b>See also </b><a href="qml-qtqml-statemachine-statemachine.html#stopped-signal">stopped</a>, <a href="qml-qtqml-statemachine-statemachine.html#start-method">start()</a>, and <a href="qml-qtqml-statemachine-statemachine.html#running-prop">running</a>.</p>
</div></div><!-- @@@stop -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 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>
|