PythonQt.QtCore.QStandardPaths · declarations 001
Back to PythonQt.QtCore.QStandardPaths
AppConfigLocation
instance-attribute
AppConfigLocation: Any
AppDataLocation
instance-attribute
AppDataLocation: Any
AppLocalDataLocation
instance-attribute
AppLocalDataLocation: Any
ApplicationsLocation
instance-attribute
ApplicationsLocation: Any
CacheLocation
instance-attribute
CacheLocation: Any
ConfigLocation
instance-attribute
ConfigLocation: Any
DataLocation
instance-attribute
DataLocation: Any
DesktopLocation
instance-attribute
DesktopLocation: Any
DocumentsLocation
instance-attribute
DocumentsLocation: Any
DownloadLocation
instance-attribute
DownloadLocation: Any
FontsLocation
instance-attribute
FontsLocation: Any
GenericCacheLocation
instance-attribute
GenericCacheLocation: Any
GenericConfigLocation
instance-attribute
GenericConfigLocation: Any
GenericDataLocation
instance-attribute
GenericDataLocation: Any
HomeLocation
instance-attribute
HomeLocation: Any
LocateDirectory
instance-attribute
LocateDirectory: Any
LocateFile
instance-attribute
LocateFile: Any
LocateOption
instance-attribute
LocateOption: type
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.
int('0b100', base=0) 4
LocateOptions
instance-attribute
LocateOptions: type
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.
int('0b100', base=0) 4
MoviesLocation
instance-attribute
MoviesLocation: Any
MusicLocation
instance-attribute
MusicLocation: Any
PicturesLocation
instance-attribute
PicturesLocation: Any
RuntimeLocation
instance-attribute
RuntimeLocation: Any
StandardLocation
instance-attribute
StandardLocation: type
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.
int('0b100', base=0) 4
TempLocation
instance-attribute
TempLocation: Any
displayName
displayName(type: Any) -> str
X.displayName(type) -> str
Supplemental documentation: Qt 5 reference:
[static] QString QStandardPaths::displayName(QStandardPaths::StandardLocation type)
Returns a localized display name for the given location type or an empty QString if no relevant location can be found.
Upstream PySide2 reference signatures (binding differences may apply):
displayName(type: PySide2.QtCore.QStandardPaths.StandardLocation) -> str
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#displayName
enableTestMode
enableTestMode(testMode: bool) -> None
X.enableTestMode(testMode)
Upstream PySide2 reference signatures (binding differences may apply):
enableTestMode(testMode: bool) -> None
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#enableTestMode
findExecutable
findExecutable(executableName: str, paths: Any) -> str
X.findExecutable(executableName, paths) -> str
Supplemental documentation: Qt 5 reference:
[static] QString QStandardPaths::findExecutable(const QString \&executableName, const QStringList \&paths \= QStringList())
Finds the executable named executableName in the specified 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 .
Note: 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.
If the given \n executableName is an absolute path pointing to an executable its clean path is returned.
Upstream PySide2 reference signatures (binding differences may apply):
findExecutable(executableName: str, paths: typing.Sequence[str]=...) -> str
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#findExecutable
isTestModeEnabled
isTestModeEnabled() -> bool
X.isTestModeEnabled() -> bool
Upstream PySide2 reference signatures (binding differences may apply):
isTestModeEnabled() -> bool
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#isTestModeEnabled
locate
locate(type: Any, fileName: str, options: Any) -> str
X.locate(type, fileName, options) -> str
Supplemental documentation: Qt 5 reference:
[static] QString QStandardPaths::locate(QStandardPaths::StandardLocation type, const QString \&fileName, QStandardPaths::LocateOptions options \= ...)
Finds a file or directory called fileName in the standard locations for type.
The 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.
Upstream PySide2 reference signatures (binding differences may apply):
locate(type: PySide2.QtCore.QStandardPaths.StandardLocation, fileName: str, options: PySide2.QtCore.QStandardPaths.LocateOptions=...) -> str
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#locate
locateAll
locateAll(type: Any, fileName: str, options: Any) -> tuple
X.locateAll(type, fileName, options) -> tuple
Supplemental documentation: Qt 5 reference:
[static] QStringList QStandardPaths::locateAll(QStandardPaths::StandardLocation type, const QString \&fileName, QStandardPaths::LocateOptions options \= LocateFile)
Finds all files or directories by the name, fileName, in the standard locations for type.
The 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.
Upstream PySide2 reference signatures (binding differences may apply):
locateAll(type: PySide2.QtCore.QStandardPaths.StandardLocation, fileName: str, options: PySide2.QtCore.QStandardPaths.LocateOptions=...) -> typing.List[str]
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#locateAll
setTestModeEnabled
setTestModeEnabled(testMode: bool) -> None
X.setTestModeEnabled(testMode)
Supplemental documentation: Qt 5 reference:
[static] void QStandardPaths::setTestModeEnabled(bool testMode)
If 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, and CacheLocation. Other locations are
not affected.
On Unix, XDG_DATA_HOME is set to ~/.qttest/share, XDG_CONFIG_HOME is set to
~/.qttest/config, and XDG_CACHE_HOME is set to ~/.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%.
Upstream PySide2 reference signatures (binding differences may apply):
setTestModeEnabled(testMode: bool) -> None
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#setTestModeEnabled
standardLocations
standardLocations(type: Any) -> tuple
X.standardLocations(type) -> tuple
Supplemental documentation: Qt 5 reference:
[static] QStringList QStandardPaths::standardLocations(QStandardPaths::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.
See also writableLocation().
Upstream PySide2 reference signatures (binding differences may apply):
standardLocations(type: PySide2.QtCore.QStandardPaths.StandardLocation) -> typing.List[str]
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#standardLocations
writableLocation
writableLocation(type: Any) -> str
X.writableLocation(type) -> str
Supplemental documentation: Qt 5 reference:
[static] QString QStandardPaths::writableLocation(QStandardPaths::StandardLocation type)
Returns the directory where files of type should be written to, or an empty string if the location cannot be determined.
Note: The storage location returned may not exist; that is, it may need to be created by the system or the user.
Upstream PySide2 reference signatures (binding differences may apply):
writableLocation(type: PySide2.QtCore.QStandardPaths.StandardLocation) -> str
Source: https://doc.qt.io/archives/qt-5.15/qstandardpaths.html#writableLocation