Класс QTemporaryFile

Класс QTemporaryFile — это устройство ввода-вывода, работающее с временными файлами. Подробнее...

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

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

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

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

• 15 открытых функций унаследованных от QFile
• 16 открытых функций унаследованных от QFileDevice
• 33 открытых функций унаследованных от QIODevice
• 31 открытых функций унаследованных от QObject

Статические открытые члены

• 12 статических открытых членов унаследованных от QFile
• 11 статических открытых членов унаследованных от QObject

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

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

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

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

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

Класс QTemporaryFile — это устройство ввода-вывода, работающее с временными файлами.

QTemporaryFile используется для безопасного создания уникальных временных файлов. Сам файл создается при вызове open(). Имя временного файла гарантированно уникально (т.е. вы гарантированно не перезапишете существующий файл), и файл будет удалён при уничтожении объекта QTemporaryFile. Это важный приём, который предотвращает повреждение данных для приложений, хранящих данные во временных файлах. Имя файла либо генерируется автоматически, либо создаётся на основе шаблона, переданного в конструктор QTemporaryFile.

Пример:

    // Within a function/method...

    QTemporaryFile file;
    if (file.open()) {
        // file.fileName() returns the unique file name
    }

    // The QTemporaryFile destructor removes the temporary file
    // as it goes out of scope.

Переоткрытие QTemporaryFile после вызова close() безопасно. Пока объект QTemporaryFile не уничтожен, уникальный временный файл будет существовать и будет храниться открытым внутри QTemporaryFile.

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

Временный файл будет иметь статическую часть имени и часть, рассчитанную на уникальность. Имя файла по умолчанию будет определено из QCoreApplication::applicationName() (в противном случае qt_temp) и будет размещён в временной папке, возвращаемой QDir::tempPath(). Если вы указываете собственное имя файла, относительный путь к файлу по умолчанию не будет помещён во временную директорию, а будет относительным к текущей рабочей директории.

Указанные имена файлов могут содержать следующий шаблон XXXXXX (шесть заглавных символов "X"), которые будут заменены автоматически сгенерированной частью имени файла. Обратите внимание, что шаблон чувствителен к регистру. Если шаблон отсутствует в имени файла, QTemporaryFile добавляет сгенерированную часть к заданному имени файла.

См. также QDir::tempPath() и QFile.

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

QTemporaryFile::QTemporaryFile()

Создаёт QTemporaryFile с шаблоном файла, который является именем приложения, возвращаемым QCoreApplication::applicationName() (в противном случае qt_temp) за которым следует ".XXXXXX". Файл хранится во временной директории системы, QDir::tempPath().

См. также setFileTemplate() и QDir::tempPath().

QTemporaryFile::QTemporaryFile(const QString &templateName)

Создаёт QTemporaryFile с шаблоном имени файла templateName. При открытии временного файла это будет использоваться для создания уникального имени файла.

Если templateName не содержит XXXXXX, оно будет автоматически добавлено и использовано как динамическая часть имени файла.

Если templateName — относительный путь, путь будет относительным к текущей рабочей директории. Вы можете использовать QDir::tempPath(), чтобы сконструировать templateName, если вы хотите использовать временную директорию системы.

См. также open() и fileTemplate().

QTemporaryFile::QTemporaryFile(QObject *parent)

Создаёт QTemporaryFile (с заданным parent) с шаблоном файла, который является именем приложения, возвращаемым QCoreApplication::applicationName() (в противном случае qt_temp) за которым следует ".XXXXXX". Файл хранится во временной директории системы, QDir::tempPath().

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

QTemporaryFile::QTemporaryFile(const QString &templateName, QObject *parent)

Создаёт QTemporaryFile с шаблоном имени файла templateName и указанным parent. При открытии временного файла это будет использоваться для создания уникального имени файла.

Если templateName не содержит XXXXXX, оно будет автоматически добавлено и использовано как динамическая часть имени файла.

Если templateName — относительный путь, путь будет относительным к текущей рабочей директории. Вы можете использовать QDir::tempPath(), чтобы сконструировать templateName, если вы хотите использовать временную директорию системы.

См. также open() и fileTemplate().

QTemporaryFile::~QTemporaryFile()

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

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

bool QTemporaryFile::autoRemove() const

Возвращает true, если QTemporaryFile находится в режиме автоматического удаления. Режим автоматического удаления автоматически удалит имя файла из диска при уничтожении. Это очень удобно для создания объекта QTemporaryFile на стеке, заполнения его данными, чтения из него, а затем автоматической очистки после возврата из функции.

Режим автоматического удаления включен по умолчанию.

См. также setAutoRemove() и remove().

[static] QTemporaryFile *QTemporaryFile::createNativeFile(QFile &file)

Если file не является уже родным файлом, то создается QTemporaryFile в QDir::tempPath(), содержимое file копируется в него, и возвращается указатель на временный файл. Ничего не делает и возвращает 0 если file уже является родным файлом.

Например:

QFile f(":/resources/file.txt");
QTemporaryFile::createNativeFile(f); // Returns a pointer to a temporary file

QFile f("/users/qt/file.txt");
QTemporaryFile::createNativeFile(f); // Returns 0

См. также QFileInfo::isNativePath().

[static] QTemporaryFile *QTemporaryFile::createNativeFile(const QString &fileName)

Это перегруженная функция.

Работает с заданным fileName вместо существующего объекта QFile.

[virtual] QString QTemporaryFile::fileName() const

Переопределено из QFileDevice::fileName().

Возвращает полное уникальное имя файла, на котором базируется объект QTemporaryFile. Эта строка равна null до открытия QTemporaryFile, после этого она будет содержать fileTemplate() плюс дополнительные символы, чтобы сделать его уникальным.

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

QString QTemporaryFile::fileTemplate() const

Возвращает установленную шаблон файла. Шаблон файла по умолчанию называется qcoreappname.XXXXXX и находится в QDir::tempPath().

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

bool QTemporaryFile::open()

QTemporaryFile всегда будет открываться в режиме QIODevice::ReadWrite, это позволяет легко получить доступ к данным в файле. Эта функция возвращает true при успехе и устанавливает fileName() в уникальное имя файла.

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

[virtual protected] bool QTemporaryFile::open(OpenMode flags)

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

Создаёт уникальное имя файла для временного файла и открывает его. Уникальное имя можно получить позже, вызвав fileName(). Файл гарантированно создан этой функцией (т.е. он никогда ранее не существовал).

void QTemporaryFile::setAutoRemove(bool b)

Устанавливает QTemporaryFile в режим автоматического удаления, если b равно true.

Режим автоматического удаления включен по умолчанию.

См. также autoRemove() и remove().

void QTemporaryFile::setFileTemplate(const QString &name)

Устанавливает статическую часть имени файла на name. Если шаблон файла содержит XXXXXX, он автоматически заменяется уникальной частью имени файла, в противном случае имя файла определяется автоматически на основе указанной статической части.

Если name содержит относительный путь к файлу, путь будет относительным к текущей рабочей директории. Можно использовать QDir::tempPath() для построения name, если требуется использовать временную директорию системы.

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