/usr/share/qt5/doc/qtquick/qml-qtquick-stategroup.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 | <?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.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="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmlmodule.html">QML Types</a></li>
<li>StateGroup 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="#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.5</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>
<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> 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>
|