QDirIterator Class

The QDirIterator class provides an iterator for directory entrylists. 更多...

头: #include <QDirIterator>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core

公共类型

enum IteratorFlag { NoIteratorFlags, Subdirectories, FollowSymlinks }
flags IteratorFlags

公共函数

QDirIterator (const QDir & dir , QDirIterator::IteratorFlags flags = NoIteratorFlags)
QDirIterator (const QString & path , QDirIterator::IteratorFlags flags = NoIteratorFlags)
QDirIterator (const QString & path , QDir::Filters filters , QDirIterator::IteratorFlags flags = NoIteratorFlags)
QDirIterator (const QString & path , const QStringList & nameFilters , QDir::Filters filters = QDir::NoFilter, QDirIterator::IteratorFlags flags = NoIteratorFlags)
~QDirIterator ()
QFileInfo fileInfo () const
QString fileName () const
QString filePath () const
bool hasNext () const
QString next ()
(since 6.3) QFileInfo nextFileInfo ()
QString path () const

详细描述

You can use QDirIterator to navigate entries of a directory one at a time. It is similar to QDir::entryList () 和 QDir::entryInfoList (), but because it lists entries one at a time instead of all at once, it scales better and is more suitable for large directories. It also supports listing directory contents recursively, and following symbolic links. Unlike QDir::entryList (), QDirIterator does not support sorting.

The QDirIterator constructor takes a QDir or a directory as argument. After construction, the iterator is located before the first directory entry. Here's how to iterate over all the entries sequentially:

QDirIterator it("/etc", QDirIterator::Subdirectories);
while (it.hasNext()) {
    QString dir = it.next();
    qDebug() << dir;
    // /etc/.
    // /etc/..
    // /etc/X11
    // /etc/X11/fs
    // ...
}
					

Here's how to find and read all files filtered by name, recursively:

QDirIterator it("/sys", QStringList() << "scaling_cur_freq", QDir::NoFilter, QDirIterator::Subdirectories);
while (it.hasNext()) {
    QFile f(it.next());
    f.open(QIODevice::ReadOnly);
    qDebug() << f.fileName() << f.readAll().trimmed().toDouble() / 1000 << "MHz";
}
					

The next () 和 nextFileInfo () functions advance the iterator and return the path or the QFileInfo of the next directory entry. You can also call filePath () 或 fileInfo () to get the current file path or QFileInfo without first advancing the iterator. The fileName () function returns only the name of the file, similar to how QDir::entryList () works.

Unlike Qt's container iterators, QDirIterator is uni-directional (i.e., you cannot iterate directories in reverse order) and does not allow random access.

另请参阅 QDir and QDir::entryList ().

成员类型文档编制

enum QDirIterator:: IteratorFlag
flags QDirIterator:: IteratorFlags

This enum describes flags that you can combine to configure the behavior of QDirIterator .

常量 描述
QDirIterator::NoIteratorFlags 0x0 The default value, representing no flags. The iterator will return entries for the assigned path.
QDirIterator::Subdirectories 0x2 List entries inside all subdirectories as well.
QDirIterator::FollowSymlinks 0x1 When combined with Subdirectories, this flag enables iterating through all subdirectories of the assigned path, following all symbolic links. Symbolic link loops (e.g., "link" => "." or "link" => "..") are automatically detected and ignored.

IteratorFlags 类型是 typedef 对于 QFlags <IteratorFlag>。它存储 IteratorFlag 值的 OR 组合。

成员函数文档编制

QDirIterator:: QDirIterator (const QDir & dir , QDirIterator::IteratorFlags flags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over dir 's entrylist, using dir 's name filters and regular filters. You can pass options via flags to decide how the directory should be iterated.

默认情况下, flags is NoIteratorFlags , which provides the same behavior as in QDir::entryList ().

The sorting in dir 被忽略。

注意: To list symlinks that point to non existing files, QDir::System must be passed to the flags.

另请参阅 hasNext (), next (),和 IteratorFlags .

QDirIterator:: QDirIterator (const QString & path , QDirIterator::IteratorFlags flags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path . You can pass options via flags to decide how the directory should be iterated.

默认情况下, flags is NoIteratorFlags , which provides the same behavior as in QDir::entryList ().

注意: To list symlinks that point to non existing files, QDir::System must be passed to the flags.

另请参阅 hasNext (), next (),和 IteratorFlags .

QDirIterator:: QDirIterator (const QString & path , QDir::Filters filters , QDirIterator::IteratorFlags flags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path , with no name filtering and filters for entry filtering. You can pass options via flags to decide how the directory should be iterated.

默认情况下, filters is QDir::NoFilter ,和 flags is NoIteratorFlags , which provides the same behavior as in QDir::entryList ().

注意: To list symlinks that point to non existing files, QDir::System must be passed to the flags.

另请参阅 hasNext (), next (),和 IteratorFlags .

QDirIterator:: QDirIterator (const QString & path , const QStringList & nameFilters , QDir::Filters filters = QDir::NoFilter, QDirIterator::IteratorFlags flags = NoIteratorFlags)

Constructs a QDirIterator that can iterate over path ,使用 nameFilters and filters . You can pass options via flags to decide how the directory should be iterated.

默认情况下, flags is NoIteratorFlags , which provides the same behavior as QDir::entryList ().

For example, the following iterator could be used to iterate over audio files:

QDirIterator audioFileIt(audioPath, {"*.mp3", "*.wav"}, QDir::Files);
					

注意: To list symlinks that point to non existing files, QDir::System must be passed to the flags.

另请参阅 hasNext (), next (), IteratorFlags ,和 QDir::setNameFilters ().

[noexcept] QDirIterator:: ~QDirIterator ()

销毁 QDirIterator .

QFileInfo QDirIterator:: fileInfo () const

返回 QFileInfo for the current directory entry.

另请参阅 filePath () 和 fileName ().

QString QDirIterator:: fileName () const

Returns the file name for the current directory entry, without the path prepended.

This function is convenient when iterating a single directory. When using the QDirIterator::Subdirectories flag, you can use filePath () to get the full path.

另请参阅 filePath () 和 fileInfo ().

QString QDirIterator:: filePath () const

Returns the full file path for the current directory entry.

另请参阅 fileInfo () 和 fileName ().

bool QDirIterator:: hasNext () const

返回 true if there is at least one more entry in the directory; otherwise, false is returned.

另请参阅 next (), nextFileInfo (), fileName (), filePath (),和 fileInfo ().

QString QDirIterator:: next ()

Advances the iterator to the next entry, and returns the file path of this new entry. If hasNext () 返回 false , this function does nothing, and returns an empty QString .

可以调用 fileName () 或 filePath () to get the current entry's file name or path, or fileInfo () to get a QFileInfo for the current entry.

调用 nextFileInfo () instead of next() if you're interested in the QFileInfo .

另请参阅 hasNext (), nextFileInfo (), fileName (), filePath (),和 fileInfo ().

[since 6.3] QFileInfo QDirIterator:: nextFileInfo ()

Advances the iterator to the next entry, and returns the file info of this new entry. If hasNext () 返回 false , this function does nothing, and returns an empty QFileInfo .

可以调用 fileName () 或 filePath () to get the current entry's file name or path, or fileInfo () to get a QFileInfo for the current entry.

调用 next () instead of nextFileInfo() when all you need is the filePath ().

该函数在 Qt 6.3 引入。

另请参阅 hasNext (), fileName (), filePath (),和 fileInfo ().

QString QDirIterator:: path () const

Returns the base directory of the iterator.