QFSFileEngine Class

The QFSFileEngine class implements Qt's default file engine. \since 4.1 \internal. More...

Header: #include <QFSFileEngine>
Inherits: QAbstractFileEngine

Public Functions

QFSFileEngine()
QFSFileEngine(const QString &file)
virtual ~QFSFileEngine()
bool mkdir(const QString &name, bool createParentDirectories, int permissions) const override
bool open(QIODevice::OpenMode openMode, int fd) override
bool open(QIODevice::OpenMode openMode, FILE *fh)

Reimplemented Public Functions

virtual Iterator *beginEntryList(QDir::Filters filters, const QStringList &filterNames) override
virtual bool cloneTo(QAbstractFileEngine *target) override
virtual bool close() override
virtual bool copy(const QString &copyName) override
virtual Iterator *endEntryList() override
virtual QStringList entryList(QDir::Filters filters, const QStringList &filterNames) const override
virtual bool extension(Extension extension, const ExtensionOption *option = nullptr, ExtensionReturn *output = nullptr) override
virtual FileFlags fileFlags(FileFlags type) const override
virtual QDateTime fileTime(FileTime time) const override
virtual bool flush() override
virtual int handle() const override
virtual bool isSequential() const override
virtual qint64 pos() const override
virtual qint64 read(char *data, qint64 maxlen) override
virtual qint64 readLine(char *data, qint64 maxlen) override
virtual bool remove() override
virtual bool rename(const QString &newName) override
virtual bool renameOverwrite(const QString &newName) override
virtual bool rmdir(const QString &name, bool recurseParentDirectories) const override
virtual bool seek(qint64 pos) override
virtual void setFileName(const QString &file) override
virtual qint64 size() const override
virtual bool supportsExtension(Extension extension) const override
virtual bool syncToDisk() override
virtual qint64 write(const char *data, qint64 len) override

Static Public Members

QString homePath()
QString rootPath()
bool setCurrentPath(const QString &path)
QString tempPath()

Protected Functions

QFSFileEngine(QFSFileEnginePrivate &dd)

Detailed Description

\inmoduleQtCore

This class is part of the file engine framework in Qt. If you only want to access files or directories, use QFile, QFileInfo or QDir instead.

QFSFileEngine is the default file engine for accessing regular files. It is provided for convenience; by subclassing this class, you can alter its behavior slightly, without having to write a complete QAbstractFileEngine subclass. To install your custom file engine, you must also subclass QAbstractFileEngineHandler and create an instance of your handler.

It can also be useful to create a QFSFileEngine object directly if you need to use the local file system inside QAbstractFileEngine::create(), in order to avoid recursion (as higher-level classes tend to call QAbstractFileEngine::create()).

Member Function Documentation

QFSFileEngine::QFSFileEngine()

Constructs a QFSFileEngine.

[explicit] QFSFileEngine::QFSFileEngine(const QString &file)

Constructs a QFSFileEngine for the file name file.

[protected] QFSFileEngine::QFSFileEngine(QFSFileEnginePrivate &dd)

\internal

[virtual noexcept] QFSFileEngine::~QFSFileEngine()

Destructs the QFSFileEngine.

[override virtual] Iterator *QFSFileEngine::beginEntryList(QDir::Filters filters, const QStringList &filterNames)

Reimplements: QAbstractFileEngine::beginEntryList(QDir::Filters filters, const QStringList &filterNames).

\internal

[override virtual] bool QFSFileEngine::cloneTo(QAbstractFileEngine *target)

Reimplements: QAbstractFileEngine::cloneTo(QAbstractFileEngine *target).

[override virtual] bool QFSFileEngine::close()

Reimplements: QAbstractFileEngine::close().

[override virtual] bool QFSFileEngine::copy(const QString &copyName)

Reimplements: QAbstractFileEngine::copy(const QString &newName).

For Windows or Apple platforms, copy the file to file copyName.

Not implemented for other Unix platforms.

[override virtual] Iterator *QFSFileEngine::endEntryList()

Reimplements: QAbstractFileEngine::endEntryList().

\internal

[override virtual] QStringList QFSFileEngine::entryList(QDir::Filters filters, const QStringList &filterNames) const

Reimplements: QAbstractFileEngine::entryList(QDir::Filters filters, const QStringList &filterNames) const.

\internal

[override virtual] bool QFSFileEngine::extension(Extension extension, const ExtensionOption *option = nullptr, ExtensionReturn *output = nullptr)

Reimplements: QAbstractFileEngine::extension(Extension extension, const ExtensionOption *option, ExtensionReturn *output).

[override virtual] FileFlags QFSFileEngine::fileFlags(FileFlags type) const

Reimplements: QAbstractFileEngine::fileFlags(FileFlags type) const.

[override virtual] QDateTime QFSFileEngine::fileTime(FileTime time) const

Reimplements: QAbstractFileEngine::fileTime(FileTime time) const.

[override virtual] bool QFSFileEngine::flush()

Reimplements: QAbstractFileEngine::flush().

[override virtual] int QFSFileEngine::handle() const

Reimplements: QAbstractFileEngine::handle() const.

[static] QString QFSFileEngine::homePath()

Returns the home path of the current user.

See also rootPath().

[override virtual] bool QFSFileEngine::isSequential() const

Reimplements: QAbstractFileEngine::isSequential() const.

bool QFSFileEngine::mkdir(const QString &name, bool createParentDirectories, int permissions) const

bool QFSFileEngine::open(QIODevice::OpenMode openMode, int fd)

Opens the file descriptor fd in openMode mode. Returns true on success; otherwise returns false.

bool QFSFileEngine::open(QIODevice::OpenMode openMode, FILE *fh)

Opens the file handle fh in openMode mode. Returns true on success; otherwise returns false.

[override virtual] qint64 QFSFileEngine::pos() const

Reimplements: QAbstractFileEngine::pos() const.

[override virtual] qint64 QFSFileEngine::read(char *data, qint64 maxlen)

Reimplements: QAbstractFileEngine::read(char *data, qint64 maxlen).

[override virtual] qint64 QFSFileEngine::readLine(char *data, qint64 maxlen)

Reimplements: QAbstractFileEngine::readLine(char *data, qint64 maxlen).

[override virtual] bool QFSFileEngine::remove()

Reimplements: QAbstractFileEngine::remove().

[override virtual] bool QFSFileEngine::rename(const QString &newName)

Reimplements: QAbstractFileEngine::rename(const QString &newName).

[override virtual] bool QFSFileEngine::renameOverwrite(const QString &newName)

Reimplements: QAbstractFileEngine::renameOverwrite(const QString &newName).

[override virtual] bool QFSFileEngine::rmdir(const QString &name, bool recurseParentDirectories) const

Reimplements: QAbstractFileEngine::rmdir(const QString &dirName, bool recurseParentDirectories) const.

[static] QString QFSFileEngine::rootPath()

Returns the root path.

See also homePath().

[override virtual] bool QFSFileEngine::seek(qint64 pos)

[static] bool QFSFileEngine::setCurrentPath(const QString &path)

Sets the current path (e.g., for QDir), to path. Returns true if the new path exists; otherwise this function does nothing, and returns false.

See also currentPath().

[override virtual] void QFSFileEngine::setFileName(const QString &file)

Reimplements: QAbstractFileEngine::setFileName(const QString &file).

[override virtual] qint64 QFSFileEngine::size() const

Reimplements: QAbstractFileEngine::size() const.

[override virtual] bool QFSFileEngine::supportsExtension(Extension extension) const

Reimplements: QAbstractFileEngine::supportsExtension(Extension extension) const.

[override virtual] bool QFSFileEngine::syncToDisk()

Reimplements: QAbstractFileEngine::syncToDisk().

[static] QString QFSFileEngine::tempPath()

Returns the temporary path (i.e., a path in which it is safe to store temporary files).

[override virtual] qint64 QFSFileEngine::write(const char *data, qint64 len)

Reimplements: QAbstractFileEngine::write(const char *data, qint64 len).