qtquickcontrols2-5-doc-html 5.7.1-1 / usr / share / qt5 / doc / qtquickcontrols2 / qml-qtquick-controls2-scrollbar.html

This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-scrollbar.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
258
259
260
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickscrollbar.cpp -->
  <title>ScrollBar 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 >ScrollBar 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="#attached-properties">Attached 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">ScrollBar QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ScrollBar-brief -->
<p>An interactive scroll bar control. <a href="#details">More...</a></p>
<!-- @@@ScrollBar -->
<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-scrollbar-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-scrollbar.html#active-prop">active</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#orientation-prop">orientation</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#position-prop">position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#pressed-prop">pressed</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#size-prop">size</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a></b></b> : real</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-scrollbar.html#horizontal-attached-prop">horizontal</a></b></b> : ScrollBar</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#vertical-attached-prop">vertical</a></b></b> : ScrollBar</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-scrollbar.html#decrease-method">decrease</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-scrollbar.html#increase-method">increase</a></b></b>()</li>
</ul>
<!-- $$$ScrollBar-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-scrollbar.gif" alt="" /></p><p><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> is an interactive bar that can be used to scroll to a specific position. A scroll bar can be either <a href="qml-qtquick-controls2-scrollbar.html#vertical-attached-prop">vertical</a> or <a href="qml-qtquick-controls2-scrollbar.html#horizontal-attached-prop">horizontal</a>, and can be attached to any <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a>, such as <a href="../qtquick/qml-qtquick-listview.html">ListView</a> and <a href="../qtquick/qml-qtquick-gridview.html">GridView</a>.</p>
<pre class="cpp">

  Flickable {
      <span class="comment">// ...</span>
      ScrollBar<span class="operator">.</span>vertical: ScrollBar { }
  }

</pre>
<p><b>Note: </b>When <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> is attached <a href="qml-qtquick-controls2-scrollbar.html#vertical-attached-prop">vertically</a> or <a href="qml-qtquick-controls2-scrollbar.html#horizontal-attached-prop">horizontally</a> to a Flickable, its geometry and the following properties are automatically set and updated as appropriate:</p><ul>
<li><a href="qml-qtquick-controls2-scrollbar.html#orientation-prop">orientation</a></li>
<li><a href="qml-qtquick-controls2-scrollbar.html#position-prop">position</a></li>
<li><a href="qml-qtquick-controls2-scrollbar.html#size-prop">size</a></li>
<li><a href="qml-qtquick-controls2-scrollbar.html#active-prop">active</a></li>
</ul>
<p>Notice that <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> does not filter key events of the Flickable it is attached to. The following example illustrates how to implement scrolling with up and down keys:</p>
<pre class="cpp">

  Flickable {
      focus: <span class="keyword">true</span>

      Keys<span class="operator">.</span>onUpPressed: scrollBar<span class="operator">.</span>decrease()
      Keys<span class="operator">.</span>onDownPressed: scrollBar<span class="operator">.</span>increase()

      ScrollBar<span class="operator">.</span>vertical: ScrollBar { id: scrollBar }
  }

</pre>
<p>Horizontal and vertical scroll bars do not share the <a href="qml-qtquick-controls2-scrollbar.html#active-prop">active</a> state with each other by default. In order to keep both bars visible whilst scrolling to either direction, establish a two-way binding between the active states as presented by the following example:</p>
<pre class="qml">

  <span class="type"><a href="../qtquick/qml-qtquick-flickable.html">Flickable</a></span> {
      <span class="name">anchors</span>.fill: <span class="name">parent</span>

      <span class="name">contentWidth</span>: <span class="name">parent</span>.<span class="name">width</span> <span class="operator">*</span> <span class="number">2</span>
      <span class="name">contentHeight</span>: <span class="name">parent</span>.<span class="name">height</span> <span class="operator">*</span> <span class="number">2</span>

      <span class="name">ScrollBar</span>.horizontal: <span class="name">ScrollBar</span> { <span class="name">id</span>: <span class="name">hbar</span>; <span class="name">active</span>: <span class="name">vbar</span>.<span class="name">active</span> }
      <span class="name">ScrollBar</span>.vertical: <span class="name">ScrollBar</span> { <span class="name">id</span>: <span class="name">vbar</span>; <span class="name">active</span>: <span class="name">hbar</span>.<span class="name">active</span> }
  }

</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-scrollindicator.html">ScrollIndicator</a>, <a href="qtquickcontrols2-customize.html#customizing-scrollbar">Customizing ScrollBar</a>, and <a href="qtquickcontrols2-indicators.html">Indicator Controls</a>.</p>
<!-- @@@ScrollBar -->
<h2>Property Documentation</h2>
<!-- $$$active -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="active-prop">
<td class="tblQmlPropNode"><p>
<a name="active-prop"></a><span class="name">active</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the scroll bar is active, i.e&#x2e; when it's <a href="qml-qtquick-controls2-scrollbar.html#pressed-prop">pressed</a> or the attached Flickable is <a href="../qtquick/qml-qtquick-flickable.html#moving-prop">moving</a>.</p>
</div></div><!-- @@@active -->
<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 of the scroll bar.</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</td></tr>
<tr><td class="topAlign"><code>Qt.Vertical</code></td><td class="topAlign">Vertical (default)</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="name">position</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the position of the scroll bar, scaled to <code>0.0 - 1.0</code>.</p>
<p><b>See also </b><a href="../qtquick/qml-qtquick-flickable.html#visibleArea.yPosition-prop">Flickable::visibleArea</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 scroll bar is pressed.</p>
</div></div><!-- @@@pressed -->
<br/>
<!-- $$$size -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="size-prop">
<td class="tblQmlPropNode"><p>
<a name="size-prop"></a><span class="name">size</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the size of the scroll bar, scaled to <code>0.0 - 1.0</code>.</p>
<p><b>See also </b><a href="../qtquick/qml-qtquick-flickable.html#visibleArea.heightRatio-prop">Flickable::visibleArea</a>.</p>
</div></div><!-- @@@size -->
<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-scrollbar.html#increase-method">increase()</a> and <a href="qml-qtquick-controls2-scrollbar.html#decrease-method">decrease()</a>.</p>
</div></div><!-- @@@stepSize -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$horizontal -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="horizontal-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="horizontal-attached-prop"></a><span class="name">ScrollBar.horizontal</span> : <span class="type"><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property attaches a horizontal scroll bar to a <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a>.</p>
<pre class="cpp">

  Flickable {
      contentWidth: <span class="number">2000</span>
      ScrollBar<span class="operator">.</span>horizontal: ScrollBar { }
  }

</pre>
</div></div><!-- @@@horizontal -->
<br/>
<!-- $$$vertical -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="vertical-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="vertical-attached-prop"></a><span class="name">ScrollBar.vertical</span> : <span class="type"><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property attaches a vertical scroll bar to a <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a>.</p>
<pre class="cpp">

  Flickable {
      contentHeight: <span class="number">2000</span>
      ScrollBar<span class="operator">.</span>vertical: ScrollBar { }
  }

</pre>
</div></div><!-- @@@vertical -->
<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 position by <a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a> is <code>0.0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.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 position by <a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a> or <code>0.1</code> if <a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a> is <code>0.0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a>.</p>
</div></div><!-- @@@increase -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

APT Browse - Built by Thomas Orozco.