Класс QFileDevice

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

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

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

Открытые типы

Открытые функции

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

• 33 открытые функции, унаследованные от QIODevice
• 31 открытые функции, унаследованные от QObject

Переопределенные защищенные функции

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

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

• 1 свойство унаследовано от QObject
• 1 публичный слот унаследован от QObject
• 4 сигнала унаследованы от QIODevice
• 2 сигнала унаследованы от QObject
• 11 статических публичных членов унаследованы от QObject
• 5 защищенных функций унаследованы от QIODevice
• 9 защищенных функций унаследованы от QObject

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

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

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

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

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

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

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

перечисление QFileDevice::FileHandleFlagфлаги QFileDevice::FileHandleFlags

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

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

enum QFileDevice::MemoryMapFlags

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

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

enum QFileDevice::Permissionflags QFileDevice::Permissions

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

Предупреждение: Из-за различий в платформах, поддерживаемых 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.

Эта функция не поддерживается на Windows CE.

См. также QSocketNotifier.

[virtual] bool QFileDevice::isSequential() const

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

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

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

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

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

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

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

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

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

Примечание: На Windows CE 5.0 файл будет закрыт перед картированием.

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

[virtual] Permissions QFileDevice::permissions() const

Возвращает полную объединенную комбинацию 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().