<?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 Labs Controls 5.6</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.6</td><td ><a href="qtlabscontrols-index.html">Qt Labs Controls</a></td><td ><a href="qt-labs-controls-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.6.2 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 Qt.labs.controls 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt-labs-controls-control.html">Control</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#angle-prop">angle</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#from-prop">from</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#handle-prop">handle</a></b></b> : component</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#position-prop">position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#snapMode-prop">snapMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#stepSize-prop">stepSize</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#to-prop">to</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt-labs-controls-dial.html#value-prop">value</a></b></b> : real</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-dial.html#decrease-method">decrease</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> property. The range is set with the <a href="qml-qt-labs-controls-dial.html#from-prop">from</a> and <a href="qml-qt-labs-controls-dial.html#to-prop">to</a> properties.</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-qt-labs-controls-dial.html#value-prop">value</a> by <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> by <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> to <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> by <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> by <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> to <a href="qml-qt-labs-controls-dial.html#to-prop">to</a></td><td ><code>Qt.Key_End</code></td></tr>
</table></div>
<p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><p><b>See also </b><a href="qtlabscontrols-customize.html#customizing-dial">Customizing Dial</a> and <a href="qtlabscontrols-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-qt-labs-controls-dial.html#position-prop">position</a> property, angle is continuously updated while the handle is dragged.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#to-prop">to</a> and <a href="qml-qt-labs-controls-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">component</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="qtlabscontrols-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-qt-labs-controls-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-qt-labs-controls-dial.html#value-prop">value</a> and <a href="qml-qt-labs-controls-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 Keys attached property:</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-qt-labs-controls-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-qt-labs-controls-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. The default value is <code>0.0</code>.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-dial.html#snapMode-prop">snapMode</a>, <a href="qml-qt-labs-controls-dial.html#increase-method">increase()</a>, and <a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#from-prop">from</a> and <a href="qml-qt-labs-controls-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-qt-labs-controls-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-qt-labs-controls-dial.html#position-prop">position</a>.</p>
</div></div><!-- @@@value -->
<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-qt-labs-controls-dial.html#stepSize-prop">stepSize</a>, or <code>0.1</code> if <a href="qml-qt-labs-controls-dial.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-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-qt-labs-controls-dial.html#stepSize-prop">stepSize</a>, or <code>0.1</code> if <a href="qml-qt-labs-controls-dial.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qt-labs-controls-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>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
886c2ed147b4d6954d2d9fb23759f3ff
>
files
>
207
