Spec-Zone.ru › Qt

Тип QML StandardPaths

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

Оператор импорта: import Qt.labs.platform
С версии: Qt 5.8
Наследует:

QtObject

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

Методы

  • строка displayName(СтандартноеМестоПоложения type)
  • url findExecutable(строка executableName, список<строка> paths)
  • url locate(СтандартноеМестоПоложения type, строка fileName, ПараметрыПоиска options)
  • список<url> locateAll(СтандартноеМестоПоложения type, строка fileName, ПараметрыПоиска options)
  • void setTestModeEnabled(булево testMode)
  • список<url> standardLocations(СтандартноеМестоПоложения type)
  • url writableLocation(СтандартноеМестоПоложения type)

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

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

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

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

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

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

строка displayName(СтандартноеМестоПоложения 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(СтандартноеМестоПоложения type, строка fileName, ПараметрыПоиска options)

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

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

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

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

список<url> locateAll(СтандартноеМестоПоложения type, строка fileName, ПараметрыПоиска 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(СтандартноеМестоПоложения type)

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

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

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

url writableLocation(СтандартноеМестоПоложения type)

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

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qml-qt-labs-platform-standardpaths.html

Spec-Zone.ru

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