<?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.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></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.11.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="#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> <li class="level2"><a href="#attaching-scrollbar-to-a-flickable">Attaching ScrollBar to a Flickable</a></li> <li class="level2"><a href="#binding-the-active-state-of-horizontal-and-vertical-scroll-bars">Binding the Active State of Horizontal and Vertical Scroll Bars</a></li> <li class="level2"><a href="#non-attached-scroll-bars">Non-attached Scroll Bars</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>Vertical or horizontal interactive scroll bar. <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.4</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#horizontal-prop">horizontal</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#interactive-prop">interactive</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimumSize</a></b></b> : real</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#policy-prop">policy</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#snapMode-prop">snapMode</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#vertical-prop">vertical</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#visualPosition-prop">visualPosition</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qtquick-controls2-scrollbar.html#visualSize-prop">visualSize</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 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> <a name="attaching-scrollbar-to-a-flickable"></a> <h2 id="attaching-scrollbar-to-a-flickable">Attaching ScrollBar to a Flickable</h2> <p>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>An attached <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> re-parents itself to the target Flickable. A vertically attached <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> resizes itself to the height of the Flickable, and positions itself to either side of it based on the <a href="qml-qtquick-controls2-control.html#mirrored-prop">layout direction</a>. A horizontally attached <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> resizes itself to the width of the Flickable, and positions itself to the bottom. The automatic geometry management can be disabled by specifying another parent for the attached <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a>. This can be useful, for example, if the <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> should be placed outside a clipping Flickable. This is demonstrated by the following example:</p> <pre class="cpp"> Flickable { id: flickable clip: <span class="keyword">true</span> <span class="comment">// ...</span> ScrollBar<span class="operator">.</span>vertical: ScrollBar { parent: flickable<span class="operator">.</span>parent anchors<span class="operator">.</span>top: flickable<span class="operator">.</span>top anchors<span class="operator">.</span>left: flickable<span class="operator">.</span>right anchors<span class="operator">.</span>bottom: flickable<span class="operator">.</span>bottom } } </pre> <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> <a name="binding-the-active-state-of-horizontal-and-vertical-scroll-bars"></a> <h2 id="binding-the-active-state-of-horizontal-and-vertical-scroll-bars">Binding the Active State of Horizontal and Vertical Scroll Bars</h2> <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> <a name="non-attached-scroll-bars"></a> <h2 id="non-attached-scroll-bars">Non-attached Scroll Bars</h2> <p>It is possible to create an instance of <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a> without using the attached property API. This is useful when the behavior of the attached scoll bar is not sufficient or a <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a> is not in use. In the following example, horizontal and vertical scroll bars are used to scroll over the text without using <a href="../qtquick/qml-qtquick-flickable.html">Flickable</a>:</p> <pre class="qml"> <span class="type"><a href="../qtquick/qml-qtquick-rectangle.html">Rectangle</a></span> { <span class="name">id</span>: <span class="name">frame</span> <span class="name">clip</span>: <span class="number">true</span> <span class="name">width</span>: <span class="number">160</span> <span class="name">height</span>: <span class="number">160</span> <span class="name">border</span>.color: <span class="string">"black"</span> <span class="name">anchors</span>.centerIn: <span class="name">parent</span> <span class="type"><a href="../qtquick/qml-qtquick-text.html">Text</a></span> { <span class="name">id</span>: <span class="name">content</span> <span class="name">text</span>: <span class="string">"ABC"</span> <span class="name">font</span>.pixelSize: <span class="number">160</span> <span class="name">x</span>: -<span class="name">hbar</span>.<span class="name">position</span> <span class="operator">*</span> <span class="name">width</span> <span class="name">y</span>: -<span class="name">vbar</span>.<span class="name">position</span> <span class="operator">*</span> <span class="name">height</span> } <span class="type"><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a></span> { <span class="name">id</span>: <span class="name">vbar</span> <span class="name">hoverEnabled</span>: <span class="number">true</span> <span class="name">active</span>: <span class="name">hovered</span> <span class="operator">||</span> <span class="name">pressed</span> <span class="name">orientation</span>: <span class="name">Qt</span>.<span class="name">Vertical</span> <span class="name">size</span>: <span class="name">frame</span>.<span class="name">height</span> <span class="operator">/</span> <span class="name">content</span>.<span class="name">height</span> <span class="name">anchors</span>.top: <span class="name">parent</span>.<span class="name">top</span> <span class="name">anchors</span>.right: <span class="name">parent</span>.<span class="name">right</span> <span class="name">anchors</span>.bottom: <span class="name">parent</span>.<span class="name">bottom</span> } <span class="type"><a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a></span> { <span class="name">id</span>: <span class="name">hbar</span> <span class="name">hoverEnabled</span>: <span class="number">true</span> <span class="name">active</span>: <span class="name">hovered</span> <span class="operator">||</span> <span class="name">pressed</span> <span class="name">orientation</span>: <span class="name">Qt</span>.<span class="name">Horizontal</span> <span class="name">size</span>: <span class="name">frame</span>.<span class="name">width</span> <span class="operator">/</span> <span class="name">content</span>.<span class="name">width</span> <span class="name">anchors</span>.left: <span class="name">parent</span>.<span class="name">left</span> <span class="name">anchors</span>.right: <span class="name">parent</span>.<span class="name">right</span> <span class="name">anchors</span>.bottom: <span class="name">parent</span>.<span class="name">bottom</span> } } </pre> <p class="centerAlign"><img src="images/qtquickcontrols2-scrollbar-non-attached.png" alt="" /></p><p>When using a non-attached <a href="qml-qtquick-controls2-scrollbar.html">ScrollBar</a>, the following must be done manually:</p> <ul> <li>Layout the scroll bar (with the <a href="../qtquick/qml-qtquick-item.html#x-prop">x</a> and <a href="../qtquick/qml-qtquick-item.html#y-prop">y</a> or <a href="../qtquick/qml-qtquick-item.html">anchor</a> properties, for example).</li> <li>Set the <a href="qml-qtquick-controls2-scrollbar.html#size-prop">size</a> and <a href="qml-qtquick-controls2-scrollbar.html#position-prop">position</a> properties to determine the size and position of the scroll bar in relation to the scrolled item.</li> <li>Set the <a href="qml-qtquick-controls2-scrollbar.html#active-prop">active</a> property to determine when the scroll bar will be visible.</li> </ul> <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"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the scroll bar is active, i.e. 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> <p>It is possible to keep <a href="qml-qtquick-controls2-scrollbar.html#binding-the-active-state-of-horizontal-and-vertical-scroll-bars">both horizontal and vertical bars visible</a> while scrolling in either direction.</p> <p>This property is automatically set when the scroll bar is <a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">attached to a flickable</a>.</p> </div></div><!-- @@@active --> <br/> <!-- $$$horizontal --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="horizontal-prop"> <td class="tblQmlPropNode"><p> <a name="horizontal-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">horizontal</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the scroll bar is horizontal.</p> <p>This property was introduced in QtQuick.Controls 2.3 (Qt 5.10).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#orientation-prop">orientation</a>.</p> </div></div><!-- @@@horizontal --> <br/> <!-- $$$interactive --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="interactive-prop"> <td class="tblQmlPropNode"><p> <a name="interactive-prop"></a><span class="name">interactive</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the scroll bar is interactive. The default value is <code>true</code>.</p> <p>A non-interactive scroll bar is visually and behaviorally similar to <a href="qml-qtquick-controls2-scrollindicator.html">ScrollIndicator</a>. This property is useful for switching between typical mouse- and touch-orientated UIs with interactive and non-interactive scroll bars, respectively.</p> <p>This property was introduced in QtQuick.Controls 2.2 (Qt 5.9).</p> </div></div><!-- @@@interactive --> <br/> <!-- $$$minimumSize --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="minimumSize-prop"> <td class="tblQmlPropNode"><p> <a name="minimumSize-prop"></a><span class="name">minimumSize</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the minimum size of the scroll bar, scaled to <code>0.0 - 1.0</code>.</p> <p>This property was introduced in QtQuick.Controls 2.4 (Qt 5.11).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#size-prop">size</a>, <a href="qml-qtquick-controls2-scrollbar.html#visualSize-prop">visualSize</a>, and <a href="qml-qtquick-controls2-scrollbar.html#visualPosition-prop">visualPosition</a>.</p> </div></div><!-- @@@minimumSize --> <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"><a href="../qtqml/qml-enumeration.html">enumeration</a></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> <p>This property is automatically set when the scroll bar is <a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">attached to a flickable</a>.</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#horizontal-attached-prop">horizontal</a> and <a href="qml-qtquick-controls2-scrollbar.html#vertical-attached-prop">vertical</a>.</p> </div></div><!-- @@@orientation --> <br/> <!-- $$$policy --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="policy-prop"> <td class="tblQmlPropNode"><p> <a name="policy-prop"></a><span class="name">policy</span> : <span class="type"><a href="../qtqml/qml-enumeration.html">enumeration</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the policy of the scroll bar. The default policy is <code>ScrollBar.AsNeeded</code>.</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>ScrollBar.AsNeeded</code></td><td class="topAlign">The scroll bar is only shown when the content is too large to fit.</td></tr> <tr><td class="topAlign"><code>ScrollBar.AlwaysOff</code></td><td class="topAlign">The scroll bar is never shown.</td></tr> <tr><td class="topAlign"><code>ScrollBar.AlwaysOn</code></td><td class="topAlign">The scroll bar is always shown.</td></tr> </table></div> <p>The following example keeps the vertical scroll bar always visible:</p> <pre class="qml"> <span class="type"><a href="../qtquick/qml-qtquick-flickable.html">Flickable</a></span> { <span class="name">contentHeight</span>: <span class="number">2000</span> <span class="name">ScrollBar</span>.vertical: <span class="name">ScrollBar</span> { <span class="name">policy</span>: <span class="name">ScrollBar</span>.<span class="name">AlwaysOn</span> } } </pre> <p>This property was introduced in QtQuick.Controls 2.2 (Qt 5.9).</p> </div></div><!-- @@@policy --> <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"><a href="../qtqml/qml-real.html">real</a></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>This property is automatically set when the scroll bar is <a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">attached to a flickable</a>.</p> <p><b>See also </b><a href="../qtquick/qml-qtquick-flickable.html#visibleArea.yPosition-prop">Flickable::visibleArea</a> and <a href="qml-qtquick-controls2-scrollbar.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"><a href="../qtqml/qml-bool.html">bool</a></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"><a href="../qtqml/qml-real.html">real</a></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>This property is automatically set when the scroll bar is <a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">attached to a flickable</a>.</p> <p><b>See also </b><a href="../qtquick/qml-qtquick-flickable.html#visibleArea.heightRatio-prop">Flickable::visibleArea</a>, <a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimumSize</a>, and <a href="qml-qtquick-controls2-scrollbar.html#visualSize-prop">visualSize</a>.</p> </div></div><!-- @@@size --> <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"><a href="../qtqml/qml-enumeration.html">enumeration</a></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>ScrollBar.NoSnap</code></td><td class="topAlign">The scrollbar does not snap (default).</td></tr> <tr><td class="topAlign"><code>ScrollBar.SnapAlways</code></td><td class="topAlign">The scrollbar snaps while dragged.</td></tr> <tr><td class="topAlign"><code>ScrollBar.SnapOnRelease</code></td><td class="topAlign">The scrollbar does not snap while being dragged, but only after released.</td></tr> </table></div> <p>In the following table, the various modes are illustrated with animations. The movement and the <a href="qml-qtquick-controls2-scrollbar.html#stepSize-prop">stepSize</a> (<code>0.25</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>ScrollBar.NoSnap</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-scrollbar-nosnap.gif" alt="" /></p></td></tr> <tr valign="top" class="odd"><td ><code>ScrollBar.SnapAlways</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-scrollbar-snapalways.gif" alt="" /></p></td></tr> <tr valign="top" class="even"><td ><code>ScrollBar.SnapOnRelease</code></td><td ><p class="centerAlign"><img src="images/qtquickcontrols2-scrollbar-snaponrelease.gif" alt="" /></p></td></tr> </table></div> <p>This property was introduced in QtQuick.Controls 2.2 (Qt 5.9).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.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"><a href="../qtqml/qml-real.html">real</a></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#snapMode-prop">snapMode</a>, <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/> <!-- $$$vertical --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="vertical-prop"> <td class="tblQmlPropNode"><p> <a name="vertical-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">vertical</span> : <span class="type"><a href="../qtqml/qml-bool.html">bool</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the scroll bar is vertical.</p> <p>This property was introduced in QtQuick.Controls 2.3 (Qt 5.10).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#orientation-prop">orientation</a>.</p> </div></div><!-- @@@vertical --> <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="name">visualPosition</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the effective visual position of the scroll bar, which may be limited by the <a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimum size</a>.</p> <p>This property was introduced in QtQuick.Controls 2.4 (Qt 5.11).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#position-prop">position</a> and <a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimumSize</a>.</p> </div></div><!-- @@@visualPosition --> <br/> <!-- $$$visualSize --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="visualSize-prop"> <td class="tblQmlPropNode"><p> <a name="visualSize-prop"></a><span class="name">visualSize</span> : <span class="type"><a href="../qtqml/qml-real.html">real</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the effective visual size of the scroll bar, which may be limited by the <a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimum size</a>.</p> <p>This property was introduced in QtQuick.Controls 2.4 (Qt 5.11).</p> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#size-prop">size</a> and <a href="qml-qtquick-controls2-scrollbar.html#minimumSize-prop">minimumSize</a>.</p> </div></div><!-- @@@visualSize --> <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> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">Attaching ScrollBar to a Flickable</a>.</p> </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> <p><b>See also </b><a href="qml-qtquick-controls2-scrollbar.html#attaching-scrollbar-to-a-flickable">Attaching ScrollBar to a Flickable</a>.</p> </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">©</acronym> 2018 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>