Class: QgsUserProfile¶
User profile contains information about the user profile folders on the machine.
In QGIS 3 all settings, plugins, etc were moved into a %APPDATA%/profiles folder for each platform. This allows for manage different user profiles per machine vs the single default one that was allowed in the past.
A user profile is all settings and anything that used to be found in .qgis3 in the users home folder.
Methods
Returns the alias for the user profile. |
|
The base folder for the user profile. |
|
The icon for the user profile. |
|
Init the settings from the user folder. |
|
The name for the user profile. |
|
Set the alias of the profile. |
|
Check of the profile is in a valid state. |
- class qgis.core.QgsUserProfile[source]¶
Bases:
object
- __init__(folder: str | None)
Reference to an existing user profile folder. Profile folder should be created using
QgsProfileManager
.- Parameters:
folder (Optional[str]) – An existing profile folder as the base of the user profile.
- __init__(a0: QgsUserProfile)
- Parameters:
a0 (QgsUserProfile)
- alias(self) str [source]¶
Returns the alias for the user profile.
- Return type:
str
- Returns:
If no alias is set
name()
is returned.
- icon(self) QIcon [source]¶
The icon for the user profile.
- Return type:
QIcon
- Returns:
A QIcon for the users