/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-swipedelegate.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickswipedelegate.cpp -->
<title>SwipeDelegate 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 >SwipeDelegate 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">SwipeDelegate QML Type</h1>
<span class="subtitle"></span>
<!-- $$$SwipeDelegate-brief -->
<p>A swipable item delegate. <a href="#details">More...</a></p>
<!-- @@@SwipeDelegate -->
<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-itemdelegate.html">ItemDelegate</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-swipedelegate-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-swipedelegate.html#swipe-prop">swipe</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.position-prop">swipe.position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.complete-prop">swipe.complete</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.left-prop">swipe.left</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.behind-prop">swipe.behind</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.right-prop">swipe.right</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.leftItem-prop">swipe.leftItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.behindItem-prop">swipe.behindItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-swipedelegate.html#swipe.rightItem-prop">swipe.rightItem</a></b></b> : Item</li>
</ul>
</li>
</ul>
<!-- $$$SwipeDelegate-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> presents a view item that can be swiped left or right to expose more options or information. It is used as a delegate in views such as <a href="../qtquick/qml-qtquick-listview.html">ListView</a>.</p>
<p><a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> inherits its API from <a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a>. For instance, you can set <a href="qml-qtquick-controls2-abstractbutton.html#text-prop">text</a> and react to <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicks</a> using the <a href="qml-qtquick-controls2-abstractbutton.html">AbstractButton</a> API.</p>
<p>Information regarding the progress of a swipe, as well as the components that should be shown upon swiping, are both available through the <a href="qml-qtquick-controls2-swipedelegate.html#swipe-prop">swipe</a> grouped property object. For example, <code>swipe.position</code> holds the position of the swipe within the range <code>-1.0</code> to <code>1.0</code>. The <code>swipe.left</code> property determines which item will be displayed when the control is swiped to the right, and vice versa for <code>swipe.right</code>. The positioning of these components is left to applications to decide. For example, without specifying any position for <code>swipe.left</code> or <code>swipe.right</code>, the following will occur:</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-swipedelegate.gif" alt="" /></p><p>If <code>swipe.left</code> and <code>swipe.right</code> are anchored to the left and right of the <a href="qml-qtquick-controls2-control.html#background-prop">background</a> item (respectively), they'll behave like this:</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-swipedelegate-leading-trailing.gif" alt="" /></p><p>When using <code>swipe.left</code> and <code>swipe.right</code>, the control cannot be swiped past the left and right edges. To achieve this type of "wrapping" behavior, set <code>swipe.behind</code> instead. This will result in the same item being shown regardless of which direction the control is swiped. For example, in the image below, we set <code>swipe.behind</code> and then swipe the control repeatedly in both directions:</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-swipedelegate-behind.gif" alt="" /></p><p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-swipedelegate">Customizing SwipeDelegate</a> and <a href="qtquickcontrols2-delegates.html">Delegate Controls</a>.</p>
<!-- @@@SwipeDelegate -->
<h2>Property Documentation</h2>
<!-- $$$swipe -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="swipe-prop"><th class="centerAlign"><p><a name="swipe-prop"></a><b>swipe group</b></p></th></tr><tr valign="top" class="odd" id="swipe.position-prop"><td class="tblQmlPropNode"><p><a name="swipe.position-prop"></a><span class="name">swipe.position</span> : <span class="type">real</span></p></td></tr><tr valign="top" class="odd" id="swipe.complete-prop"><td class="tblQmlPropNode"><p><a name="swipe.complete-prop"></a><span class="name">swipe.complete</span> : <span class="type">bool</span></p></td></tr><tr valign="top" class="odd" id="swipe.left-prop"><td class="tblQmlPropNode"><p><a name="swipe.left-prop"></a><span class="name">swipe.left</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr><tr valign="top" class="odd" id="swipe.behind-prop"><td class="tblQmlPropNode"><p><a name="swipe.behind-prop"></a><span class="name">swipe.behind</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr><tr valign="top" class="odd" id="swipe.right-prop"><td class="tblQmlPropNode"><p><a name="swipe.right-prop"></a><span class="name">swipe.right</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr><tr valign="top" class="odd" id="swipe.leftItem-prop"><td class="tblQmlPropNode"><p><a name="swipe.leftItem-prop"></a><span class="name">swipe.leftItem</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr><tr valign="top" class="odd" id="swipe.behindItem-prop"><td class="tblQmlPropNode"><p><a name="swipe.behindItem-prop"></a><span class="name">swipe.behindItem</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr><tr valign="top" class="odd" id="swipe.rightItem-prop"><td class="tblQmlPropNode"><p><a name="swipe.rightItem-prop"></a><span class="name">swipe.rightItem</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr></table></div></div><div class="qmldoc"><div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Property</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >position</td><td >This property holds the position of the swipe relative to either side of the control. When this value reaches either <code>-1.0</code> (left side) or <code>1.0</code> (right side) and the mouse button is released, <code>complete</code> will be <code>true</code>.</td></tr>
<tr valign="top" class="even"><td >complete</td><td >This property holds whether the control is fully exposed after having been swiped to the left or right.<p>When complete is <code>true</code>, any interactive items declared in <code>left</code>, <code>right</code>, or <code>behind</code> will receive mouse events.</p>
</td></tr>
<tr valign="top" class="odd"><td >left</td><td >This property holds the left delegate.<p>The left delegate sits behind both <a href="qml-qtquick-controls2-control.html#contentItem-prop">contentItem</a> and <a href="qml-qtquick-controls2-control.html#background-prop">background</a>. When the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> is swiped to the right, this item will be gradually revealed.</p>
<p>Both interactive and non-interactive items can be used here. Normal event handling rules apply; if an interactive control like <a href="qml-qtquick-controls2-button.html">Button</a> is used, interaction signals of <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> such as <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicked()</a> will not get emitted if the button is clicked.</p>
</td></tr>
<tr valign="top" class="even"><td >behind</td><td >This property holds the delegate that is shown when the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> is swiped to both the left and right.<p>As with the <code>left</code> and <code>right</code> delegates, it sits behind both <a href="qml-qtquick-controls2-control.html#contentItem-prop">contentItem</a> and <a href="qml-qtquick-controls2-control.html#background-prop">background</a>. However, a <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> whose <code>behind</code> has been set can be continuously swiped from either side, and will always show the same item.</p>
<p>Both interactive and non-interactive items can be used here. Normal event handling rules apply; if an interactive control like <a href="qml-qtquick-controls2-button.html">Button</a> is used, interaction signals of <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> such as <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicked()</a> will not get emitted if the button is clicked.</p>
</td></tr>
<tr valign="top" class="odd"><td >right</td><td >This property holds the right delegate.<p>The right delegate sits behind both <a href="qml-qtquick-controls2-control.html#contentItem-prop">contentItem</a> and <a href="qml-qtquick-controls2-control.html#background-prop">background</a>. When the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> is swiped to the left, this item will be gradually revealed.</p>
<p>Both interactive and non-interactive items can be used here. Normal event handling rules apply; if an interactive control like <a href="qml-qtquick-controls2-button.html">Button</a> is used, interaction signals of <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a> such as <a href="qml-qtquick-controls2-abstractbutton.html#clicked-signal">clicked()</a> will not get emitted if the button is clicked.</p>
</td></tr>
<tr valign="top" class="even"><td >leftItem</td><td >This property holds the item instantiated from the <code>left</code> component.<p>If <code>left</code> has not been set, or the position hasn't changed since creation of the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a>, this property will be <code>null</code>.</p>
</td></tr>
<tr valign="top" class="odd"><td >behindItem</td><td >This property holds the item instantiated from the <code>behind</code> component.<p>If <code>behind</code> has not been set, or the position hasn't changed since creation of the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a>, this property will be <code>null</code>.</p>
</td></tr>
<tr valign="top" class="even"><td >rightItem</td><td >This property holds the item instantiated from the <code>right</code> component.<p>If <code>right</code> has not been set, or the position hasn't changed since creation of the <a href="qml-qtquick-controls2-swipedelegate.html">SwipeDelegate</a>, this property will be <code>null</code>.</p>
</td></tr>
</table></div>
<p><b>See also </b><a href="qml-qtquick-controls2-control.html#contentItem-prop">contentItem</a> and <a href="qml-qtquick-controls2-control.html#background-prop">background</a>.</p>
</div></div><!-- @@@swipe -->
<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>
|