Класс QFileDevice

Класс QFileDevice предоставляет интерфейс для чтения из и записи в открытые файлы. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются перевходными.

Типы public

Public функции

Переопределенные public функции

• 43 public функции унаследованные от QIODevice
• 32 public функции унаследованные от QObject

Переопределенные protected функции

• 5 protected функции унаследованные от QIODevice
• 9 protected функции унаследованные от QObject

Дополнительные унаследованные члены

• 1 свойство унаследованное от QObject
• 1 public слот унаследованный от QObject
• 6 сигналов унаследованных от QIODevice
• 2 сигналов унаследованных от QObject
• 11 статических public членов унаследованных от QObject
• 5 protected функций унаследованных от QIODevice
• 9 protected функций унаследованных от QObject

Подробное описание

Класс QFileDevice предоставляет интерфейс для чтения из и записи в открытые файлы.

QFileDevice — базовый класс для устройств ввода-вывода, которые могут читать и записывать текстовые и двоичные файлы и ресурсы. QFile предлагает основную функциональность, QFileDevice служит базовым классом для совместного использования функциональности с другими устройствами файлов, такими как QTemporaryFile, предоставляя все операции, которые могут быть выполнены над файлами, открытыми с помощью QFile или QTemporaryFile.

См. также QFile и QTemporaryFile.

Документация по типам членов

Перечисление QFileDevice::FileError

Это перечисление описывает ошибки, которые могут быть возвращены функцией error().

enum QFileDevice::FileHandleFlagflags QFileDevice::FileHandleFlags

Этот перечисление используется при открытии файла для указания дополнительных параметров, которые применяются только к файлам, а не к общему QIODevice.

Тип FileHandleFlags является псевдонимом для QFlags<FileHandleFlag>. Он хранит логическое ИЛИ сочетание значений FileHandleFlag.

enum QFileDevice::MemoryMapFlags

Это перечисление описывает специальные параметры, которые могут быть использованы функцией map().

Это перечисление было введено или изменено в Qt 4.4.

enum QFileDevice::Permissionflags QFileDevice::Permissions

Это перечисление используется функцией permission() для отображения разрешений и владельца файла. Значения могут быть объединены с помощью операции OR для проверки нескольких разрешений и владельцев.

Предупреждение: Из-за различий в платформах, поддерживаемых Qt, семантика ReadUser, WriteUser и ExeUser зависит от платформы: в Unix возвращаются права владельца файла, а в Windows – права текущего пользователя. Это поведение может измениться в будущих версиях Qt.

Примечание: В файловых системах NTFS проверка владельца и разрешений отключена по умолчанию по соображениям производительности. Чтобы включить её, добавьте следующую строку:

extern Q_CORE_EXPORT int qt_ntfs_permission_lookup;

Затем проверка разрешений включается и отключается путём инкрементирования и декрементирования qt_ntfs_permission_lookup на 1.

qt_ntfs_permission_lookup++; // turn checking on
qt_ntfs_permission_lookup--; // turn it off again

Тип Permissions является псевдонимом для QFlags<Permission>. Он хранит логическое ИЛИ сочетание значений Permission.

Документация по функциям-членам

QFileDevice::~QFileDevice()

Уничтожает устройство файла, закрывая его при необходимости.

[virtual] bool QFileDevice::atEnd() const

Переопределено из QIODevice::atEnd().

Возвращает true, если достигнут конец файла; в противном случае возвращает false.

Для пустых обычных файлов в Unix (например, тех, что в /proc), эта функция возвращает true, так как файловая система сообщает, что размер такого файла равен 0. Поэтому не следует полагаться на atEnd() при чтении данных из такого файла, а вместо этого следует вызывать read(), пока больше данных не будет считано.

[virtual] void QFileDevice::close()

Переопределено из QIODevice::close().

Вызывает QFileDevice::flush() и закрывает файл. Ошибки из flush игнорируются.

См. также QIODevice::close().

FileError QFileDevice::error() const

Возвращает состояние ошибки файла.

Статус устройства ввода-вывода возвращает код ошибки. Например, если open() возвращает false, или операция чтения/записи возвращает -1, эту функцию можно вызвать, чтобы узнать причину, по которой операция завершилась неудачно.

См. также unsetError().

[virtual] QString QFileDevice::fileName() const

Возвращает имя файла. По умолчанию в QFileDevice возвращается пустая строка.

bool QFileDevice::flush()

Очищает все данные из буфера в файл. Возвращает true при успехе; в противном случае возвращает false.

int QFileDevice::handle() const

Возвращает дескриптор файла.

Это небольшое положительное целое число, подходящее для использования с функциями библиотеки C, такими как fdopen() и fcntl(). На системах, которые используют дескрипторы файлов для сокетов (т.е. системы Unix, но не Windows), дескриптор также можно использовать с QSocketNotifier.

Если файл не открыт или произошла ошибка, handle() возвращает -1.

См. также QSocketNotifier.

[virtual] bool QFileDevice::isSequential() const

Переопределено из QIODevice::isSequential().

Возвращает true если файл может обрабатываться только последовательно; в противном случае возвращает false.

Большинство файлов поддерживают произвольный доступ, но некоторые специальные файлы могут этого не делать.

См. также QIODevice::isSequential().

uchar *QFileDevice::map(qint64 offset, qint64 size, MemoryMapFlags flags = NoOptions)

Отображает size байтов файла в память, начиная с offset. Файл должен быть открыт для успешного отображения, но файл не должен оставаться открытым после отображения в памяти. При уничтожении QFile или открытии нового файла с этим объектом любые отображения, которые не были размапированы, будут автоматически размапированы.

Отображение будет иметь тот же режим открытия, что и файл (чтение и/или запись), за исключением использования MapPrivateOption, в этом случае запись в отображённую память всегда возможна.

Любые параметры отображения можно передать через flags.

Возвращает указатель на память или 0, если произошла ошибка.

См. также unmap().

[virtual] Permissions QFileDevice::permissions() const

Возвращает полное, объединённое операцией OR, сочетание QFile::Permission для файла.

См. также setPermissions().

[virtual] qint64 QFileDevice::pos() const

Переопределено из QIODevice::pos().

[virtual protected] qint64 QFileDevice::readData(char *data, qint64 len)

Переопределено из QIODevice::readData().

[virtual protected] qint64 QFileDevice::readLineData(char *data, qint64 maxlen)

Переопределено из QIODevice::readLineData().

[virtual] bool QFileDevice::resize(qint64 sz)

Устанавливает размер файла (в байтах) sz. Возвращает true если изменение размера прошло успешно; в противном случае — false. Если sz больше текущего размера файла, новые байты будут установлены в 0; если sz меньше, файл просто усекается.

Предупреждение: Эта функция может завершиться неудачей, если файл не существует.

См. также size().

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

Переопределено из QIODevice::seek().

Для устройств с произвольным доступом эта функция устанавливает текущую позицию в pos, возвращая true при успехе или false при возникновении ошибки. Для последовательных устройств поведение по умолчанию заключается в том, чтобы ничего не делать и возвращать false.

Переход за пределы файла: Если позиция выходит за пределы файла, seek() немедленно не расширит файл. Если производится запись в этой позиции, файл будет расширен. Содержимое файла между предыдущим концом файла и новыми данными НЕ ОПРЕДЕЛЕНО и зависит от платформы и файловой системы.

[virtual] bool QFileDevice::setPermissions(Permissions permissions)

Устанавливает разрешения для файла на заданные permissions. Возвращает true при успехе или false если разрешения не могут быть изменены.

Предупреждение: Эта функция не манипулирует ACL, что может ограничить ее эффективность.

См. также permissions().

[virtual] qint64 QFileDevice::size() const

Переопределено из QIODevice::size().

Возвращает размер файла.

Для пустых обычных файлов на Unix (например, тех, что в /proc), эта функция возвращает 0; содержимое такого файла генерируется по требованию при вызове read().

bool QFileDevice::unmap(uchar *address)

Разархивирует память address.

Возвращает true если разархивирование прошло успешно; в противном случае — false.

См. также map().

void QFileDevice::unsetError()

Устанавливает ошибку файла в QFileDevice::NoError.

См. также error().

[virtual protected] qint64 QFileDevice::writeData(const char *data, qint64 len)

Переопределено из QIODevice::writeData().