QFSFileEngineIterator Class Reference

#include <qfsfileengine_iterator_p.h>

Inheritance diagram for QFSFileEngineIterator:

Public Functions
QFileInfo	currentFileInfo () const
	The virtual function returns a QFileInfo for the current directory entry. More...
QString	currentFileName () const
	This pure virtual function returns the name of the current directory entry, excluding the path. More...
bool	hasNext () const
	This pure virtual function returns true if there is at least one more entry in the current directory (i. More...
QString	next ()
	This pure virtual function advances the iterator to the next directory entry, and returns the file path to the current entry. More...
	QFSFileEngineIterator (QDir::Filters filters, const QStringList &filterNames)
	~QFSFileEngineIterator ()
Public Functions inherited from QAbstractFileEngineIterator
QString	currentFilePath () const
	Returns the path to the current directory entry. More...
QDir::Filters	filters () const
	Returns the entry filters for this iterator. More...
QStringList	nameFilters () const
	Returns the name filters for this iterator. More...
QString	path () const
	Returns the path for this iterator. More...
	QAbstractFileEngineIterator (QDir::Filters filters, const QStringList &nameFilters)
	Constructs a QAbstractFileEngineIterator, using the entry filters filters, and wildcard name filters nameFilters. More...
virtual	~QAbstractFileEngineIterator ()
	Destroys the QAbstractFileEngineIterator. More...

Private Functions
void	advance () const

Properties
QFileInfo	currentInfo
bool	done
QScopedPointer< QFileSystemIterator >	nativeIterator
QFileInfo	nextInfo

Additional Inherited Members
Protected Types inherited from QAbstractFileEngineIterator
enum	EntryInfoType
	This enum describes the different types of information that can be requested through the QAbstractFileEngineIterator::entryInfo() function. More...
Protected Functions inherited from QAbstractFileEngineIterator
virtual QVariant	entryInfo (EntryInfoType type) const
	Returns the entry info type for this iterator's current directory entry as a QVariant. More...

Detailed Description

Definition at line 68 of file qfsfileengine_iterator_p.h.

Constructors and Destructors

QFSFileEngineIterator()

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

Definition at line 51 of file qfsfileengine_iterator.cpp.

    : QAbstractFileEngineIterator(filters, filterNames)
    , done(false)
{
}

~QFSFileEngineIterator()

QFSFileEngineIterator::~QFSFileEngineIterator

(

)

Definition at line 57 of file qfsfileengine_iterator.cpp.

{
}

Functions

advance()

void QFSFileEngineIterator::advance ( ) const

private

Definition at line 81 of file qfsfileengine_iterator.cpp.

Referenced by hasNext(), and next().

{
    currentInfo = nextInfo;

    QFileSystemEntry entry;
    QFileSystemMetaData data;
    if (nativeIterator->advance(entry, data)) {
        nextInfo = QFileInfo(new QFileInfoPrivate(entry, data));
    } else {
        done = true;
        nativeIterator.reset();
    }
}

currentFileInfo()

QFileInfo QFSFileEngineIterator::currentFileInfo ( ) const

virtual

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

{
    return currentInfo;
}

currentFileName()

QString QFSFileEngineIterator::currentFileName ( ) const

virtual

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

See also

currentFilePath()

Implements QAbstractFileEngineIterator.

Definition at line 95 of file qfsfileengine_iterator.cpp.

{
    return currentInfo.fileName();
}

hasNext()

bool QFSFileEngineIterator::hasNext ( ) const

virtual

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

Referenced by next().

{
    if (!done && !nativeIterator) {
        nativeIterator.reset(new QFileSystemIterator(QFileSystemEntry(path()),
                    filters(), nameFilters()));
        advance();
    }

    return !done;
}

next()

QString QFSFileEngineIterator::next ( )

virtual

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

{
    if (!hasNext())
        return QString();

    advance();
    return currentFilePath();
}

Properties

currentInfo

QFileInfo QFSFileEngineIterator::currentInfo

mutableprivate

Definition at line 83 of file qfsfileengine_iterator_p.h.

Referenced by advance(), currentFileInfo(), and currentFileName().

done

bool QFSFileEngineIterator::done

mutableprivate

Definition at line 85 of file qfsfileengine_iterator_p.h.

Referenced by advance(), and hasNext().

nativeIterator

QScopedPointer<QFileSystemIterator> QFSFileEngineIterator::nativeIterator

mutableprivate

Definition at line 82 of file qfsfileengine_iterator_p.h.

Referenced by advance(), and hasNext().

nextInfo

QFileInfo QFSFileEngineIterator::nextInfo

mutableprivate

Definition at line 84 of file qfsfileengine_iterator_p.h.

Referenced by advance().

---

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

• /src/corelib/io/qfsfileengine_iterator_p.h
• /src/corelib/io/qfsfileengine_iterator.cpp