Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QFSFileEngineIterator Class Reference

#include <qfsfileengine_iterator_p.h>

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

Public Member Functions

 QFSFileEngineIterator (QDir::Filters filters, const QStringList &filterNames)
 
 ~QFSFileEngineIterator ()
 
QString next () override
 This pure virtual function advances the iterator to the next directory entry, and returns the file path to the current entry.
 
bool hasNext () const override
 This pure virtual function returns true if there is at least one more entry in the current directory (i.e., the iterator path is valid and accessible, and the iterator has not reached the end of the entry list).
 
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 (QDir::Filters filters, const QStringList &nameFilters)
 Constructs a QAbstractFileEngineIterator, using the entry filters filters, and wildcard name filters nameFilters.
 
virtual ~QAbstractFileEngineIterator ()
 Destroys the QAbstractFileEngineIterator.
 
virtual QString next ()=0
 This pure virtual function advances the iterator to the next directory entry, and returns the file path to the current entry.
 
virtual bool hasNext () const =0
 This pure virtual function returns true if there is at least one more entry in the current directory (i.e., the iterator path is valid and accessible, and the iterator has not reached the end of the entry list).
 
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 currentFileName () const =0
 This pure virtual function returns the name of the current directory entry, excluding the path.
 
virtual QFileInfo currentFileInfo () const
 The virtual function returns a QFileInfo for the current directory entry.
 
virtual QString currentFilePath () const
 Returns the path to the current directory entry.
 

Additional Inherited Members

- Protected Types inherited from QAbstractFileEngineIterator
enum  EntryInfoType
 
- Protected Member Functions inherited from QAbstractFileEngineIterator
virtual QVariant entryInfo (EntryInfoType type) const
 

Detailed Description

Definition at line 29 of file qfsfileengine_iterator_p.h.

Constructor & Destructor Documentation

◆ QFSFileEngineIterator()

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

Definition at line 12 of file qfsfileengine_iterator.cpp.

◆ ~QFSFileEngineIterator()

QFSFileEngineIterator::~QFSFileEngineIterator ( )

Definition at line 18 of file qfsfileengine_iterator.cpp.

Member Function Documentation

◆ 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 61 of file qfsfileengine_iterator.cpp.

◆ 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 56 of file qfsfileengine_iterator.cpp.

References QFileInfo::fileName().

+ Here is the call graph for this function:

◆ hasNext()

bool QFSFileEngineIterator::hasNext ( ) const
overridevirtual

This pure virtual function returns true if there is at least one more entry in the current directory (i.e., the iterator path is valid and accessible, and the iterator has not reached the end of the entry list).

See also
QDirIterator::hasNext()

Implements QAbstractFileEngineIterator.

Definition at line 22 of file qfsfileengine_iterator.cpp.

References QAbstractFileEngineIterator::filters(), QAbstractFileEngineIterator::nameFilters(), QAbstractFileEngineIterator::path(), and QScopedPointer< T, Cleanup >::reset().

Referenced by next().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ next()

QString QFSFileEngineIterator::next ( )
overridevirtual

This pure virtual function advances the iterator to the next directory entry, and returns the file path to the current entry.

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

Reimplement this function in a subclass to advance the iterator.

See also
QDirIterator::next()

Implements QAbstractFileEngineIterator.

Definition at line 33 of file qfsfileengine_iterator.cpp.

References QAbstractFileEngineIterator::currentFilePath(), and hasNext().

+ Here is the call graph for this function:

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