StandardPaths QML Type

Provides access to the standard system paths. 更多...

导入语句: import Qt.labs.platform 1.1
Since: Qt 5.8
继承:

QtObject

方法

详细描述

The StandardPaths singleton type provides methods for querying the standard system paths. The standard paths are mostly useful in conjunction with the FileDialog and FolderDialog 类型。

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

注意: Types in Qt.labs modules are not guaranteed to remain compatible in future versions.

另请参阅 FileDialog , FolderDialog ,和 QStandardPaths .

方法文档编制

string displayName ( StandardLocation type )

Returns a localized display name for the given location type or an empty QString if no relevant location can be found.

另请参阅 QStandardPaths::displayName() .


url findExecutable ( string executableName , list < string > paths )

Finds the executable named executableName 以指定 paths , or the system paths if paths is empty.

On most operating systems the system path is determined by the PATH environment variable. The directories where to search for the executable can be set in the paths argument. To search in both your own paths and the system paths, call findExecutable twice, once with paths set and once with paths empty. Symlinks are not resolved in order to preserve behavior for the case of executables whose behavior depends on the name they are invoked with .

注意: On Windows, the usual executable extensions (from the PATHEXT environment variable) are automatically appended. For example, the findExecutable("foo") call finds foo.exe or foo.bat if present.

Returns the absolute file path to the executable, or an empty string if not found.

另请参阅 QStandardPaths::findExecutable() .


url locate ( StandardLocation type , string fileName , LocateOptions options )

Finds a file or directory called fileName in the standard locations for type .

options flag lets you specify whether to look for files or directories. By default, this flag is set to LocateFile .

Returns the absolute path to the first file or directory found, otherwise returns an empty string.

另请参阅 QStandardPaths::locate() .


list < url > locateAll ( StandardLocation type , string fileName , LocateOptions options )

Finds all files or directories by the name, fileName , in the standard locations for type .

options flag lets you specify whether to look for files or directories. By default, this flag is set to LocateFile .

Returns the list of all the files that were found.

另请参阅 QStandardPaths::locateAll() .


void setTestModeEnabled ( bool testMode )

testMode is true , this enables a special "test mode" in QStandardPaths , which changes writable locations to point to test directories. This prevents auto tests from reading or writing to the current user's configuration.

It affects the locations into which test programs might write files: GenericDataLocation , DataLocation , ConfigLocation , GenericConfigLocation , AppConfigLocation , GenericCacheLocation ,和 CacheLocation . Other locations are not affected.

On Unix, XDG_DATA_HOME 被设为 ~/.qttest/share , XDG_CONFIG_HOME 被设为 ~/.qttest/config ,和 XDG_CACHE_HOME 被设为 ~/.qttest/cache .

On macOS, data goes to ~/.qttest/Application Support , cache goes to ~/.qttest/Cache , and config goes to ~/.qttest/Preferences .

On Windows, everything goes to a "qttest" directory under %APPDATA% .

另请参阅 QStandardPaths::setTestModeEnabled() .


list < url > standardLocations ( StandardLocation type )

Returns all the directories where files of type belong.

The list of directories is sorted from high to low priority, starting with writableLocation() if it can be determined. This list is empty if no locations for type are defined.

另请参阅 QStandardPaths::standardLocations() .


url writableLocation ( StandardLocation type )

Returns the directory where files of type should be written to, or an empty string if the location cannot be determined.

注意: The storage location returned may not exist; that is, it may need to be created by the system or the user.

另请参阅 QStandardPaths::writableLocation() .