summaryrefslogtreecommitdiffstats
path: root/src/corelib/io
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2020-08-17 15:38:47 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-08-25 10:09:32 +0000
commit823ad1424a1aac6dff96fa8495326dd52eb77b47 (patch)
tree59f33563f6ac7afdbf99af9d0e128bd5e1018269 /src/corelib/io
parent614e51a3de5fb9ea1e95fe25c0683fc40c3b8842 (diff)
Doc: provide a code example of QDirIterator's nameFilters parameter
Change-Id: I56f9251f17bab0f835979a5feadec1fa896c9d69 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> (cherry picked from commit 0c52e600b3b5c83d128e6b4068d523829357fef0) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/corelib/io')
-rw-r--r--src/corelib/io/qdiriterator.cpp7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/corelib/io/qdiriterator.cpp b/src/corelib/io/qdiriterator.cpp
index 1cf6b1be08..7411eab68b 100644
--- a/src/corelib/io/qdiriterator.cpp
+++ b/src/corelib/io/qdiriterator.cpp
@@ -483,10 +483,15 @@ QDirIterator::QDirIterator(const QString &path, IteratorFlags flags)
By default, \a flags is NoIteratorFlags, which provides the same behavior
as QDir::entryList().
+ For example, the following iterator could be used to iterate over audio
+ files:
+
+ \snippet code/src_corelib_io_qdiriterator.cpp 2
+
\note To list symlinks that point to non existing files, QDir::System must be
passed to the flags.
- \sa hasNext(), next(), IteratorFlags
+ \sa hasNext(), next(), IteratorFlags, QDir::setNameFilters()
*/
QDirIterator::QDirIterator(const QString &path, const QStringList &nameFilters,
QDir::Filters filters, IteratorFlags flags)