qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2 / usr / share / qt5 / doc / qtquickcontrols2 / qml-qtquick-controls2-slider.html

This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-slider.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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?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 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 >Slider 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="#signals">Signals</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>Used to select a value by sliding a handle along a track. <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 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-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-qtquick-controls2-slider.html#from-prop">from</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#handle-prop">handle</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#live-prop">live</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#orientation-prop">orientation</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#position-prop">position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#snapMode-prop">snapMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#stepSize-prop">stepSize</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#to-prop">to</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#value-prop">value</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a></b></b> : real</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-slider.html#moved-signal">moved</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-slider.html#decrease-method">decrease</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-slider.html#increase-method">increase</a></b></b>()</li>
<li class="fn">real <b><b><a href="qml-qtquick-controls2-slider.html#valueAt-method">valueAt</a></b></b>(real <i>position</i>)</li>
</ul>
<!-- $$$Slider-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p class="centerAlign"><img src="images/qtquickcontrols2-slider.gif" alt="" /></p><p>Slider is used to select a value by sliding a handle along a track.</p>
<p>In the example below, custom <a href="qml-qtquick-controls2-slider.html#from-prop">from</a>, <a href="qml-qtquick-controls2-slider.html#value-prop">value</a>, and <a href="qml-qtquick-controls2-slider.html#to-prop">to</a> values are set:</p>
<pre class="cpp">

  Slider {
      from: <span class="number">1</span>
      value: <span class="number">25</span>
      to: <span class="number">100</span>
  }

</pre>
<p>The <a href="qml-qtquick-controls2-slider.html#position-prop">position</a> property is expressed as a fraction of the control's size, in the range <code>0.0 - 1.0</code>. The <a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a> property is the same, except that it is reversed in a <a href="../qtquick/qtquick-positioning-righttoleft.html">right-to-left</a> application. The <a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a> is useful for positioning the handle when styling Slider. In the example above, <a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a> will be <code>0.24</code> in a left-to-right application, and <code>0.76</code> in a right-to-left application.</p>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-slider">Customizing Slider</a> and <a href="qtquickcontrols2-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-qtquick-controls2-slider.html#to-prop">to</a> and <a href="qml-qtquick-controls2-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"><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 item.</p>
<p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-slider">Customizing Slider</a>.</p>
</div></div><!-- @@@handle -->
<br/>
<!-- $$$live -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="live-prop">
<td class="tblQmlPropNode"><p>
<a name="live-prop"></a><span class="name">live</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the slider provides live updates for the <a href="qml-qtquick-controls2-slider.html#value-prop">value</a> property while the handle is dragged.</p>
<p>The default value is <code>true</code>.</p>
<p>This QML property was introduced in  QtQuick.Controls 2.2 (Qt 5.9).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-slider.html#value-prop">value</a> and <a href="qml-qtquick-controls2-slider.html#valueAt-method">valueAt()</a>.</p>
</div></div><!-- @@@live -->
<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 expressed as a fraction of the control's size, in the range <code>0.0 - 1.0</code>. For visualizing a slider, the right-to-left aware <a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a> should be used instead.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-slider.html#value-prop">value</a>, <a href="qml-qtquick-controls2-slider.html#visualPosition-prop">visualPosition</a>, and <a href="qml-qtquick-controls2-slider.html#valueAt-method">valueAt()</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>In the following table, the various modes are illustrated with animations. The movement of the mouse cursor and the <a href="qml-qtquick-controls2-slider.html#stepSize-prop">stepSize</a> (<code>0.2</code>) are identical in each animation.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"></tr></thead>
<tr valign="top" class="odd"><td ><b>Value</b></td><td ><b>Example</b></td></tr>
<tr valign="top" class="even"><td ><code>Slider.NoSnap</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-slider-nosnap.gif" alt="" /></p></td></tr>
<tr valign="top" class="odd"><td ><code>Slider.SnapAlways</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-slider-snapalways.gif" alt="" /></p></td></tr>
<tr valign="top" class="even"><td ><code>Slider.SnapOnRelease</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-slider-snaponrelease.gif" alt="" /></p></td></tr>
</table></div>
<p><b>See also </b><a href="qml-qtquick-controls2-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-qtquick-controls2-slider.html#snapMode-prop">snapMode</a>, <a href="qml-qtquick-controls2-slider.html#increase-method">increase()</a>, and <a href="qml-qtquick-controls2-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-qtquick-controls2-slider.html#from-prop">from</a> and <a href="qml-qtquick-controls2-slider.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><b>See also </b><a href="qml-qtquick-controls2-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 expressed as a fraction of the control's size, in the range <code>0.0 - 1.0</code>. When the control is <a href="qml-qtquick-controls2-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-qtquick-controls2-slider.html#position-prop">position</a>.</p>
</div></div><!-- @@@visualPosition -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$moved -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="moved-signal">
<td class="tblQmlFuncNode"><p>
<a name="moved-signal"></a><span class="type">void</span> <span class="name">moved</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the slider has been interactively moved by the user by either touch, mouse, wheel, or keys.</p>
<p>This QML signal was introduced in  QtQuick.Controls 2.2 (Qt 5.9).</p>
</div></div><!-- @@@moved -->
<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-slider.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qtquick-controls2-slider.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-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-qtquick-controls2-slider.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qtquick-controls2-slider.html#stepSize-prop">stepSize</a> is not defined.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-slider.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@increase -->
<br/>
<!-- $$$valueAt -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="valueAt-method">
<td class="tblQmlFuncNode"><p>
<a name="valueAt-method"></a><span class="type">real</span> <span class="name">valueAt</span>(<span class="type">real</span> <i>position</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the value for the given <i>position</i>.</p>
<p>This QML method was introduced in  QtQuick.Controls 2.1 (Qt 5.8).</p>
<p><b>See also </b><a href="qml-qtquick-controls2-slider.html#value-prop">value</a> and <a href="qml-qtquick-controls2-slider.html#position-prop">position</a>.</p>
</div></div><!-- @@@valueAt -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

APT Browse - Built by Thomas Orozco.