summaryrefslogtreecommitdiff
path: root/examples/quick/views/doc/src/views.qdoc
blob: cc8112f4dd27d490a1f5981f921ad86e33d1ecfd (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
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.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

    This is a collection of small QML examples relating to model and view functionality. They demonstrate how to show data from a model using the QtQuick view types.

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

    \section2 Dynamic List demonstrates animation of runtime additions and removals to a 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 quick/views/listview/dynamiclist.qml 0
    \snippet quick/views/listview/dynamiclist.qml 1

    \section2 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 quick/views/listview/expandingdelegates.qml 0
    \snippet quick/views/listview/expandingdelegates.qml 1
    \snippet quick/views/listview/expandingdelegates.qml 2
    \snippet quick/views/listview/expandingdelegates.qml 3

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

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

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

    \section2 Packages demonstrates using Packages to transition delegates between two views.

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

    \snippet quick/views/package/Delegate.qml 0

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

    \snippet quick/views/package/view.qml 0

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

    \snippet quick/views/visualitemmodel/visualitemmodel.qml 0
*/