path: root/examples/widgets/doc
diff options
authorNico Vertriest <>2018-04-16 15:09:41 +0200
committerNico Vertriest <>2018-04-25 09:02:02 +0000
commitb1bbce26098012f10d18362d53fdf7ced7dbbf8c (patch)
tree7799bad9718e9e7493ec6894d797f63fc8526cd3 /examples/widgets/doc
parent5155942a0d42538d1d45cd66ddf76c513cb692ab (diff)
Doc: Update doc for Dir View Example
Task-number: QTBUG-60635 Change-Id: I4a23f4866c76b9f5c29653ca30e44c3b844a9aa8 Reviewed-by: Paul Wicking <> Reviewed-by: Venugopal Shivashankar <>
Diffstat (limited to 'examples/widgets/doc')
1 files changed, 10 insertions, 11 deletions
diff --git a/examples/widgets/doc/src/dirview.qdoc b/examples/widgets/doc/src/dirview.qdoc
index d9a16fa58d..6db339eced 100644
--- a/examples/widgets/doc/src/dirview.qdoc
+++ b/examples/widgets/doc/src/dirview.qdoc
@@ -37,6 +37,10 @@
\borderedimage dirview-example.png
+ \quotefromfile itemviews/dirview/main.cpp
+ \skipto QCommandLineParser parser
+ \printuntil parser.positionalArguments
The example supports a number of command line options.
These options include:
@@ -47,22 +51,17 @@
use custom directory options
- \quotefromfile itemviews/dirview/main.cpp
- \skipto QCommandLineParser parser
- \printuntil parser.positionalArguments
- Declares a QFileSystemModel as data model for viewing
- the local file system. QFileSystem works with a cache, that is,
- it is updated continually with QFileSystemWatcher on that folder.
\skipto QFileSystemModel
\printuntil tree.setModel
- Creates a model/view implementation called \c tree
- for viewing the filesystem.
+ Declares \c model as data model for reading the local filesystem.
+ \c model.setRootPath("") sets the current folder as the folder from
+ which \c model will start reading.
+ QTreeView object \c tree visualizes the filesystem in a tree structure.
\skipto tree.setAnimated(false)
\printuntil tree.setWindowTitle
- Sets some formatting options for \c tree.
+ Sets layout options for animation, indentation, sorting, and sizing of the
+ filesystem tree.