<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquickslider.cpp --> <title>Slider 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 >Slider 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">Slider QML Type</h1> <span class="subtitle"></span> <!-- $$$Slider-brief --> <p>A slider control. <a href="#details">More...</a></p> <!-- @@@Slider --> <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-slider-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-slider.html#from-prop">from</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#handle-prop">handle</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#orientation-prop">orientation</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#position-prop">position</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#pressed-prop">pressed</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#snapMode-prop">snapMode</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#stepSize-prop">stepSize</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#to-prop">to</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#track-prop">track</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#value-prop">value</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-slider.html#visualPosition-prop">visualPosition</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-slider.html#decrease-method">decrease</a></b></b>()</li> <li class="fn">void <b><b><a href="qml-qt-labs-controls-slider.html#increase-method">increase</a></b></b>()</li> </ul> <!-- $$$Slider-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> </p> <p class="centerAlign"><img src="images/qtlabscontrols-slider.gif" alt="" /></p><p>Slider is used to select a value by sliding a handle along a track.</p> <div class="table"><table class="generic"> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-slider-normal.png" alt="" /></p></td><td >A slider in its normal state.</td></tr> <tr valign="top" class="even"><td ><p class="centerAlign"><img src="images/qtlabscontrols-slider-focused.png" alt="" /></p></td><td >A slider that has active focus.</td></tr> <tr valign="top" class="odd"><td ><p class="centerAlign"><img src="images/qtlabscontrols-slider-disabled.png" alt="" /></p></td><td >A slider that is disabled.</td></tr> </table></div> <pre class="cpp"> Slider { value: <span class="number">0.5</span> } </pre> <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-slider">Customizing Slider</a> and <a href="qtlabscontrols-input.html">Input Controls</a>.</p> <!-- @@@Slider --> <h2>Property Documentation</h2> <!-- $$$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-slider.html#to-prop">to</a> and <a href="qml-qt-labs-controls-slider.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">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the handle item.</p> <p><b>See also </b><a href="qtlabscontrols-customize.html#customizing-slider">Customizing Slider</a>.</p> </div></div><!-- @@@handle --> <br/> <!-- $$$orientation --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="orientation-prop"> <td class="tblQmlPropNode"><p> <a name="orientation-prop"></a><span class="name">orientation</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the orientation.</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>Qt.Horizontal</code></td><td class="topAlign">Horizontal (default)</td></tr> <tr><td class="topAlign"><code>Qt.Vertical</code></td><td class="topAlign">Vertical</td></tr> </table></div> </div></div><!-- @@@orientation --> <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 size, scaled to <code>0.0 - 1.0</code>. Unlike the <a href="qml-qt-labs-controls-slider.html#value-prop">value</a> property, the <code>position</code> is continuously updated while the handle is dragged. For visualizing a slider, the right-to-left aware <a href="qml-qt-labs-controls-slider.html#visualPosition-prop">visualPosition</a> should be used instead.</p> <p><b>See also </b><a href="qml-qt-labs-controls-slider.html#value-prop">value</a> and <a href="qml-qt-labs-controls-slider.html#visualPosition-prop">visualPosition</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 slider is pressed.</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>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>Slider.NoSnap</code></td><td class="topAlign">The slider does not snap (default).</td></tr> <tr><td class="topAlign"><code>Slider.SnapAlways</code></td><td class="topAlign">The slider snaps while the handle is dragged.</td></tr> <tr><td class="topAlign"><code>Slider.SnapOnRelease</code></td><td class="topAlign">The slider 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-slider.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-slider.html#snapMode-prop">snapMode</a>, <a href="qml-qt-labs-controls-slider.html#increase-method">increase()</a>, and <a href="qml-qt-labs-controls-slider.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-slider.html#from-prop">from</a> and <a href="qml-qt-labs-controls-slider.html#value-prop">value</a>.</p> </div></div><!-- @@@to --> <br/> <!-- $$$track --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="track-prop"> <td class="tblQmlPropNode"><p> <a name="track-prop"></a><span class="name">track</span> : <span class="type">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the track item.</p> <p><b>See also </b><a href="qtlabscontrols-customize.html#customizing-slider">Customizing Slider</a>.</p> </div></div><!-- @@@track --> <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-slider.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 slider has been released.</p> <p><b>See also </b><a href="qml-qt-labs-controls-slider.html#position-prop">position</a>.</p> </div></div><!-- @@@value --> <br/> <!-- $$$visualPosition --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="visualPosition-prop"> <td class="tblQmlPropNode"><p> <a name="visualPosition-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">visualPosition</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the visual position of the handle.</p> <p>The position is defined as a percentage of the control's size, scaled to <code>0.0 - 1.0</code>. When the control is <a href="qml-qt-labs-controls-control.html#mirrored-prop">mirrored</a>, the value is equal to <code>1.0 - position</code>. This makes the value suitable for visualizing the slider, taking right-to-left support into account.</p> <p><b>See also </b><a href="qml-qt-labs-controls-slider.html#position-prop">position</a>.</p> </div></div><!-- @@@visualPosition --> <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-slider.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qt-labs-controls-slider.html#stepSize-prop">stepSize</a> is not defined.</p> <p><b>See also </b><a href="qml-qt-labs-controls-slider.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-slider.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qt-labs-controls-slider.html#stepSize-prop">stepSize</a> is not defined.</p> <p><b>See also </b><a href="qml-qt-labs-controls-slider.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>