/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-tumbler.html is in qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2.
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquicktumbler.cpp -->
<title>Tumbler QML Type | Qt Quick Controls 2 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="qtquickcontrols2-index.html">Qt Quick Controls 2</a></td><td ><a href="qtquick-controls2-qmlmodule.html">QML Types</a></td><td >Tumbler QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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="#attached-properties">Attached 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">Tumbler QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Tumbler-brief -->
<p>Spinnable wheel of items that can be selected. <a href="#details">More...</a></p>
<!-- @@@Tumbler -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-tumbler-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-controls2-tumbler.html#count-prop">count</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#currentIndex-prop">currentIndex</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#currentItem-prop">currentItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#delegate-prop">delegate</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#model-prop">model</a></b></b> : variant</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#moving-prop">moving</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#visibleItemCount-prop">visibleItemCount</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#wrap-prop">wrap</a></b></b> : bool</li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#displacement-attached-prop">displacement</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-tumbler.html#tumbler-attached-prop">tumbler</a></b></b> : Tumbler</li>
</ul>
<!-- $$$Tumbler-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/qtquickcontrols2-tumbler-wrap.gif" alt="" /></p><pre class="cpp">
Tumbler {
model: <span class="number">5</span>
<span class="comment">// ...</span>
}
</pre>
<p>Tumbler allows the user to select an option from a spinnable <i>"wheel"</i> of items. It is useful for when there are too many options to use, for example, a <a href="qml-qtquick-controls2-radiobutton.html">RadioButton</a>, and too few options to require the use of an editable <a href="qml-qtquick-controls2-spinbox.html">SpinBox</a>. It is convenient in that it requires no keyboard usage and wraps around at each end when there are a large number of items.</p>
<p>The API is similar to that of views like <a href="../qtquick/qml-qtquick-listview.html">ListView</a> and <a href="../qtquick/qml-qtquick-pathview.html">PathView</a>; a <a href="qtquickcontrols2-chattutorial-example.html#model">model</a> and <a href="qtquickcontrols2-chattutorial-example.html#delegate">delegate</a> can be set, and the <a href="qml-qtquick-controls2-tumbler.html#count-prop">count</a> and <a href="qml-qtquick-controls2-tumbler.html#currentItem-prop">currentItem</a> properties provide read-only access to information about the view.</p>
<p>Unlike views like <a href="../qtquick/qml-qtquick-pathview.html">PathView</a> and <a href="../qtquick/qml-qtquick-listview.html">ListView</a>, however, there is always a current item (when the model isn't empty). This means that when <a href="qml-qtquick-controls2-tumbler.html#count-prop">count</a> is equal to <code>0</code>, <a href="qml-qtquick-controls2-tumbler.html#currentIndex-prop">currentIndex</a> will be <code>-1</code>. In all other cases, it will be greater than or equal to <code>0</code>.</p>
<p>By default, Tumbler <a href="qml-qtquick-controls2-tumbler.html#wrap-prop">wraps</a> when it reaches the top and bottom, as long as there are more items in the model than there are visible items; that is, when <a href="qml-qtquick-controls2-tumbler.html#count-prop">count</a> is greater than <a href="qml-qtquick-controls2-tumbler.html#visibleItemCount-prop">visibleItemCount</a>:</p>
<pre class="qml">
import QtQuick 2.8
import QtQuick.Window 2.2
import QtQuick.Controls 2.1
<span class="type"><a href="../qtquick/qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">width</span>: <span class="name">frame</span>.<span class="name">implicitWidth</span> <span class="operator">+</span> <span class="number">10</span>
<span class="name">height</span>: <span class="name">frame</span>.<span class="name">implicitHeight</span> <span class="operator">+</span> <span class="number">10</span>
<span class="keyword">function</span> <span class="name">formatText</span>(<span class="name">count</span>, modelData) {
var <span class="name">data</span> = <span class="name">count</span> <span class="operator">===</span> <span class="number">12</span> ? <span class="name">modelData</span> <span class="operator">+</span> <span class="number">1</span> : <span class="name">modelData</span>;
<span class="keyword">return</span> <span class="name">data</span>.<span class="name">toString</span>().<span class="name">length</span> <span class="operator"><</span> <span class="number">2</span> ? <span class="string">"0"</span> <span class="operator">+</span> <span class="name">data</span> : <span class="name">data</span>;
}
<span class="type"><a href="../qtquick/qml-qtquick-fontmetrics.html">FontMetrics</a></span> {
<span class="name">id</span>: <span class="name">fontMetrics</span>
}
<span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span> {
<span class="name">id</span>: <span class="name">delegateComponent</span>
<span class="type"><a href="qml-qtquick-controls2-label.html">Label</a></span> {
<span class="name">text</span>: <span class="name">formatText</span>(<span class="name">Tumbler</span>.<span class="name">tumbler</span>.<span class="name">count</span>, <span class="name">modelData</span>)
<span class="name">opacity</span>: <span class="number">1.0</span> <span class="operator">-</span> <span class="name">Math</span>.<span class="name">abs</span>(<span class="name">Tumbler</span>.<span class="name">displacement</span>) <span class="operator">/</span> (<span class="name">Tumbler</span>.<span class="name">tumbler</span>.<span class="name">visibleItemCount</span> <span class="operator">/</span> <span class="number">2</span>)
<span class="name">horizontalAlignment</span>: <span class="name">Text</span>.<span class="name">AlignHCenter</span>
<span class="name">verticalAlignment</span>: <span class="name">Text</span>.<span class="name">AlignVCenter</span>
<span class="name">font</span>.pixelSize: <span class="name">fontMetrics</span>.<span class="name">font</span>.<span class="name">pixelSize</span> <span class="operator">*</span> <span class="number">1.25</span>
}
}
<span class="type"><a href="qml-qtquick-controls2-frame.html">Frame</a></span> {
<span class="name">id</span>: <span class="name">frame</span>
<span class="name">padding</span>: <span class="number">0</span>
<span class="name">anchors</span>.centerIn: <span class="name">parent</span>
<span class="type"><a href="../qtquick/qml-qtquick-row.html">Row</a></span> {
<span class="name">id</span>: <span class="name">row</span>
<span class="type"><a href="qml-qtquick-controls2-tumbler.html">Tumbler</a></span> {
<span class="name">id</span>: <span class="name">hoursTumbler</span>
<span class="name">model</span>: <span class="number">12</span>
<span class="name">delegate</span>: <span class="name">delegateComponent</span>
}
<span class="type"><a href="qml-qtquick-controls2-tumbler.html">Tumbler</a></span> {
<span class="name">id</span>: <span class="name">minutesTumbler</span>
<span class="name">model</span>: <span class="number">60</span>
<span class="name">delegate</span>: <span class="name">delegateComponent</span>
}
<span class="type"><a href="qml-qtquick-controls2-tumbler.html">Tumbler</a></span> {
<span class="name">id</span>: <span class="name">amPmTumbler</span>
<span class="name">model</span>: [<span class="string">"AM"</span>, <span class="string">"PM"</span>]
<span class="name">delegate</span>: <span class="name">delegateComponent</span>
}
}
}
}
</pre>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-tumbler">Customizing Tumbler</a> and <a href="qtquickcontrols2-input.html">Input Controls</a>.</p>
<!-- @@@Tumbler -->
<h2>Property Documentation</h2>
<!-- $$$count -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="count-prop">
<td class="tblQmlPropNode"><p>
<a name="count-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">count</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the number of items in the model.</p>
</div></div><!-- @@@count -->
<br/>
<!-- $$$currentIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="currentIndex-prop">
<td class="tblQmlPropNode"><p>
<a name="currentIndex-prop"></a><span class="name">currentIndex</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the index of the current item.</p>
<p>The value of this property is <code>-1</code> when <a href="qml-qtquick-controls2-tumbler.html#count-prop">count</a> is equal to <code>0</code>. In all other cases, it will be greater than or equal to <code>0</code>.</p>
</div></div><!-- @@@currentIndex -->
<br/>
<!-- $$$currentItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="currentItem-prop">
<td class="tblQmlPropNode"><p>
<a name="currentItem-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">currentItem</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the item at the current index.</p>
</div></div><!-- @@@currentItem -->
<br/>
<!-- $$$delegate -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="delegate-prop">
<td class="tblQmlPropNode"><p>
<a name="delegate-prop"></a><span class="name">delegate</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the delegate used to display each item.</p>
</div></div><!-- @@@delegate -->
<br/>
<!-- $$$model -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="model-prop">
<td class="tblQmlPropNode"><p>
<a name="model-prop"></a><span class="name">model</span> : <span class="type"><a href="../qtqml/qml-variant.html">variant</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the model that provides data for this tumbler.</p>
</div></div><!-- @@@model -->
<br/>
<!-- $$$moving -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="moving-prop">
<td class="tblQmlPropNode"><p>
<a name="moving-prop"></a><span class="name">moving</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property describes whether the tumbler is currently moving, due to the user either dragging or flicking it.</p>
<p>This QML property was introduced in QtQuick.Controls 2.2 (Qt 5.9).</p>
</div></div><!-- @@@moving -->
<br/>
<!-- $$$visibleItemCount -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="visibleItemCount-prop">
<td class="tblQmlPropNode"><p>
<a name="visibleItemCount-prop"></a><span class="name">visibleItemCount</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the number of items visible in the tumbler. It must be an odd number, as the current item is always vertically centered.</p>
</div></div><!-- @@@visibleItemCount -->
<br/>
<!-- $$$wrap -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="wrap-prop">
<td class="tblQmlPropNode"><p>
<a name="wrap-prop"></a><span class="name">wrap</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property determines whether or not the tumbler wraps around when it reaches the top or bottom.</p>
<p>The default value is <code>false</code> when <a href="qml-qtquick-controls2-tumbler.html#count-prop">count</a> is less than <a href="qml-qtquick-controls2-tumbler.html#visibleItemCount-prop">visibleItemCount</a>, as it is simpler to interact with a non-wrapping Tumbler when there are only a few items. To override this behavior, explicitly set the value of this property. To return to the default behavior, set this property to <code>undefined</code>.</p>
<p>This QML property was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
</div></div><!-- @@@wrap -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$displacement -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="displacement-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="displacement-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Tumbler.displacement</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds a value from <code>-visibleItemCount / 2</code> to <code>visibleItemCount / 2</code>, which represents how far away this item is from being the current item, with <code>0</code> being completely current.</p>
<p>For example, the item below will be 40% opaque when it is not the current item, and transition to 100% opacity when it becomes the current item:</p>
<pre class="cpp">
delegate: Text {
text: modelData
opacity: <span class="number">0.4</span> <span class="operator">+</span> Math<span class="operator">.</span>max(<span class="number">0</span><span class="operator">,</span> <span class="number">1</span> <span class="operator">-</span> Math<span class="operator">.</span>abs(Tumbler<span class="operator">.</span>displacement)) <span class="operator">*</span> <span class="number">0.6</span>
}
</pre>
</div></div><!-- @@@displacement -->
<br/>
<!-- $$$tumbler -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="tumbler-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="tumbler-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Tumbler.tumbler</span> : <span class="type"><a href="qml-qtquick-controls2-tumbler.html">Tumbler</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the tumbler. The property can be attached to a tumbler delegate. The value is <code>null</code> if the item is not a tumbler delegate.</p>
</div></div><!-- @@@tumbler -->
<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>
|