Spec-Zone.ru › Qt 5.15

Класс QTemporaryDir

Класс QTemporaryDir создаёт уникальную директорию для временного использования. Подробнее...

Заголовок: #include <QTemporaryDir>
qmake: QT += core
  • Список всех членов, включая унаследованные

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

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

QTemporaryDir(const QString &templatePath)
QTemporaryDir()
~QTemporaryDir()
bool autoRemove() const
QString errorString() const
QString filePath(const QString &fileName) const
bool isValid() const
QString path() const
bool remove()
void setAutoRemove(bool b)

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

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

Пример:

    // Within a function/method...

    QTemporaryDir dir;
    if (dir.isValid()) {
        // dir.path() returns the unique directory path
    }

    // The QTemporaryDir destructor removes the temporary directory
    // as it goes out of scope.

Очень важно проверить, что временная директория может быть создана, используя isValid(). Не используйте exists(), так как QDir по умолчанию представляет текущую директорию, которая существует.

Путь к временной директории можно найти, вызвав path().

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

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

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

QTemporaryDir::QTemporaryDir(const QString &templatePath)

Создаёт QTemporaryDir с шаблоном templatePath.

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

Если templatePath заканчивается на XXXXXX, она будет использоваться как динамическая часть имени директории, в противном случае она будет добавлена. В отличие от QTemporaryFile, XXXXXX посредине строки шаблона не поддерживается.

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

QTemporaryDir::QTemporaryDir()

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

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

QTemporaryDir::~QTemporaryDir()

Уничтожает объект временной директории. Если был установлен режим автоматического удаления, директория будет автоматически удалена, включая всё её содержимое.

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

bool QTemporaryDir::autoRemove() const

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

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

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

QString QTemporaryDir::errorString() const

Если isValid() возвращает false, эта функция возвращает строку ошибки, объясняющую, почему создание временной директории не удалось. В противном случае эта функция возвращает пустую строку.

Эта функция была добавлена в Qt 5.6.

QString QTemporaryDir::filePath(const QString &fileName) const

Возвращает имя пути к файлу во временной директории. Не проверяет, действительно ли файл существует в директории. Избыточные несколько разделителей или каталоги "." и ".." в fileName не удаляются (см. QDir::cleanPath()). Абсолютные пути не допускаются.

Эта функция была добавлена в Qt 5.9.

bool QTemporaryDir::isValid() const

Возвращает true, если QTemporaryDir был создан успешно.

QString QTemporaryDir::path() const

Возвращает путь к временной директории. Пустая строка, если QTemporaryDir не смог быть создан.

bool QTemporaryDir::remove()

Удаляет временную директорию, включая всё её содержимое.

Возвращает true если удаление прошло успешно.

void QTemporaryDir::setAutoRemove(bool b)

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

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qtemporarydir.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API