1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsuserprofile.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsUserProfile
{
%Docstring(signature="appended")
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.
%End
%TypeHeaderCode
#include "qgsuserprofile.h"
%End
public:
QgsUserProfile( const QString &folder );
%Docstring
Reference to a existing user profile folder. Profile folder should be
created using :py:class:`QgsProfileManager`.
:param folder: An existing profile folder as the base of the user
profile.
%End
const QString folder() const;
%Docstring
The base folder for the user profile.
%End
QgsError validate() const;
%Docstring
Check of the profile is in a valid state.
%End
const QString name() const;
%Docstring
The name for the user profile.
%End
void initSettings() const;
%Docstring
Init the settings from the user folder.
%End
const QString alias() const;
%Docstring
Returns the alias for the user profile.
:return: If no alias is set :py:func:`~QgsUserProfile.name` is returned.
%End
QgsError setAlias( const QString &alias ) const;
%Docstring
Set the alias of the profile. The alias is a user friendly name.
:param alias: A user friendly name for the profile.
:return: ``True`` of setting the alias was successful.
%End
const QIcon icon() const;
%Docstring
The icon for the user profile.
:return: A QIcon for the users
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsuserprofile.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
