1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDIRITERATOR_H
41#define QDIRITERATOR_H
42
43#include <QtCore/qdir.h>
44
45QT_BEGIN_NAMESPACE
46
47class QDirIteratorPrivate;
48class Q_CORE_EXPORT QDirIterator
49{
50public:
51 enum IteratorFlag {
52 NoIteratorFlags = 0x0,
53 FollowSymlinks = 0x1,
54 Subdirectories = 0x2
55 };
56 Q_DECLARE_FLAGS(IteratorFlags, IteratorFlag)
57
58 QDirIterator(const QDir &dir, IteratorFlags flags = NoIteratorFlags);
59 QDirIterator(const QString &path,
60 IteratorFlags flags = NoIteratorFlags);
61 QDirIterator(const QString &path,
62 QDir::Filters filter,
63 IteratorFlags flags = NoIteratorFlags);
64 QDirIterator(const QString &path,
65 const QStringList &nameFilters,
66 QDir::Filters filters = QDir::NoFilter,
67 IteratorFlags flags = NoIteratorFlags);
68
69 ~QDirIterator();
70
71 QString next();
72 bool hasNext() const;
73
74 QString fileName() const;
75 QString filePath() const;
76 QFileInfo fileInfo() const;
77 QString path() const;
78
79private:
80 Q_DISABLE_COPY(QDirIterator)
81
82 QScopedPointer<QDirIteratorPrivate> d;
83 friend class QDir;
84};
85
86Q_DECLARE_OPERATORS_FOR_FLAGS(QDirIterator::IteratorFlags)
87
88QT_END_NAMESPACE
89
90#endif
91