Класс QStandardPaths
Класс QStandardPaths предоставляет методы для доступа к стандартным путям. Подробнее...
| Заголовок: | #include <QStandardPaths> |
| qmake: | QT += core |
| С тех пор: | Qt 5.0 |
Открытые типы
| Перечисление | LocateOption { LocateFile, LocateDirectory } |
| флаги | LocateOptions |
| Перечисление | StandardLocation { DesktopLocation, DocumentsLocation, FontsLocation, ApplicationsLocation, ..., AppConfigLocation } |
Статические открытые члены
| QString | displayName(StandardLocation type) |
| QString | findExecutable(const QString &executableName, const QStringList &paths = QStringList()) |
| QString | locate(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile) |
| QStringList | locateAll(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile) |
| void | setTestModeEnabled(bool testMode) |
| QStringList | standardLocations(StandardLocation type) |
| QString | writableLocation(StandardLocation type) |
Подробное описание
Класс QStandardPaths предоставляет методы для доступа к стандартным путям.
Этот класс содержит функции для запроса стандартных расположений на локальной файловой системе, для общих задач, таких как каталоги, относящиеся к конкретному пользователю, или системные каталоги конфигурации.
Документация по типам членов
Перечисление QStandardPaths::LocateOptionфлаги QStandardPaths::LocateOptions
Это перечисление описывает различные флаги, которые могут быть использованы для управления поведением QStandardPaths::locate и QStandardPaths::locateAll.
| Константа | Значение | Описание |
|---|---|---|
QStandardPaths::LocateFile |
0x0 |
возвращает только файлы |
QStandardPaths::LocateDirectory |
0x1 |
возвращает только каталоги |
Тип LocateOptions является типом-синонимом для QFlags<LocateOption>. Он хранит логическое ИЛИ сочетание значений LocateOption.
Перечисление QStandardPaths::StandardLocation
Это перечисление описывает различные расположения, которые можно запросить с помощью методов, таких как QStandardPaths::writableLocation, QStandardPaths::standardLocations и QStandardPaths::displayName.
Некоторые значения в этом перечислении представляют конфигурацию пользователя. Такие значения перечисления будут возвращать одни и те же пути в различных приложениях, поэтому они могут использоваться для совместного использования данных с другими приложениями. Другие значения специфичны для этого приложения. Каждое значение перечисления в таблице ниже описывает, является ли оно специфичным для приложения или универсальным.
Должно предполагаться, что каталоги, специфичные для приложения, недоступны для других приложений. Поэтому файлы, размещенные там, могут быть нечитаемыми для других приложений, даже если они запущены одним и тем же пользователем. С другой стороны, универсальные каталоги должны предполагаться доступными для всех приложений, запущенных этим пользователем, но все же должны предполагаться недоступными для приложений других пользователей.
Обмен данными с другими пользователями выходит за рамки QStandardPaths.
END_OF_DOCUMENT_MARKER| Константа | Значение | Описание |
|---|---|---|
QStandardPaths::DesktopLocation |
0 |
Возвращает каталог рабочего стола пользователя. Это общее значение. На системах без понятия о рабочем столе. |
QStandardPaths::DocumentsLocation |
1 |
Возвращает каталог, содержащий файлы документов пользователя. Это общее значение. Возвращаемый путь никогда не пустой. |
QStandardPaths::FontsLocation |
2 |
Возвращает каталог, содержащий шрифты пользователя. Это общее значение. Обратите внимание, что установка шрифтов может потребовать дополнительных операций, специфичных для платформы. |
QStandardPaths::ApplicationsLocation |
3 |
Возвращает каталог, содержащий приложения пользователя (исполняемые файлы, пакеты приложений или ярлыки к ним). Это общее значение. Обратите внимание, что установка приложений может потребовать дополнительных операций, специфичных для платформы. Файлы, папки или ярлыки в этом каталоге зависят от платформы. |
QStandardPaths::MusicLocation |
4 |
Возвращает каталог, содержащий музыку или другие аудиофайлы пользователя. Это общее значение. Если каталог, специфичный для музыкальных файлов, не существует, возвращается подходящий резервный каталог для хранения документов пользователя. |
QStandardPaths::MoviesLocation |
5 |
Возвращает каталог, содержащий фильмы и видео пользователя. Это общее значение. Если каталог, специфичный для файлов фильмов, не существует, возвращается подходящий резервный каталог для хранения документов пользователя. |
QStandardPaths::PicturesLocation |
6 |
Возвращает каталог, содержащий изображения или фотографии пользователя. Это общее значение. Если каталог, специфичный для файлов изображений, не существует, возвращается подходящий резервный каталог для хранения документов пользователя. |
QStandardPaths::TempLocation |
7 |
Возвращает каталог, в котором могут храниться временные файлы. Возвращаемое значение может быть специфичным для приложения, общим для других приложений для данного пользователя или даже для всей системы. Возвращаемый путь никогда не пустой. |
QStandardPaths::HomeLocation |
8 |
Возвращает домашний каталог пользователя (то же, что и QDir::homePath()). В системах Unix это равно переменной среды HOME. Это значение может быть общим или специфичным для приложения, но возвращаемый путь никогда не пустой. |
QStandardPaths::DataLocation |
9 |
Возвращает то же значение, что и AppLocalDataLocation. Это значение перечисления устарело. Рекомендуется использовать AppDataLocation, поскольку на Windows предпочтительнее путь roaming. |
QStandardPaths::CacheLocation |
10 |
Возвращает расположение каталога, куда следует записывать пользовательские неосновные (кешированные) данные. Это каталог, специфичный для приложения. Возвращаемый путь никогда не пустой. |
QStandardPaths::GenericCacheLocation |
15 |
Возвращает расположение каталога, куда следует записывать пользовательские неосновные (кешированные) данные, общие для приложений. Это общее значение. Обратите внимание, что возвращаемый путь может быть пустым, если система не поддерживает понятие общего кеша. |
QStandardPaths::GenericDataLocation |
11 |
Возвращает расположение каталога, где можно хранить постоянные данные, общие для приложений. Это общее значение. Возвращаемый путь никогда не пустой. |
QStandardPaths::RuntimeLocation |
12 |
Возвращает расположение каталога, куда следует записывать файлы для коммуникации во время работы, например, Unix локальные сокеты. Это общее значение. Возвращаемый путь может быть пустым на некоторых системах. |
QStandardPaths::ConfigLocation |
13 |
Возвращает расположение каталога, куда следует записывать пользовательские конфигурационные файлы. Это может быть общее значение или специфичное для приложения, и возвращаемый путь никогда не пустой. |
QStandardPaths::DownloadLocation |
14 |
Возвращает каталог для загруженных файлов пользователя. Это общее значение. Если каталог, специфичный для загрузок, не существует, возвращается подходящий резервный каталог для хранения документов пользователя. |
QStandardPaths::GenericConfigLocation |
16 |
Возвращает расположение каталога, куда следует записывать пользовательские конфигурационные файлы, общие между несколькими приложениями. Это общее значение, и возвращаемый путь никогда не пустой. |
QStandardPaths::AppDataLocation |
17 |
Возвращает расположение каталога, где можно хранить постоянные данные приложения. Это каталог, специфичный для приложения. Для получения пути для хранения данных, которые нужно обмениваться с другими приложениями, используйте QStandardPaths::GenericDataLocation. Возвращаемый путь никогда не пустой. В операционной системе Windows возвращается путь roaming. Это значение перечисления было добавлено в Qt 5.4. |
QStandardPaths::AppLocalDataLocation |
DataLocation |
Возвращает путь к локальным настройкам в операционной системе Windows. На всех остальных платформах возвращает то же значение, что и AppDataLocation. Это значение перечисления было добавлено в Qt 5.4. |
QStandardPaths::AppConfigLocation |
18 |
Возвращает расположение каталога, куда следует записывать пользовательские конфигурационные файлы. Это каталог, специфичный для приложения, и возвращаемый путь никогда не пустой. Это значение перечисления было добавлено в Qt 5.5. |
В следующей таблице приведены примеры путей в различных операционных системах. Первый путь — это записываемый путь (если не указано иное). Другие дополнительные пути, если таковые имеются, представляют собой не-записываемые расположения.
| Тип пути | macOS | Windows |
|---|---|---|
| DesktopLocation | "~/Desktop" | "C:/Users/<USER>/Desktop" |
| DocumentsLocation | "~/Documents" | "C:/Users/<USER>/Documents" |
| FontsLocation | "/System/Library/Fonts" (не записываемый) | "C:/Windows/Fonts" (не записываемый) |
| ApplicationsLocation | "/Applications" (не записываемый) | "C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs" |
| MusicLocation | "~/Music" | "C:/Users/<USER>/Music" |
| MoviesLocation | "~/Movies" | "C:/Users/<USER>/Videos" |
| PicturesLocation | "~/Pictures" | "C:/Users/<USER>/Pictures" |
| TempLocation | случайно генерируется ОС | "C:/Users/<USER>/AppData/Local/Temp" |
| HomeLocation | "~" | "C:/Users/<USER>" |
| DataLocation | "~/Library/Application Support/<APPNAME>", "/Library/Application Support/<APPNAME>". "<APPDIR>/../Resources" | "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>", "<APPDIR>", "<APPDIR>/data" |
| CacheLocation | "~/Library/Caches/<APPNAME>", "/Library/Caches/<APPNAME>" | "C:/Users/<USER>/AppData/Local/<APPNAME>/cache" |
| GenericDataLocation | "~/Library/Application Support", "/Library/Application Support" | "C:/Users/<USER>/AppData/Local", "C:/ProgramData", "<APPDIR>", "<APPDIR>/data" |
| RuntimeLocation | "~/Library/Application Support" | "C:/Users/<USER>" |
| ConfigLocation | "~/Library/Preferences" | "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>" |
| GenericConfigLocation | "~/Library/Preferences" | "C:/Users/<USER>/AppData/Local", "C:/ProgramData" |
| DownloadLocation | "~/Downloads" | "C:/Users/<USER>/Documents" |
| GenericCacheLocation | "~/Library/Caches", "/Library/Caches" | "C:/Users/<USER>/AppData/Local/cache" |
| AppDataLocation | "~/Library/Application Support/<APPNAME>", "/Library/Application Support/<APPNAME>". "<APPDIR>/../Resources" | "C:/Users/<USER>/AppData/Roaming/<APPNAME>", "C:/ProgramData/<APPNAME>", "<APPDIR>", "<APPDIR>/data" |
| AppLocalDataLocation | "~/Library/Application Support/<APPNAME>", "/Library/Application Support/<APPNAME>". "<APPDIR>/../Resources" | "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>", "<APPDIR>", "<APPDIR>/data" |
| AppConfigLocation | "~/Library/Preferences/<APPNAME>" | "C:/Users/<USER>/AppData/Local/<APPNAME>", "C:/ProgramData/<APPNAME>" |
| Тип пути | Linux |
|---|---|
| DesktopLocation | "~/Рабочий стол" |
| DocumentsLocation | "~/Документы" |
| FontsLocation | "~/.шрифты" |
| ApplicationsLocation | "~/.local/share/приложения", "/usr/local/share/приложения", "/usr/share/приложения" |
| MusicLocation | "~/Музыка" |
| MoviesLocation | "~/Видео" |
| PicturesLocation | "~/Изображения" |
| TempLocation | "/tmp" |
| HomeLocation | "~" |
| DataLocation | "~/.local/share/<APPNAME>", "/usr/local/share/<APPNAME>", "/usr/share/<APPNAME>" |
| CacheLocation | "~/.cache/<APPNAME>" |
| GenericDataLocation | "~/.local/share", "/usr/local/share", "/usr/share" |
| RuntimeLocation | "/run/user/<USER>" |
| ConfigLocation | "~/.config", "/etc/xdg" |
| GenericConfigLocation | "~/.config", "/etc/xdg" |
| DownloadLocation | "~/Загрузки" |
| GenericCacheLocation | "~/.cache" |
| AppDataLocation | "~/.local/share/<APPNAME>", "/usr/local/share/<APPNAME>", "/usr/share/<APPNAME>" |
| AppLocalDataLocation | "~/.local/share/<APPNAME>", "/usr/local/share/<APPNAME>", "/usr/share/<APPNAME>" |
| AppConfigLocation | "~/.config/<APPNAME>", "/etc/xdg/<APPNAME>" |
| Тип пути | Android | iOS |
|---|---|---|
| DesktopLocation | "<APPROOT>/files" | "<APPROOT>/Документы/Рабочий стол" |
| DocumentsLocation | "<USER>/Документы", "<USER>/<APPNAME>/Документы" | "<APPROOT>/Документы" |
| FontsLocation | "/system/шрифты" (не изменяемый) | "<APPROOT>/Library/Шрифты" |
| ApplicationsLocation | не поддерживается (директория не читается) | не поддерживается |
| MusicLocation | "<USER>/Музыка", "<USER>/<APPNAME>/Музыка" | "<APPROOT>/Документы/Музыка" |
| MoviesLocation | "<USER>/Фильмы", "<USER>/<APPNAME>/Фильмы" | "<APPROOT>/Документы/Фильмы" |
| PicturesLocation | "<USER>/Изображения", "<USER>/<APPNAME>/Изображения" | "<APPROOT>/Документы/Изображения", "assets-library://" |
| TempLocation | "<APPROOT>/кеш" | "<APPROOT>/временно" |
| HomeLocation | "<APPROOT>/файлы" | "<APPROOT>" (не изменяемый) |
| DataLocation | "<APPROOT>/файлы", "<USER>/<APPNAME>/файлы" | "<APPROOT>/Library/Поддержка приложения" |
| CacheLocation | "<APPROOT>/кеш", "<USER>/<APPNAME>/кеш" | "<APPROOT>/Library/Кэши" |
| GenericDataLocation | "<USER>" | "<APPROOT>/Документы" |
| RuntimeLocation | "<APPROOT>/кеш" | не поддерживается |
| ConfigLocation | "<APPROOT>/файлы/настройки" | "<APPROOT>/Library/Настройки" |
| GenericConfigLocation | "<APPROOT>/файлы/настройки" (нет общих настроек) | "<APPROOT>/Library/Настройки" |
| DownloadLocation | "<USER>/Загрузки", "<USER>/<APPNAME>/Загрузки" | "<APPROOT>/Документы/Загрузки" |
| GenericCacheLocation | "<APPROOT>/кеш" (нет общего кэша) | "<APPROOT>/Library/Кэши" |
| AppDataLocation | "<APPROOT>/файлы", "<USER>/<APPNAME>/файлы" | "<APPROOT>/Library/Поддержка приложения" |
| AppConfigLocation | "<APPROOT>/файлы/настройки" | "<APPROOT>/Library/Настройки/<APPNAME>" |
| AppLocalDataLocation | "<APPROOT>/файлы", "<USER>/<APPNAME>/файлы" | "<APPROOT>/Library/Поддержка приложения" |
В таблице выше, <APPNAME> обычно является именем организации, именем приложения или обоими, или уникальным именем, сгенерированным при упаковке. Аналогично, <APPROOT> - это место, где установлено это приложение (часто виртуальная машина). <APPDIR> - это каталог, содержащий исполняемый файл приложения.
Не следует полагаться на указанные выше пути, так как они могут изменяться в зависимости от конфигурации ОС, региональных настроек или могут измениться в будущих версиях Qt.
Примечание: На Android приложения с открытыми файлами на внешнем хранилище (<USER> расположения) будут закрыты, если внешнее хранилище будет отмонтировано.
Примечание: На iOS, если вы передадите QStandardPaths::standardLocations(QStandardPaths::PicturesLocation).last() в качестве аргумента QFileDialog::setDirectory(), будет использоваться собственный диалог выбора изображения для доступа к фотоальбому пользователя. Имя файла, возвращаемое, может быть загружено с помощью QFile и связанных API. Эта функция была добавлена в Qt 5.5.
См. также writableLocation(), standardLocations(), displayName(), locate(), и locateAll().
Документация по членам-функциям
[static] QString QStandardPaths::displayName(StandardLocation type)
Возвращает локализованное отображаемое имя для заданного типа расположения type или пустую QString, если соответствующее расположение не найдено.
[static] QString QStandardPaths::findExecutable(const QString &executableName, const QStringList &paths = QStringList())
Ищет исполняемый файл с именем executableName в путях, указанных в paths, или в системных путях, если paths пустое.
На большинстве операционных систем системный путь определяется переменной окружения PATH.
Каталоги, в которых следует искать исполняемый файл, могут быть заданы в аргументе paths. Для поиска как в ваших собственных путях, так и в системных путях, вызовите findExecutable дважды, один раз с заданным paths и один раз с пустым paths.
Символические ссылки не разрешаются, чтобы сохранить поведение в случае исполняемых файлов, поведение которых зависит от имени, с которым они вызываются.
Примечание: В Windows обычно к исполняемым файлам добавляются расширения (из переменной окружения PATHEXT), поэтому, например, findExecutable("foo") найдет foo.exe или foo.bat, если они есть.
Возвращает абсолютный путь к исполняемому файлу или пустую строку, если он не найден.
[static] QString QStandardPaths::locate(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile)
Пытается найти файл или каталог с именем fileName в стандартных расположениях для type.
Возвращается полный путь к первому найденному файлу или каталогу (в зависимости от options). Если такой файл или каталог не найден, возвращается пустая строка.
[static] QStringList QStandardPaths::locateAll(StandardLocation type, const QString &fileName, LocateOptions options = LocateFile)
Пытается найти все файлы или каталоги с именем fileName в стандартных расположениях для type.
Флаг options позволяет указать, следует ли искать файлы или каталоги.
Возвращает список всех найденных файлов.
[static] void QStandardPaths::setTestModeEnabled(bool testMode)
Если testMode имеет значение true, это включает специальный «режим тестирования» в QStandardPaths, который изменяет расположения для записи на тестовые каталоги, чтобы предотвратить чтение или запись в текущие настройки пользователя в ходе автотестов.
Это влияет на расположения, в которые тестовые программы могут записывать файлы: GenericDataLocation, DataLocation, ConfigLocation, GenericConfigLocation, AppConfigLocation, GenericCacheLocation, CacheLocation. Другие расположения не затронуты.
В Unix XDG_DATA_HOME устанавливается в ~/.qttest/share, XDG_CONFIG_HOME устанавливается в ~/.qttest/config, а XDG_CACHE_HOME устанавливается в ~/.qttest/cache.
В macOS данные сохраняются в ~/.qttest/Поддержка приложения, кэш сохраняется в ~/.qttest/Кэш, а настройки сохраняются в ~/.qttest/Настройки.
В Windows всё сохраняется в каталог «qttest» в каталоге «Данные приложений».
[static] QStringList QStandardPaths::standardLocations(StandardLocation type)
Возвращает все каталоги, где находятся файлы типа type.
Список каталогов отсортирован по убыванию приоритета, начиная с writableLocation() , если он может быть определен. Этот список пуст, если не определены места расположения для типа type.
См. также writableLocation().
[static] QString QStandardPaths::writableLocation(StandardLocation type)
Возвращает каталог, в который следует записывать файлы типа type, или пустую строку, если местоположение не может быть определено.
Примечание: Место хранения, возвращаемое значением, может быть каталогом, который не существует; т.е. его может потребоваться создать системе или пользователю.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qstandardpaths.html
