Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QFSFileEngineIterator Class Reference

#include <qfsfileengine_iterator_p.h>

+ Inheritance diagram for QFSFileEngineIterator:
+ Collaboration diagram for QFSFileEngineIterator:

Public Member Functions

 QFSFileEngineIterator (const QString &path, QDir::Filters filters, const QStringList &filterNames)
 
 ~QFSFileEngineIterator ()
 
bool advance () override
 This pure virtual function advances the iterator to the next directory entry; if the operation was successful this method returns true, otherwise it returs false.
 
QString currentFileName () const override
 This pure virtual function returns the name of the current directory entry, excluding the path.
 
QFileInfo currentFileInfo () const override
 The virtual function returns a QFileInfo for the current directory entry.
 
- Public Member Functions inherited from QAbstractFileEngineIterator
 QAbstractFileEngineIterator (const QString &path, QDir::Filters filters, const QStringList &nameFilters)
 Constructs a QAbstractFileEngineIterator, using the entry filters filters, and wildcard name filters nameFilters.
 
virtual ~QAbstractFileEngineIterator ()
 Destroys the QAbstractFileEngineIterator.
 
QString path () const
 Returns the path for this iterator.
 
QStringList nameFilters () const
 Returns the name filters for this iterator.
 
QDir::Filters filters () const
 Returns the entry filters for this iterator.
 
virtual QString currentFilePath () const
 Returns the path to the current directory entry.
 

Additional Inherited Members

- Protected Attributes inherited from QAbstractFileEngineIterator
QFileInfo m_fileInfo
 

Detailed Description

Definition at line 26 of file qfsfileengine_iterator_p.h.

Constructor & Destructor Documentation

◆ QFSFileEngineIterator()

QT_BEGIN_NAMESPACE QFSFileEngineIterator::QFSFileEngineIterator ( const QString & path,
QDir::Filters filters,
const QStringList & filterNames )

Definition at line 12 of file qfsfileengine_iterator.cpp.

◆ ~QFSFileEngineIterator()

QFSFileEngineIterator::~QFSFileEngineIterator ( )

Definition at line 19 of file qfsfileengine_iterator.cpp.

Member Function Documentation

◆ advance()

bool QFSFileEngineIterator::advance ( )
overridevirtual

This pure virtual function advances the iterator to the next directory entry; if the operation was successful this method returns true, otherwise it returs false.

This function can optionally make use of nameFilters() and filters() to optimize its performance.

Reimplement this function in a subclass to advance the iterator.

Implements QAbstractFileEngineIterator.

Definition at line 23 of file qfsfileengine_iterator.cpp.

References QFileSystemIterator::advance(), QAbstractFileEngineIterator::m_fileInfo, and QScopedPointer< T, Cleanup >::reset().

+ Here is the call graph for this function:

◆ currentFileInfo()

QFileInfo QFSFileEngineIterator::currentFileInfo ( ) const
overridevirtual

The virtual function returns a QFileInfo for the current directory entry.

This function is provided for convenience. It can also be slightly faster than creating a QFileInfo object yourself, as the object returned by this function might contain cached information that QFileInfo otherwise would have to access through the file engine.

See also
currentFileName()

Reimplemented from QAbstractFileEngineIterator.

Definition at line 44 of file qfsfileengine_iterator.cpp.

References QAbstractFileEngineIterator::m_fileInfo.

◆ currentFileName()

QString QFSFileEngineIterator::currentFileName ( ) const
overridevirtual

This pure virtual function returns the name of the current directory entry, excluding the path.

See also
currentFilePath()

Implements QAbstractFileEngineIterator.

Definition at line 39 of file qfsfileengine_iterator.cpp.

References QFileInfo::fileName(), and QAbstractFileEngineIterator::m_fileInfo.

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: