summaryrefslogtreecommitdiffstats
path: root/src/declarative/graphicsitems/qdeclarativepathview.cpp
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2010-06-01 06:27:59 (GMT)
committerBea Lam <bea.lam@nokia.com>2010-06-02 00:07:33 (GMT)
commit9cb0802cede5f9fd91ca303bcec5ae869acae951 (patch)
treef90d5fed5004dfa7e526783d81f94f04444313e4 /src/declarative/graphicsitems/qdeclarativepathview.cpp
parent2e904930ede28a59710ef6f898419aba7ede7c06 (diff)
downloadQt-9cb0802cede5f9fd91ca303bcec5ae869acae951.zip
Qt-9cb0802cede5f9fd91ca303bcec5ae869acae951.tar.gz
Qt-9cb0802cede5f9fd91ca303bcec5ae869acae951.tar.bz2
Doc fixes and improvements - fix some example code, link to
examples from class docs and improve assorted docs
Diffstat (limited to 'src/declarative/graphicsitems/qdeclarativepathview.cpp')
-rw-r--r--src/declarative/graphicsitems/qdeclarativepathview.cpp12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/declarative/graphicsitems/qdeclarativepathview.cpp b/src/declarative/graphicsitems/qdeclarativepathview.cpp
index 448ec06..695af7e 100644
--- a/src/declarative/graphicsitems/qdeclarativepathview.cpp
+++ b/src/declarative/graphicsitems/qdeclarativepathview.cpp
@@ -310,11 +310,21 @@ void QDeclarativePathViewPrivate::regenerate()
\brief The PathView element lays out model-provided items on a path.
\inherits Item
- The model is typically provided by a QAbstractListModel "C++ model object", but can also be created directly in QML.
+ A PathView displays data from models created from built-in QML elements like ListModel
+ and XmlListModel, or custom model classes defined in C++ that inherit from
+ QAbstractListModel.
+ A ListView has a \l model, which defines the data to be displayed, and
+ a \l delegate, which defines how the data should be displayed.
The \l delegate is instantiated for each item on the \l path.
The items may be flicked to move them along the path.
+ For example, if there is a simple list model defined in a file \c ContactModel.qml like this:
+
+ \snippet doc/src/snippets/declarative/pathview/ContactModel.qml 0
+
+ This data can be represented as a PathView, like this:
+
\snippet doc/src/snippets/declarative/pathview/pathview.qml 0
\image pathview.gif