Тип QML StandardPaths

Предоставляет доступ к стандартным системным путям. Подробнее...

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

Методы

• строка displayName(StandardLocation type)
• url findExecutable(строка executableName, список<строка> paths)
• url locate(StandardLocation type, строка fileName, LocateOptions options)
• список<url> locateAll(StandardLocation type, строка fileName, LocateOptions options)
• void setTestModeEnabled(булево testMode)
• список<url> standardLocations(StandardLocation type)
• url writableLocation(StandardLocation type)

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

Тип синглетона StandardPaths предоставляет методы для запроса стандартных системных путей. Стандартные пути в основном полезны в сочетании с типами FileDialog и FolderDialog.

FileDialog {
    folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation)
}

Примечание: Типы в модулях Qt.labs не гарантируют сохранение совместимости в будущих версиях.

См. также FileDialog, FolderDialog и QStandardPaths.

Документация по методам

строка displayName(StandardLocation type)

Возвращает локализованное имя для отображения данного расположения type или пустую QString, если соответствующее расположение не найдено.

См. также QStandardPaths::displayName().

url findExecutable(строка executableName, список<строка> paths)

Ищет исполняемый файл с именем executableName в указанных paths или системных путях, если paths пустой.

В большинстве операционных систем системный путь определяется переменной окружения PATH. Каталоги, где следует искать исполняемый файл, могут быть заданы в аргументе paths. Чтобы искать как в собственных путях, так и в системных путях, вызовите findExecutable дважды, один раз с заданными paths и один раз с пустыми paths. Символьные ссылки не разрешаются, чтобы сохранить поведение в случае исполняемых файлов, поведение которых зависит от имени, с которым они вызываются.

Примечание: В Windows автоматически добавляются обычные расширения исполняемых файлов (из переменной окружения PATHEXT). Например, вызов findExecutable("foo") находит foo.exe или foo.bat при наличии.

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

См. также QStandardPaths::findExecutable().

url locate(StandardLocation type, строка fileName, LocateOptions options)

Ищет файл или каталог с именем fileName в стандартных расположениях для type.

Флаг options позволяет указать, ищется ли файл или каталог. По умолчанию этот флаг имеет значение LocateFile.

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

См. также QStandardPaths::locate().

список<url> locateAll(StandardLocation type, строка fileName, LocateOptions options)

Ищет все файлы или каталоги с именем fileName в стандартных расположениях для type.

Флаг options позволяет указать, ищется ли файл или каталог. По умолчанию этот флаг имеет значение LocateFile.

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

См. также QStandardPaths::locateAll().

void setTestModeEnabled(булево testMode)

Если testMode имеет значение true, это включает специальный «режим тестирования» в QStandardPaths, который изменяет расположения для записи на указание тестовых каталогов. Это предотвращает чтение или запись автотестами в текущую конфигурацию пользователя.

Это влияет на расположения, в которые тестовые программы могут записывать файлы: GenericDataLocation, AppDataLocation, ConfigLocation, GenericConfigLocation, AppConfigLocation, GenericCacheLocation, и CacheLocation. Другие расположения не затронуты.

В Unix XDG_DATA_HOME устанавливается в ~/.qttest/share, XDG_CONFIG_HOME устанавливается в ~/.qttest/config, и XDG_CACHE_HOME устанавливается в ~/.qttest/cache.

В macOS данные попадают в ~/.qttest/Application Support, кэш — в ~/.qttest/Cache, а конфигурация — в ~/.qttest/Preferences.

В Windows все попадает в каталог «qttest» в %APPDATA%.

См. также QStandardPaths::setTestModeEnabled().

список<url> standardLocations(StandardLocation type)

Возвращает все каталоги, к которым относятся файлы типа type.

Список каталогов отсортирован по приоритету сверху вниз, начиная с writableLocation(), если это можно определить. Этот список пустой, если для типа не определено никаких расположений.

См. также QStandardPaths::standardLocations().

url writableLocation(StandardLocation type)

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

Примечание: Возвращаемое расположение хранилища может не существовать; то есть его может потребоваться создать системе или пользователю.

См. также QStandardPaths::writableLocation().