/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-dial.html is in qtquickcontrols2-5-doc-html 5.7.1-1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickdial.cpp -->
<title>Dial QML Type | Qt Quick Controls 2 5.7</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
window.onload = function(){document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");};
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.7</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 >Dial QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.7.1 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="#methods">Methods</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">Dial QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Dial-brief -->
<p>A circular dial that is rotated to set a value. <a href="#details">More...</a></p>
<!-- @@@Dial -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-controls2-control.html">Control</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-dial-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-dial.html#angle-prop">angle</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#from-prop">from</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#handle-prop">handle</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#position-prop">position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#snapMode-prop">snapMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#to-prop">to</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#value-prop">value</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dial.html#wrap-prop">wrap</a></b></b> : bool</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-dial.html#decrease-method">decrease</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-dial.html#increase-method">increase</a></b></b>()</li>
</ul>
<!-- $$$Dial-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The Dial is similar to a traditional dial knob that is found on devices such as stereos or industrial equipment. It allows the user to specify a value within a range.</p>
<p>The value of the dial is set with the <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> property. The range is set with the <a href="qml-qtquick-controls2-dial.html#from-prop">from</a> and <a href="qml-qtquick-controls2-dial.html#to-prop">to</a> properties. To enable or disable wrapping, use the <a href="qml-qtquick-controls2-dial.html#wrap-prop">wrap</a> property.</p>
<p>The dial can be manipulated with a keyboard. It supports the following actions:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th ><b>Action</b></th><th ><b>Key</b></th></tr></thead>
<tr valign="top" class="odd"><td >Decrease <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a></td><td ><code>Qt.Key_Left</code></td></tr>
<tr valign="top" class="even"><td >Decrease <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a></td><td ><code>Qt.Key_Down</code></td></tr>
<tr valign="top" class="odd"><td >Set <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> to <a href="qml-qtquick-controls2-dial.html#from-prop">from</a></td><td ><code>Qt.Key_Home</code></td></tr>
<tr valign="top" class="even"><td >Increase <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a></td><td ><code>Qt.Key_Right</code></td></tr>
<tr valign="top" class="odd"><td >Increase <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a></td><td ><code>Qt.Key_Up</code></td></tr>
<tr valign="top" class="even"><td >Set <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> to <a href="qml-qtquick-controls2-dial.html#to-prop">to</a></td><td ><code>Qt.Key_End</code></td></tr>
</table></div>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-dial">Customizing Dial</a> and <a href="qtquickcontrols2-input.html">Input Controls</a>.</p>
<!-- @@@Dial -->
<h2>Property Documentation</h2>
<!-- $$$angle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="angle-prop">
<td class="tblQmlPropNode"><p>
<a name="angle-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">angle</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the angle of the handle.</p>
<p>Like the <a href="qml-qtquick-controls2-dial.html#position-prop">position</a> property, angle is continuously updated while the handle is dragged.</p>
<p>The range is from <code>-140</code> degrees to <code>140</code> degrees.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#position-prop">position</a>.</p>
</div></div><!-- @@@angle -->
<br/>
<!-- $$$from -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="from-prop">
<td class="tblQmlPropNode"><p>
<a name="from-prop"></a><span class="name">from</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the starting value for the range. The default value is <code>0.0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#to-prop">to</a> and <a href="qml-qtquick-controls2-dial.html#value-prop">value</a>.</p>
</div></div><!-- @@@from -->
<br/>
<!-- $$$handle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="handle-prop">
<td class="tblQmlPropNode"><p>
<a name="handle-prop"></a><span class="name">handle</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 handle of the dial.</p>
<p>The handle acts as a visual indicator of the position of the dial.</p>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-dial">Customizing Dial</a>.</p>
</div></div><!-- @@@handle -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">position</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the logical position of the handle.</p>
<p>The position is defined as a percentage of the control's angle range (the range within which the handle can be moved) scaled to <code>0.0 - 1.0</code>. Unlike the <a href="qml-qtquick-controls2-dial.html#value-prop">value</a> property, the <code>position</code> is continuously updated while the handle is dragged.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#value-prop">value</a> and <a href="qml-qtquick-controls2-dial.html#angle-prop">angle</a>.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$pressed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pressed-prop">
<td class="tblQmlPropNode"><p>
<a name="pressed-prop"></a><span class="name">pressed</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the dial is pressed.</p>
<p>The dial will be pressed when either the mouse is pressed over it, or a key such as <code>Qt.Key_Left</code> is held down. If you'd prefer not to have the dial be pressed upon key presses (due to styling reasons, for example), you can use the <a href="../qtquick/qml-qtquick-keys.html">Keys attached property</a>:</p>
<pre class="cpp">
Dial {
Keys<span class="operator">.</span>onLeftPressed: {}
}
</pre>
<p>This will result in pressed only being <code>true</code> upon mouse presses.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$snapMode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="snapMode-prop">
<td class="tblQmlPropNode"><p>
<a name="snapMode-prop"></a><span class="name">snapMode</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the snap mode.</p>
<p>The snap mode works with the <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a> to allow the handle to snap to certain points along the dial.</p>
<p>Possible values:</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>Dial.NoSnap</code></td><td class="topAlign">The dial does not snap (default).</td></tr>
<tr><td class="topAlign"><code>Dial.SnapAlways</code></td><td class="topAlign">The dial snaps while the handle is dragged.</td></tr>
<tr><td class="topAlign"><code>Dial.SnapOnRelease</code></td><td class="topAlign">The dial does not snap while being dragged, but only after the handle is released.</td></tr>
</table></div>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@snapMode -->
<br/>
<!-- $$$stepSize -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stepSize-prop">
<td class="tblQmlPropNode"><p>
<a name="stepSize-prop"></a><span class="name">stepSize</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the step size.</p>
<p>The step size determines the amount by which the dial's value is increased and decreased when interacted with via the keyboard. For example, a step size of <code>0.2</code>, will result in the dial's value increasing and decreasing in increments of <code>0.2</code>.</p>
<p>The step size is only respected for touch and mouse interaction when <a href="qml-qtquick-controls2-dial.html#snapMode-prop">snapMode</a> is set to a value other than <code>Dial.NoSnap</code>.</p>
<p>The default value is <code>0.0</code>, which results in an effective step size of <code>0.1</code> for keyboard interaction.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#snapMode-prop">snapMode</a>, <a href="qml-qtquick-controls2-dial.html#increase-method">increase()</a>, and <a href="qml-qtquick-controls2-dial.html#decrease-method">decrease()</a>.</p>
</div></div><!-- @@@stepSize -->
<br/>
<!-- $$$to -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="to-prop">
<td class="tblQmlPropNode"><p>
<a name="to-prop"></a><span class="name">to</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the end value for the range. The default value is <code>1.0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#from-prop">from</a> and <a href="qml-qtquick-controls2-dial.html#value-prop">value</a>.</p>
</div></div><!-- @@@to -->
<br/>
<!-- $$$value -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="value-prop">
<td class="tblQmlPropNode"><p>
<a name="value-prop"></a><span class="name">value</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the value in the range <code>from</code> - <code>to</code>. The default value is <code>0.0</code>.</p>
<p>Unlike the <a href="qml-qtquick-controls2-dial.html#position-prop">position</a> property, the <code>value</code> is not updated while the handle is dragged. The value is updated after the value has been chosen and the dial has been released.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#position-prop">position</a>.</p>
</div></div><!-- @@@value -->
<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 holds whether the dial wraps when dragged.</p>
<p>For example, when this property is set to <code>true</code>, dragging the dial past the <a href="qml-qtquick-controls2-dial.html#to-prop">to</a> position will result in the handle being positioned at the <a href="qml-qtquick-controls2-dial.html#from-prop">from</a> position, and vice versa:</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-dial-wrap.gif" alt="" /></p><p>When this property is <code>false</code>, it's not possible to drag the dial across the from and to values.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-dial-no-wrap.gif" alt="" /></p><p>The default value is <code>false</code>.</p>
</div></div><!-- @@@wrap -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$decrease -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="decrease-method">
<td class="tblQmlFuncNode"><p>
<a name="decrease-method"></a><span class="type">void</span> <span class="name">decrease</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Decreases the value by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a>, or <code>0.1</code> if <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@decrease -->
<br/>
<!-- $$$increase -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="increase-method">
<td class="tblQmlFuncNode"><p>
<a name="increase-method"></a><span class="type">void</span> <span class="name">increase</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Increases the value by <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a>, or <code>0.1</code> if <a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dial.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@increase -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2016 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>
|