QAbstractFileEngineIterator *
CustomFileEngine::beginEntryList(QDir::Filters filters, const QStringList &filterNames)
{
    return new CustomFileEngineIterator(filters, filterNames);
}

class CustomIterator : public QAbstractFileEngineIterator
{
public:
    CustomIterator(const QStringList &nameFilters, QDir::Filters filters)
        : QAbstractFileEngineIterator(nameFilters, filters), index(0)
    {
        // In a real iterator, these entries are fetched from the
        // file system based on the value of path().
        entries << "entry1" << "entry2" << "entry3";
    }

    bool hasNext() const
    {
        return index < entries.size() - 1;
    }

    QString next()
    {
       if (!hasNext())
           return QString();
       ++index;
       return currentFilePath();
    }

    QString currentFileName()
    {
        return entries.at(index);
    }

private:
    QStringList entries;
    int index;
};

Member Function Documentation

QAbstractFileEngineIterator::QAbstractFileEngineIterator(QDir::Filters filters, const QStringList & nameFilters)

Constructs a QAbstractFileEngineIterator, using the entry filters filters, and wildcard name filters nameFilters.

[virtual] QAbstractFileEngineIterator::~QAbstractFileEngineIterator()

Destroys the QAbstractFileEngineIterator.

See also QDirIterator.

[virtual] QFileInfo QAbstractFileEngineIterator::currentFileInfo() const

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().

[pure virtual] QString QAbstractFileEngineIterator::currentFileName() const

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

See also currentFilePath().

QString QAbstractFileEngineIterator::currentFilePath() const

Returns the path to the current directory entry. It's the same as prepending path() to the return value of currentFileName().

See also currentFileName().

QDir::Filters QAbstractFileEngineIterator::filters() const

Returns the entry filters for this iterator.

See also QDir::filter(), nameFilters(), and path().

[pure virtual] bool QAbstractFileEngineIterator::hasNext() const

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().

QStringList QAbstractFileEngineIterator::nameFilters() const

Returns the name filters for this iterator.

See also QDir::nameFilters(), filters(), and path().

[pure virtual] QString QAbstractFileEngineIterator::next()

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().

QString QAbstractFileEngineIterator::path() const

Returns the path for this iterator. QDirIterator is responsible for assigning this path; it cannot change during the iterator's lifetime.

See also nameFilters() and filters().