QFSFileEngine Class Reference

The QFSFileEngine class implements Qt's default file engine. More...

 #include <QFSFileEngine>

Inherits: QAbstractFileEngine.

This class was introduced in Qt 4.1.

List of all members, including inherited members

Public Types

typedef Iterator

Public Functions

	QFSFileEngine ()
	QFSFileEngine ( const QString & file )
	~QFSFileEngine ()
bool	open ( QIODevice::OpenMode openMode, FILE * fh )
bool	open ( QIODevice::OpenMode openMode, int fd )
bool	open ( QIODevice::OpenMode openMode, int fd, QFile::FileHandleFlags handleFlags )
bool	open ( QIODevice::OpenMode openMode, FILE * fh, QFile::FileHandleFlags handleFlags )
bool	open ( QIODevice::OpenMode openMode, const RFile & file, QFile::FileHandleFlags handleFlags )

Reimplemented Public Functions

virtual bool	caseSensitive () const
virtual bool	close ()
virtual bool	copy ( const QString & copyName )
virtual bool	extension ( Extension extension, const ExtensionOption * option = 0, ExtensionReturn * output = 0 )
virtual FileFlags	fileFlags ( FileFlags type ) const
virtual QString	fileName ( FileName file ) const
virtual QDateTime	fileTime ( FileTime time ) const
virtual bool	flush ()
virtual int	handle () const
virtual bool	isRelativePath () const
virtual bool	isSequential () const
virtual bool	link ( const QString & newName )
virtual bool	mkdir ( const QString & name, bool createParentDirectories ) const
virtual bool	open ( QIODevice::OpenMode openMode )
virtual QString	owner ( FileOwner own ) const
virtual uint	ownerId ( FileOwner own ) const
virtual qint64	pos () const
virtual qint64	read ( char * data, qint64 maxlen )
virtual qint64	readLine ( char * data, qint64 maxlen )
virtual bool	remove ()
virtual bool	rename ( const QString & newName )
virtual bool	rmdir ( const QString & name, bool recurseParentDirectories ) const
virtual bool	seek ( qint64 pos )
virtual void	setFileName ( const QString & file )
virtual bool	setPermissions ( uint perms )
virtual bool	setSize ( qint64 size )
virtual qint64	size () const
virtual bool	supportsExtension ( Extension extension ) const
virtual qint64	write ( const char * data, qint64 len )

36 public functions inherited from QAbstractFileEngine

Static Public Members

QString	currentPath ( const QString & fileName = QString() )
QFileInfoList	drives ()
QString	homePath ()
QString	rootPath ()
bool	setCurrentPath ( const QString & path )
QString	tempPath ()

1 static public member inherited from QAbstractFileEngine

Additional Inherited Members

1 protected function inherited from QAbstractFileEngine

Detailed Description

The QFSFileEngine class implements Qt's default file engine.

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.

QFSFileEngine::QFSFileEngine ( const QString & file )

Constructs a QFSFileEngine for the file name file.

QFSFileEngine::~QFSFileEngine ()

Destructs the QFSFileEngine.

bool QFSFileEngine::caseSensitive () const `[virtual]`

Reimplemented from QAbstractFileEngine::caseSensitive().

Returns true for Windows, false for Unix.

bool QFSFileEngine::close () `[virtual]`

Reimplemented from QAbstractFileEngine::close().

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

Reimplemented from QAbstractFileEngine::copy().

For windows, copy the file to file copyName.

Not implemented for Unix.

QString QFSFileEngine::currentPath ( const QString & fileName = QString() ) `[static]`

For Unix, returns the current working directory for the file engine.

For Windows, returns the canonicalized form of the current path used by the file engine for the drive specified by fileName. On Windows, each drive has its own current directory, so a different path is returned for file names that include different drive names (e.g. A: or C:).

See also setCurrentPath().

QFileInfoList QFSFileEngine::drives () `[static]`

For Windows, returns the list of drives in the file system as a list of QFileInfo objects. On unix, Mac OS X and Windows CE, only the root path is returned. On Windows, this function returns all drives (A:, C:, D:, etc.).

For Unix, the list contains just the root path "/".

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

Reimplemented from QAbstractFileEngine::extension().

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

Reimplemented from QAbstractFileEngine::fileFlags().

QString QFSFileEngine::fileName ( FileName file ) const `[virtual]`

Reimplemented from QAbstractFileEngine::fileName().

See also setFileName().

QString QFSFileEngine::homePath () `[static]`

Returns the home path of the current user.

See also rootPath().

bool QFSFileEngine::isRelativePath () const `[virtual]`

Reimplemented from QAbstractFileEngine::isRelativePath().

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

Reimplemented from QAbstractFileEngine::isSequential().

bool QFSFileEngine::link ( const QString & newName ) `[virtual]`

Reimplemented from QAbstractFileEngine::link().

Creates a link from the file currently specified by fileName() to newName. What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns true if successful; otherwise returns false.

bool QFSFileEngine::mkdir ( const QString & name, bool createParentDirectories ) const `[virtual]`

Reimplemented from QAbstractFileEngine::mkdir().

bool QFSFileEngine::open ( QIODevice::OpenMode openMode ) `[virtual]`

Reimplemented from QAbstractFileEngine::open().

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

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

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, int fd, QFile::FileHandleFlags handleFlags )

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

The handleFlags argument specifies whether the file handle will be closed by Qt. See the QFile::FileHandleFlags documentation for more information.

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

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

The handleFlags argument specifies whether the file handle will be closed by Qt. See the QFile::FileHandleFlags documentation for more information.

bool QFSFileEngine::open ( QIODevice::OpenMode openMode, const RFile & file, QFile::FileHandleFlags handleFlags )

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

The handleFlags argument specifies whether the file handle will be closed by Qt. See the QFile::FileHandleFlags documentation for more information.

QString QFSFileEngine::owner ( FileOwner own ) const `[virtual]`

Reimplemented from QAbstractFileEngine::owner().

uint QFSFileEngine::ownerId ( FileOwner own ) const `[virtual]`

Reimplemented from QAbstractFileEngine::ownerId().

In Unix, if stat() is successful, the uid is returned if own is the owner. Otherwise the gid is returned. If stat() is unsuccessful, -2 is reuturned.

For Windows, -2 is always returned.

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

Reimplemented from QAbstractFileEngine::pos().

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

Reimplemented from QAbstractFileEngine::read().

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

Reimplemented from QAbstractFileEngine::readLine().

bool QFSFileEngine::remove () `[virtual]`

Reimplemented from QAbstractFileEngine::remove().

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

Reimplemented from QAbstractFileEngine::rename().

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

Reimplemented from QAbstractFileEngine::rmdir().

QString QFSFileEngine::rootPath () `[static]`

Returns the root path.

See also homePath().

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

Reimplemented from QAbstractFileEngine::seek().

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

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

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

Reimplemented from QAbstractFileEngine::setFileName().

See also fileName().

bool QFSFileEngine::setPermissions ( uint perms ) `[virtual]`

Reimplemented from QAbstractFileEngine::setPermissions().

bool QFSFileEngine::setSize ( qint64 size ) `[virtual]`

Reimplemented from QAbstractFileEngine::setSize().

See also size().

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

Reimplemented from QAbstractFileEngine::size().

See also setSize().

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

Reimplemented from QAbstractFileEngine::supportsExtension().

QString QFSFileEngine::tempPath () `[static]`

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

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

Reimplemented from QAbstractFileEngine::write().

Contents

QFSFileEngine Class Reference

Public Types

Public Functions

Reimplemented Public Functions

Static Public Members

Additional Inherited Members

Detailed Description

Member Function Documentation

QFSFileEngine::QFSFileEngine ()

QFSFileEngine::QFSFileEngine ( const QString & file )

QFSFileEngine::~QFSFileEngine ()

bool QFSFileEngine::caseSensitive () const [virtual]

bool QFSFileEngine::close () [virtual]

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

QString QFSFileEngine::currentPath ( const QString & fileName = QString() ) [static]

QFileInfoList QFSFileEngine::drives () [static]

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

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

QString QFSFileEngine::fileName ( FileName file ) const [virtual]

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

bool QFSFileEngine::flush () [virtual]

int QFSFileEngine::handle () const [virtual]

QString QFSFileEngine::homePath () [static]

bool QFSFileEngine::isRelativePath () const [virtual]

bool QFSFileEngine::isSequential () const [virtual]

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

bool QFSFileEngine::mkdir ( const QString & name, bool createParentDirectories ) const [virtual]

bool QFSFileEngine::open ( QIODevice::OpenMode openMode ) [virtual]

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

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

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

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

bool QFSFileEngine::open ( QIODevice::OpenMode openMode, const RFile & file, QFile::FileHandleFlags handleFlags )

QString QFSFileEngine::owner ( FileOwner own ) const [virtual]

uint QFSFileEngine::ownerId ( FileOwner own ) const [virtual]

qint64 QFSFileEngine::pos () const [virtual]

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

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

bool QFSFileEngine::remove () [virtual]

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

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

QString QFSFileEngine::rootPath () [static]

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

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

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

bool QFSFileEngine::setPermissions ( uint perms ) [virtual]

bool QFSFileEngine::setSize ( qint64 size ) [virtual]

qint64 QFSFileEngine::size () const [virtual]

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

QString QFSFileEngine::tempPath () [static]

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

bool QFSFileEngine::caseSensitive () const `[virtual]`

bool QFSFileEngine::close () `[virtual]`

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

QString QFSFileEngine::currentPath ( const QString & fileName = QString() ) `[static]`

QFileInfoList QFSFileEngine::drives () `[static]`

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

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

QString QFSFileEngine::fileName ( FileName file ) const `[virtual]`

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

bool QFSFileEngine::flush () `[virtual]`

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

QString QFSFileEngine::homePath () `[static]`

bool QFSFileEngine::isRelativePath () const `[virtual]`

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

bool QFSFileEngine::link ( const QString & newName ) `[virtual]`

bool QFSFileEngine::mkdir ( const QString & name, bool createParentDirectories ) const `[virtual]`

bool QFSFileEngine::open ( QIODevice::OpenMode openMode ) `[virtual]`

QString QFSFileEngine::owner ( FileOwner own ) const `[virtual]`

uint QFSFileEngine::ownerId ( FileOwner own ) const `[virtual]`

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

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

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

bool QFSFileEngine::remove () `[virtual]`

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

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

QString QFSFileEngine::rootPath () `[static]`

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

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

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

bool QFSFileEngine::setPermissions ( uint perms ) `[virtual]`

bool QFSFileEngine::setSize ( qint64 size ) `[virtual]`

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

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

QString QFSFileEngine::tempPath () `[static]`

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