aboutsummaryrefslogtreecommitdiffstats
path: root/examples/quick/views/doc/src/views.qdoc
blob: 16237a68e0f428d0a5448ad509bbdf049d5a7772 (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
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
/****************************************************************************
**
** 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 - Views
    \example views
    \brief This is a collection of QML model-view examples.
    \image qml-modelviews-example.png
    \ingroup qtquickexamples

    \e Views is a collection of small QML examples relating to model and view
    functionality. They demonstrate how to show data from a model using the
    Qt Quick view types. For more information, visit the
    \l{Models and Views in Qt Quick} page.

    \include examples-run.qdocinc

    \section1 GridView and PathView

    \e GridView and \e PathView demonstrate usage of these types to display
    views.
    \snippet views/gridview/gridview-example.qml 0

    \section1 Dynamic List

    \e{Dynamic List} demonstrates animation of runtime additions and removals to
    a \l ListView.

    The ListView.onAdd signal handler runs an animation when new items are added
    to the view, and the ListView.onRemove another when they are removed.
    \snippet views/listview/dynamiclist.qml 0
    \snippet views/listview/dynamiclist.qml 1

    \section2 Expanding Delegates

    \e{Expanding Delegates} demonstrates delegates that expand when activated.

    It has a complex delegate the size and appearance of which can change,
    displacing other items in the view.
    \snippet views/listview/expandingdelegates.qml 0
    \snippet views/listview/expandingdelegates.qml 1
    \snippet views/listview/expandingdelegates.qml 2
    \snippet views/listview/expandingdelegates.qml 3

    \section1 Highlight

    \e Highlight demonstrates adding a custom highlight to a ListView.
    \snippet views/listview/highlight.qml 0

    \section1 Highlight Ranges

    \e{Highlight Ranges} shows the three different highlight range modes of
    ListView.
    \snippet views/listview/highlightranges.qml 0
    \snippet views/listview/highlightranges.qml 1
    \snippet views/listview/highlightranges.qml 2

    \section1 Sections

    \e Sections demonstrates the various section headers and footers available
    to \l ListView.
    \snippet views/listview/sections.qml 0

    \section1 Packages

    \e Packages use the \l [QML]{Package} type to transition delegates between
    two views.

    It has a Package object which defines delegate items for each view and an
    item that can be transferred between delegates.

    \snippet views/package/Delegate.qml 0

    A \l DelegateModel allows the individual views to access their specific
    items from the shared package delegate.

    \snippet views/package/view.qml 0

    \section1 ObjectModel

    \e ObjectModel uses an ObjectModel for the model instead of a \l ListModel.

    \snippet views/objectmodel/objectmodel.qml 0

    \section1 Display Margins

    \e{Display Margins} uses delegates to display items and implements a simple
    header and footer components.
*/