Тип QML StandardPaths

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

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

Методы

• строка displayName(StandardLocation type)
• url findExecutable(строка executableName, список<строка> paths)
• url locate(StandardLocation type, строка fileName, LocateOptions options)
• список<url> locateAll(StandardLocation type, строка fileName, LocateOptions options)
• пустое 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().

пустое 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().