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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojectdisplaysettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProjectDisplaySettings : QObject
{
%Docstring(signature="appended")
Contains settings and properties relating to how a
:py:class:`QgsProject` should display values such as map coordinates and
bearings.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgsprojectdisplaysettings.h"
%End
public:
QgsProjectDisplaySettings( QObject *parent = 0 );
%Docstring
Constructor for QgsProjectDisplaySettings with the specified ``parent``
object.
%End
~QgsProjectDisplaySettings();
void reset();
%Docstring
Resets the settings to a default state.
%End
void setBearingFormat( QgsBearingNumericFormat *format /Transfer/ );
%Docstring
Sets the project bearing ``format``, which controls how bearings
associated with the project are displayed.
Ownership of ``format`` is transferred to the settings.
.. seealso:: :py:func:`bearingFormat`
.. seealso:: :py:func:`bearingFormatChanged`
%End
const QgsBearingNumericFormat *bearingFormat() const;
%Docstring
Returns the project bearing's format, which controls how bearings
associated with the project are displayed.
.. seealso:: :py:func:`setBearingFormat`
.. seealso:: :py:func:`bearingFormatChanged`
%End
void setGeographicCoordinateFormat( QgsGeographicCoordinateNumericFormat *format /Transfer/ );
%Docstring
Sets the project geographic coordinate ``format``, which controls how
geographic coordinates associated with the project are displayed.
Ownership of ``format`` is transferred to the settings.
.. seealso:: :py:func:`geographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormatChanged`
.. versionadded:: 3.26
%End
const QgsGeographicCoordinateNumericFormat *geographicCoordinateFormat() const;
%Docstring
Returns the project's geographic coordinate format, which controls how
geographic coordinates associated with the project are displayed.
.. seealso:: :py:func:`setGeographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormatChanged`
%End
Qgis::CoordinateDisplayType coordinateType() const;
%Docstring
Returns default coordinate type for the project.
.. seealso:: :py:func:`setCoordinateType`
.. versionadded:: 3.28
%End
void setCoordinateType( Qgis::CoordinateDisplayType type );
%Docstring
Sets the default coordinate ``type`` for the project.
.. seealso:: :py:func:`coordinateType`
.. versionadded:: 3.28
%End
Qgis::CoordinateOrder coordinateAxisOrder() const;
%Docstring
Returns default coordinate axis order to use when displaying coordinates
for the project.
.. seealso:: :py:func:`setCoordinateAxisOrder`
.. seealso:: :py:func:`coordinateAxisOrderChanged`
.. versionadded:: 3.28
%End
void setCoordinateAxisOrder( Qgis::CoordinateOrder order );
%Docstring
Sets the default coordinate axis ``order`` to use when displaying
coordinates for the project.
.. seealso:: :py:func:`coordinateAxisOrder`
.. seealso:: :py:func:`coordinateAxisOrderChanged`
.. versionadded:: 3.28
%End
QgsCoordinateReferenceSystem coordinateCustomCrs() const;
%Docstring
Returns the coordinate custom CRS used when the project coordinate type
is set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
.. seealso:: :py:func:`setCoordinateCustomCrs`
.. versionadded:: 3.28
%End
void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the coordinate custom CRS used when the project coordinate type is
set to :py:class:`Qgis`.CoordinateDisplayType.CustomCrs.
.. seealso:: :py:func:`setCoordinateCustomCrs`
.. versionadded:: 3.28
%End
QgsCoordinateReferenceSystem coordinateCrs() const;
%Docstring
Returns the coordinate display CRS used derived from the coordinate
type.
.. seealso:: :py:func:`coordinateType`
.. note::
if not parented to a project object, an invalid CRS will be returned.
.. versionadded:: 3.28
%End
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads the settings's state from a DOM element.
.. seealso:: :py:func:`writeXml`
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
%Docstring
Returns a DOM element representing the settings.
.. seealso:: :py:func:`readXml`
%End
signals:
void bearingFormatChanged();
%Docstring
Emitted when the bearing format changes.
.. seealso:: :py:func:`setBearingFormat`
.. seealso:: :py:func:`bearingFormat`
%End
void geographicCoordinateFormatChanged();
%Docstring
Emitted when the geographic coordinate format changes.
.. seealso:: :py:func:`setGeographicCoordinateFormat`
.. seealso:: :py:func:`geographicCoordinateFormat`
%End
void coordinateTypeChanged();
%Docstring
Emitted when the default coordinate format changes.
.. seealso:: :py:func:`setCoordinateType`
.. seealso:: :py:func:`coordinateType`
.. versionadded:: 3.28
%End
void coordinateAxisOrderChanged();
%Docstring
Emitted when the default coordinate axis order changes.
.. seealso:: :py:func:`setCoordinateAxisOrder`
.. seealso:: :py:func:`coordinateAxisOrder`
.. versionadded:: 3.28
%End
void coordinateCustomCrsChanged();
%Docstring
Emitted when the coordinate custom CRS changes.
.. seealso:: :py:func:`setCoordinateCustomCrs`
.. seealso:: :py:func:`coordinateCustomCrs`
.. versionadded:: 3.28
%End
void coordinateCrsChanged();
%Docstring
Emitted when the coordinate CRS changes.
.. seealso:: :py:func:`coordinateCrs`
.. seealso:: :py:func:`coordinateType`
.. versionadded:: 3.28
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojectdisplaysettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
