Typedef for QFlags<FileHandleFlag>. Refer to QFileDevice::FileHandleFlag for documentation.

Typedef for QFlags<Permission>. Refer to QFileDevice::Permissions for documentation.

This enum describes the errors that may be returned by error().

This enum is used when opening a file to specify additional options which only apply to files and not to a generic QIODevice.

This enum describes special options that may be used by the map() method.

This enum is used by the permission() function to report the permissions and ownership of a file. The values may be OR-ed together to test multiple permissions and ownership values.

Because of differences in the platforms supported by CopperSpice the semantics of ReadUser, WriteUser and ExeUser are platform dependent.

On Unix, the rights of the owner of the file are returned and on Windows the rights of the current user are returned. On NTFS file systems ownership and permissions checking is disabled by default for performance reasons. To enable it include the following line.

Permission checking is then turned on and off by incrementing and decrementing qt_ntfs_permission_lookup by 1.

Destroys the file device, closing it if necessary.

Returns true if the end of the file has been reached, otherwise returns false.

For regular empty files on Unix (e.g. those in /proc), this function returns true, since the file system reports that the size of such a file is 0. Therefore, you should not depend on atEnd() when reading data from such a file, but rather call read() until no more data can be read.

Reimplemented from QIODevice::atEnd()

Calls QFileDevice::flush() and closes the file. Errors from flush are ignored.

See also

QIODevice::close()

Reimplemented from QIODevice::close()

Returns the file error status.

The I/O device status returns an error code. For example, if open() returns false, or a read/write operation returns -1, this function can be called to find out the reason why the operation failed.

See also

unsetError()

Returns the name of the file. The default implementation in QFileDevice returns a null string.

Reimplemented in QTemporaryFile::fileName(), QSaveFile::fileName(), QFile::fileName()

Flushes any buffered data to the file. Returns true if successful, otherwise returns false.

Returns the file handle of the file. This is a small positive integer, suitable for use with C library functions such as fdopen() and fcntl(). If the file is not open, or there is an error, handle() returns -1.

On systems that use file descriptors for sockets (i.e. Unix systems, but not Windows) the handle can be used with QSocketNotifier as well.

See also

QSocketNotifier

Returns true if the file can only be manipulated sequentially, otherwise returns false. Most files support random-access, but some special files may not.

See also

QIODevice::isSequential()

Reimplemented from QIODevice::isSequential()

Maps size bytes of the file into memory starting at offset. Returns a pointer to the memory or a nullptr if there is an error.

A file should be open for a map to succeed but the file does not need to stay open after the memory has been mapped. When the QFile is destroyed or a new file is opened with this object, any maps that have not been unmapped will automatically be unmapped. Any mapping options can be passed through flags.

See also

unmap()

Returns the complete OR-ed together combination of QFile::Permission for the file.

See also

setPermissions()

Reimplemented in QFile::permissions()

Reimplemented from QIODevice::pos()

Implements QIODevice::readData()

Reimplemented from QIODevice::readLineData()

Sets the file size (in bytes) size. Returns true if the file if the resize succeeds,false otherwise. If size is larger than the file currently is the new bytes will be set to 0, if size is smaller the file is simply truncated.

See also

size()

Reimplemented in QFile::resize()

For random-access devices, this method sets the current position to pos returning true on success, or false if an error occurred. For sequential devices, the default behavior is to do nothing and return false.

Seeking beyond the end of a file: If the position is beyond the end of a file, then seek() shall not immediately extend the file. If a write is performed at this position, then the file shall be extended. The content of the file between the previous end of file and the newly written data is UNDEFINED and varies between platforms and file systems.

Reimplemented from QIODevice::seek()

Sets the permissions for the file to the permissionSpec specified. Returns true if successful, or false if the permissions can not be modified.

See also

permissions()

Reimplemented in QFile::setPermissions()

Returns the size of the file. For regular empty files on Unix (e.g. those in /proc), this function returns 0; the contents of such a file are generated on demand in response to you calling read().

Reimplemented from QIODevice::size()

Unmaps the memory address. Returns true if the unmap succeeds, false otherwise.

See also

map()

Sets the file error to QFileDevice::NoError.

See also

error()

Implements QIODevice::writeData()

Reimplemented in QSaveFile::writeData()