Тип QML StandardPaths

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

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

Методы

• строка displayName(тип)
• url findExecutable(имяИсполнимогоФайла, список<строка> пути)
• url locate(тип, строка имяФайла, LocateOptions параметры)
• список<url> locateAll(тип, строка имяФайла, LocateOptions параметры)
• void setTestModeEnabled(режимТестирования)
• список<url> standardLocations(тип)
• url writableLocation(тип)

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

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

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

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

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

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

строка displayName(тип)

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

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

url findExecutable(имяИсполнимогоФайла, список<строка> пути)

Находит исполняемый файл с именем имяИсполнимогоФайла в указанных путях или в системных путях, если пути пустые.

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

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

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

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

url locate(тип, строка имяФайла, LocateOptions параметры)

Находит файл или каталог с именем имяФайла в стандартных расположениях для типа.

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

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

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

список<url> locateAll(тип, строка имяФайла, LocateOptions параметры)

Находит все файлы или каталоги с именем имяФайла в стандартных расположениях для типа.

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

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

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

void setTestModeEnabled(режимТестирования)

Если режимТестирования равен 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/Application Support, кэш — в ~/.qttest/Cache, а конфигурация — в ~/.qttest/Preferences.

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

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

список<url> standardLocations(тип)

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

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

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

url writableLocation(тип)

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

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

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