summaryrefslogtreecommitdiffstats
path: root/examples/quick/draganddrop/doc/src/draganddrop.qdoc
blob: 754fa8f8cbf01042e24aae9f1145d48a3e0b7c40 (plain)
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
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \title Qt Quick Examples - Drag and Drop
    \example draganddrop
    \brief This is a collection of QML drag and drop examples.
    \image qml-draganddrop-example.png
    \ingroup qtquickexamples

    \e{Drag and Drop} is a collection of small QML examples relating to the drag
    and drop functionality. For more information, visit the \l{Drag and Drop}
    page.

    \include examples-run.qdocinc

    \section1 Tiles

    \e Tiles adds drag and drop to simple rectangles, which you can drag into a
    specific grid.

    It has a DragTile component which uses a MouseArea to move an item when
    dragged:

    \snippet draganddrop/tiles/DragTile.qml 0
    \snippet draganddrop/tiles/DragTile.qml 1

    And a DropTile component on which the dragged tiles can be dropped:

    \snippet draganddrop/tiles/DropTile.qml 0

    The keys property of the DropArea will only allow an item to be dropped on it if it
    has a matching key in its Drag.keys property.

    \section1 GridView Example

    The \e {GridView Example} adds drag and drop to a \l GridView, allowing you
    to visually reorder the delegates without changing the underlying
    \l ListModel. It uses a \l DelegateModel to move a delegate item to the
    position of another item it is dragged over.

    \snippet draganddrop/views/gridview.qml 0
    \snippet draganddrop/views/gridview.qml 1
*/