<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- draganddrop.qdoc -->
<title>Qt Quick Examples - Drag and Drop | Qt Quick 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="qtquick-index.html">Qt Quick</a></td><td >Qt Quick Examples - Drag and Drop</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 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="#running-the-example">Running the Example</a></li>
<li class="level1"><a href="#tiles">Tiles</a></li>
<li class="level1"><a href="#gridview-example">GridView Example</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt Quick Examples - Drag and Drop</h1>
<span class="subtitle"></span>
<!-- $$$draganddrop-description -->
<div class="descr"> <a name="details"></a>
<p class="centerAlign"><img src="images/qml-draganddrop-example.png" alt="" /></p><p><i>Drag and Drop</i> is a collection of small QML examples relating to the drag and drop functionality. For more information, visit the Drag and Drop page.</p>
<a name="running-the-example"></a>
<h2 id="running-the-example">Running the Example</h2>
<p>To run the example from Qt Creator, open the <b>Welcome</b> mode and select the example from <b>Examples</b>. For more information, visit Building and Running an Example.</p>
<a name="tiles"></a>
<h2 id="tiles">Tiles</h2>
<p><i>Tiles</i> adds drag and drop to simple rectangles, which you can drag into a specific grid.</p>
<p>It has a DragTile component which uses a <a href="qml-qtquick-mousearea.html">MouseArea</a> to move an item when dragged:</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-item.html">Item</a></span> {
<span class="name">id</span>: <span class="name">root</span>
property <span class="type">string</span> <span class="name">colorKey</span>
<span class="name">width</span>: <span class="number">64</span>; <span class="name">height</span>: <span class="number">64</span>
<span class="type"><a href="qml-qtquick-mousearea.html">MouseArea</a></span> {
<span class="name">id</span>: <span class="name">mouseArea</span>
<span class="name">width</span>: <span class="number">64</span>; <span class="name">height</span>: <span class="number">64</span>
<span class="name">anchors</span>.centerIn: <span class="name">parent</span>
<span class="name">drag</span>.target: <span class="name">tile</span>
<span class="name">onReleased</span>: <span class="name">parent</span> <span class="operator">=</span> <span class="name">tile</span>.<span class="name">Drag</span>.<span class="name">target</span> <span class="operator">!==</span> <span class="number">null</span> ? <span class="name">tile</span>.<span class="name">Drag</span>.<span class="name">target</span> : <span class="name">root</span>
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">tile</span>
<span class="name">width</span>: <span class="number">64</span>; <span class="name">height</span>: <span class="number">64</span>
<span class="name">anchors</span>.verticalCenter: <span class="name">parent</span>.<span class="name">verticalCenter</span>
<span class="name">anchors</span>.horizontalCenter: <span class="name">parent</span>.<span class="name">horizontalCenter</span>
<span class="name">color</span>: <span class="name">colorKey</span>
<span class="name">Drag</span>.keys: [ <span class="name">colorKey</span> ]
<span class="name">Drag</span>.active: <span class="name">mouseArea</span>.<span class="name">drag</span>.<span class="name">active</span>
<span class="name">Drag</span>.hotSpot.x: <span class="number">32</span>
<span class="name">Drag</span>.hotSpot.y: <span class="number">32</span>
<span class="name">states</span>: <span class="name">State</span> {
<span class="name">when</span>: <span class="name">mouseArea</span>.<span class="name">drag</span>.<span class="name">active</span>
<span class="type"><a href="qml-qtquick-parentchange.html">ParentChange</a></span> { <span class="name">target</span>: <span class="name">tile</span>; <span class="name">parent</span>: <span class="name">root</span> }
<span class="type"><a href="qml-qtquick-anchorchanges.html">AnchorChanges</a></span> { <span class="name">target</span>: <span class="name">tile</span>; <span class="name">anchors</span>.verticalCenter: <span class="name">undefined</span>; <span class="name">anchors</span>.horizontalCenter: <span class="name">undefined</span> }
}
}
}
}
</pre>
<p>And a DropTile component on which the dragged tiles can be dropped:</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-droparea.html">DropArea</a></span> {
<span class="name">id</span>: <span class="name">dragTarget</span>
property <span class="type">string</span> <span class="name">colorKey</span>
property <span class="type">alias</span> <span class="name">dropProxy</span>: <span class="name">dragTarget</span>
<span class="name">width</span>: <span class="number">64</span>; <span class="name">height</span>: <span class="number">64</span>
<span class="name">keys</span>: [ <span class="name">colorKey</span> ]
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">dropRectangle</span>
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">color</span>: <span class="name">colorKey</span>
<span class="name">states</span>: [
<span class="type"><a href="qml-qtquick-state.html">State</a></span> {
<span class="name">when</span>: <span class="name">dragTarget</span>.<span class="name">containsDrag</span>
<span class="type"><a href="qml-qtquick-propertychanges.html">PropertyChanges</a></span> {
<span class="name">target</span>: <span class="name">dropRectangle</span>
<span class="name">color</span>: <span class="string">"grey"</span>
}
}
]
}
}
</pre>
<p>The keys property of the <a href="qml-qtquick-droparea.html">DropArea</a> will only allow an item to be dropped on it if it has a matching key in its Drag.keys property.</p>
<a name="gridview-example"></a>
<h2 id="gridview-example">GridView Example</h2>
<p>The <i><a href="qml-qtquick-gridview.html">GridView</a> Example</i> adds drag and drop to a <a href="qml-qtquick-gridview.html">GridView</a>, allowing you to reorder the list. It also uses a DelegateModel to move a delegate item to the position of another item it is dragged over.</p>
<pre class="qml">
<span class="name">model</span>: <span class="name">DelegateModel</span> {
<span class="name">delegate</span>: <span class="name">MouseArea</span> {
<span class="name">id</span>: <span class="name">delegateRoot</span>
property <span class="type">int</span> <span class="name">visualIndex</span>: <span class="name">DelegateModel</span>.<span class="name">itemsIndex</span>
<span class="name">width</span>: <span class="number">80</span>; <span class="name">height</span>: <span class="number">80</span>
<span class="name">drag</span>.target: <span class="name">icon</span>
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">id</span>: <span class="name">icon</span>
<span class="name">width</span>: <span class="number">72</span>; <span class="name">height</span>: <span class="number">72</span>
<span class="type">anchors</span> {
<span class="name">horizontalCenter</span>: <span class="name">parent</span>.<span class="name">horizontalCenter</span>;
<span class="name">verticalCenter</span>: <span class="name">parent</span>.<span class="name">verticalCenter</span>
}
<span class="name">color</span>: <span class="name">model</span>.<span class="name">color</span>
<span class="name">radius</span>: <span class="number">3</span>
<span class="name">Drag</span>.active: <span class="name">delegateRoot</span>.<span class="name">drag</span>.<span class="name">active</span>
<span class="name">Drag</span>.source: <span class="name">delegateRoot</span>
<span class="name">Drag</span>.hotSpot.x: <span class="number">36</span>
<span class="name">Drag</span>.hotSpot.y: <span class="number">36</span>
<span class="name">states</span>: [
<span class="type"><a href="qml-qtquick-state.html">State</a></span> {
<span class="name">when</span>: <span class="name">icon</span>.<span class="name">Drag</span>.<span class="name">active</span>
<span class="type"><a href="qml-qtquick-parentchange.html">ParentChange</a></span> {
<span class="name">target</span>: <span class="name">icon</span>
<span class="name">parent</span>: <span class="name">root</span>
}
<span class="type"><a href="qml-qtquick-anchorchanges.html">AnchorChanges</a></span> {
<span class="name">target</span>: <span class="name">icon</span>;
<span class="name">anchors</span>.horizontalCenter: <span class="name">undefined</span>;
<span class="name">anchors</span>.verticalCenter: <span class="name">undefined</span>
}
}
]
}
<span class="type"><a href="qml-qtquick-droparea.html">DropArea</a></span> {
<span class="type">anchors</span> { <span class="name">fill</span>: <span class="name">parent</span>; <span class="name">margins</span>: <span class="number">15</span> }
<span class="name">onEntered</span>: <span class="name">visualModel</span>.<span class="name">items</span>.<span class="name">move</span>(<span class="name">drag</span>.<span class="name">source</span>.<span class="name">visualIndex</span>, <span class="name">delegateRoot</span>.<span class="name">visualIndex</span>)
}
}
</pre>
<p>Files:</p>
<ul>
<li><a href="qtquick-draganddrop-draganddrop-qml.html">draganddrop/draganddrop.qml</a></li>
<li><a href="qtquick-draganddrop-tiles-dragtile-qml.html">draganddrop/tiles/DragTile.qml</a></li>
<li><a href="qtquick-draganddrop-tiles-droptile-qml.html">draganddrop/tiles/DropTile.qml</a></li>
<li><a href="qtquick-draganddrop-tiles-tiles-qml.html">draganddrop/tiles/tiles.qml</a></li>
<li><a href="qtquick-draganddrop-views-gridview-qml.html">draganddrop/views/gridview.qml</a></li>
<li><a href="qtquick-draganddrop-main-cpp.html">draganddrop/main.cpp</a></li>
<li><a href="qtquick-draganddrop-draganddrop-pro.html">draganddrop/draganddrop.pro</a></li>
<li><a href="qtquick-draganddrop-draganddrop-qmlproject.html">draganddrop/draganddrop.qmlproject</a></li>
<li><a href="qtquick-draganddrop-draganddrop-qrc.html">draganddrop/draganddrop.qrc</a></li>
</ul>
</div>
<!-- @@@draganddrop -->
</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>
