CopperSpice API  1.7.2
QAbstractFileEngineIterator Class Referenceabstract

The QAbstractFileEngineIterator class provides an iterator interface for custom file engines. More...

Inherited by QFSFileEngineIterator, and QResourceFileEngineIterator.

Public Methods

 QAbstractFileEngineIterator (QDir::Filters filters, const QStringList &nameFilters)
 
virtual ~QAbstractFileEngineIterator ()
 
virtual QFileInfo currentFileInfo () const
 
virtual QString currentFileName () const = 0
 
QString currentFilePath () const
 
QDir::Filters filters () const
 
virtual bool hasNext () const = 0
 
QStringList nameFilters () const
 
virtual QString next () = 0
 
QString path () const
 

Friends

class QDirIterator
 

Detailed Description

The QAbstractFileEngineIterator class provides an iterator interface for custom file engines.

If all you want is to iterate over entries in a directory, see QDirIterator instead. This class is only for custom file engine authors.

QAbstractFileEngineIterator is a unidirectional single-use virtual iterator that plugs into QDirIterator, providing transparent proxy iteration for custom file engines.

You can subclass QAbstractFileEngineIterator to provide an iterator when writing your own file engine. To plug the iterator into your file system, you simply return an instance of this subclass from a reimplementation of QAbstractFileEngine::beginEntryList().

Example:

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

QAbstractFileEngineIterator is associated with a path, name filters, and entry filters. The path is the directory that the iterator lists entries in. The name filters and entry filters are provided for file engines that can optimize directory listing at the iterator level (e.g., network file systems that need to minimize network traffic), but they can also be ignored by the iterator subclass; QAbstractFileEngineIterator already provides the required filtering logics in the matchesFilters() function. You can call dirName() to get the directory name, nameFilters() to get a stringlist of name filters, and filters() to get the entry filters.

The pure virtual function hasNext() returns true if the current directory has at least one more entry (i.e., the directory name is valid and accessible, and we have not reached the end of the entry list), and false otherwise. Reimplement next() to seek to the next entry.

The pure virtual function currentFileName() returns the name of the current entry without advancing the iterator. The currentFilePath() function is provided for convenience; it returns the full path of the current entry.

Here is an example of how to implement an iterator that returns each of three fixed entries in sequence.

class CustomIterator : public QAbstractFileEngineIterator
{
public:
CustomIterator(const QStringList &nameFilters, QDir::Filters filters)
{
// 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;
}
{
if (!hasNext()) {
return QString();
}
++index;
return currentFilePath();
}
{
return entries.at(index);
}
private:
QStringList entries;
int index;
};

Note: QAbstractFileEngineIterator does not deal with QDir::IteratorFlags; it simply returns entries for a single directory.

See also
QDirIterator

Constructor & Destructor Documentation

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

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

QAbstractFileEngineIterator::~QAbstractFileEngineIterator ( )
virtual

Destroys the QAbstractFileEngineIterator.

See also
QDirIterator

Method Documentation

QFileInfo QAbstractFileEngineIterator::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()
QString QAbstractFileEngineIterator::currentFileName ( ) const
pure virtual

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(), path()
bool QAbstractFileEngineIterator::hasNext ( ) const
pure 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()
QStringList QAbstractFileEngineIterator::nameFilters ( ) const

Returns the name filters for this iterator.

See also
QDir::nameFilters(), filters(), path()
QString QAbstractFileEngineIterator::next ( )
pure 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()
QString QAbstractFileEngineIterator::path ( ) const

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

See also
nameFilters(), filters()