/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-swipeview.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickswipeview.cpp -->
<title>SwipeView 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 >SwipeView 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="#attached-properties">Attached Properties</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">SwipeView QML Type</h1>
<span class="subtitle"></span>
<!-- $$$SwipeView-brief -->
<p>Enables the user to navigate pages by swiping sideways. <a href="#details">More...</a></p>
<!-- @@@SwipeView -->
<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-swipeview-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-swipeview.html#interactive-prop">interactive</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipeview.html#orientation-prop">orientation</a></b></b> : enumeration</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-swipeview.html#index-attached-prop">index</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipeview.html#isCurrentItem-attached-prop">isCurrentItem</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipeview.html#isNextItem-attached-prop">isNextItem</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipeview.html#isPreviousItem-attached-prop">isPreviousItem</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipeview.html#view-attached-prop">view</a></b></b> : SwipeView</li>
</ul>
<!-- $$$SwipeView-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a> provides a swipe-based navigation model.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-swipeview.gif" alt="" /></p><p><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a> is populated with a set of pages. One page is visible at a time. The user can navigate between the pages by swiping sideways. Notice that <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a> itself is entirely non-visual. It is recommended to combine it with <a href="qml-qtquick-controls2-pageindicator.html">PageIndicator</a>, to give the user a visual clue that there are multiple pages.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a></span> {
<span class="name">id</span>: <span class="name">view</span>
<span class="name">currentIndex</span>: <span class="number">1</span>
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> {
<span class="name">id</span>: <span class="name">firstPage</span>
}
<span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> {
<span class="name">id</span>: <span class="name">secondPage</span>
}
<span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span> {
<span class="name">id</span>: <span class="name">thirdPage</span>
}
}
<span class="type"><a href="qml-qtquick-controls2-pageindicator.html">PageIndicator</a></span> {
<span class="name">id</span>: <span class="name">indicator</span>
<span class="name">count</span>: <span class="name">view</span>.<span class="name">count</span>
<span class="name">currentIndex</span>: <span class="name">view</span>.<span class="name">currentIndex</span>
<span class="name">anchors</span>.bottom: <span class="name">view</span>.<span class="name">bottom</span>
<span class="name">anchors</span>.horizontalCenter: <span class="name">parent</span>.<span class="name">horizontalCenter</span>
}
</pre>
<p>As shown above, <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a> is typically populated with a static set of pages that are defined inline as children of the view. It is also possible to <a href="qml-qtquick-controls2-container.html#addItem-method">add</a>, <a href="qml-qtquick-controls2-container.html#insertItem-method">insert</a>, <a href="qml-qtquick-controls2-container.html#moveItem-method">move</a>, and <a href="qml-qtquick-controls2-container.html#removeItem-method">remove</a> pages dynamically at run time.</p>
<p>It is generally not advisable to add excessive amounts of pages to a <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>. However, when the amount of pages grows larger, or individual pages are relatively complex, it may be desired free up resources by unloading pages that are outside the reach. The following example presents how to use <a href="../qtquick/qml-qtquick-loader.html">Loader</a> to keep a maximum of three pages simultaneously instantiated.</p>
<pre class="cpp">
SwipeView {
Repeater {
model: <span class="number">6</span>
Loader {
active: SwipeView<span class="operator">.</span>isCurrentItem <span class="operator">|</span><span class="operator">|</span> SwipeView<span class="operator">.</span>isNextItem <span class="operator">|</span><span class="operator">|</span> SwipeView<span class="operator">.</span>isPreviousItem
sourceComponent: Text {
text: index
Component<span class="operator">.</span>onCompleted: console<span class="operator">.</span>log(<span class="string">"created:"</span><span class="operator">,</span> index)
Component<span class="operator">.</span>onDestruction: console<span class="operator">.</span>log(<span class="string">"destroyed:"</span><span class="operator">,</span> index)
}
}
}
}
</pre>
<p><b>Note: </b><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a> takes over the geometry management of items added to the view. Using anchors on the items is not supported, and any <code>width</code> or <code>height</code> assignment will be overridden by the view. Notice that this only applies to the root of the item. Specifying width and height, or using anchors for its children works as expected.</p><p><b>See also </b><a href="qtquickcontrols2-navigation.html#tabbar">TabBar</a>, <a href="qml-qtquick-controls2-pageindicator.html">PageIndicator</a>, <a href="qtquickcontrols2-customize.html#customizing-swipeview">Customizing SwipeView</a>, <a href="qtquickcontrols2-navigation.html">Navigation Controls</a>, and <a href="qtquickcontrols2-containers.html">Container Controls</a>.</p>
<!-- @@@SwipeView -->
<h2>Property Documentation</h2>
<!-- $$$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">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property describes whether the user can interact with the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>. The user cannot swipe a view that is not interactive.</p>
<p>The default value is <code>true</code>.</p>
<p>This QML property was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
</div></div><!-- @@@interactive -->
<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>
<p>This QML property was introduced in QtQuick.Controls 2.2 (Qt 5.9).</p>
</div></div><!-- @@@orientation -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$index -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="index-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="index-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">SwipeView.index</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the index of each child item in the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
<p>It is attached to each child item of the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
</div></div><!-- @@@index -->
<br/>
<!-- $$$isCurrentItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="isCurrentItem-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="isCurrentItem-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">SwipeView.isCurrentItem</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property is <code>true</code> if this child is the current item.</p>
<p>It is attached to each child item of the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
</div></div><!-- @@@isCurrentItem -->
<br/>
<!-- $$$isNextItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="isNextItem-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="isNextItem-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">SwipeView.isNextItem</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property is <code>true</code> if this child is the next item.</p>
<p>It is attached to each child item of the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
<p>This QML property was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
</div></div><!-- @@@isNextItem -->
<br/>
<!-- $$$isPreviousItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="isPreviousItem-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="isPreviousItem-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">SwipeView.isPreviousItem</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property is <code>true</code> if this child is the previous item.</p>
<p>It is attached to each child item of the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
<p>This QML property was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
</div></div><!-- @@@isPreviousItem -->
<br/>
<!-- $$$view -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="view-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="view-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">SwipeView.view</span> : <span class="type"><a href="qml-qtquick-controls2-swipeview.html">SwipeView</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the view that manages this child item.</p>
<p>It is attached to each child item of the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>.</p>
</div></div><!-- @@@view -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|