-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsextentwidget.sip.in
210 lines (154 loc) · 6 KB
/
qgsextentwidget.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsextentwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsExtentWidget : QWidget
{
%Docstring
A widget for configuration of a map extent.
Besides allowing the user to enter the extent manually, it comes with options to use
original extent or extent defined by the current view in map canvas.
When using the widget, make sure to call setOriginalExtent(), setCurrentExtent() and setOutputCrs() during initialization.
.. seealso:: :py:class:`QgsExtentGroupBox`
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsextentwidget.h"
%End
public:
enum ExtentState
{
OriginalExtent,
CurrentExtent,
UserExtent,
ProjectLayerExtent,
DrawOnCanvas,
};
explicit QgsExtentWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsExtentWidget.
%End
void setOriginalExtent( const QgsRectangle &originalExtent, const QgsCoordinateReferenceSystem &originalCrs );
%Docstring
Sets the original extent and coordinate reference system for the widget. This should be called as part of initialization.
.. seealso:: :py:func:`originalExtent`
.. seealso:: :py:func:`originalCrs`
%End
QgsRectangle originalExtent() const;
%Docstring
Returns the original extent set for the widget.
.. seealso:: :py:func:`setOriginalExtent`
.. seealso:: :py:func:`originalCrs`
%End
QgsCoordinateReferenceSystem originalCrs() const;
%Docstring
Returns the original coordinate reference system set for the widget.
.. seealso:: :py:func:`originalExtent`
.. seealso:: :py:func:`setOriginalExtent`
%End
void setCurrentExtent( const QgsRectangle ¤tExtent, const QgsCoordinateReferenceSystem ¤tCrs );
%Docstring
Sets the current extent to show in the widget - should be called as part of initialization (or whenever current extent changes).
The current extent is usually set to match the current map canvas extent.
.. seealso:: :py:func:`currentExtent`
.. seealso:: :py:func:`currentCrs`
%End
QgsRectangle currentExtent() const;
%Docstring
Returns the current extent set for the widget. The current extent is usually set to match the
current map canvas extent.
.. seealso:: :py:func:`setCurrentExtent`
.. seealso:: :py:func:`currentCrs`
%End
QgsCoordinateReferenceSystem currentCrs() const;
%Docstring
Returns the coordinate reference system for the current extent set for the widget. The current
extent and CRS usually reflects the map canvas extent and CRS.
.. seealso:: :py:func:`setCurrentExtent`
.. seealso:: :py:func:`currentExtent`
%End
void setOutputCrs( const QgsCoordinateReferenceSystem &outputCrs );
%Docstring
Sets the output CRS - may need to be used for transformation from original/current extent.
Should be called as part of initialization and whenever the the output CRS is changed.
The current extent will be reprojected into the new output CRS.
%End
QgsRectangle outputExtent() const;
%Docstring
Returns the extent shown in the widget - in output CRS coordinates.
.. seealso:: :py:func:`outputCrs`
%End
QgsCoordinateReferenceSystem outputCrs() const;
%Docstring
Returns the current output CRS, used in the display.
.. seealso:: :py:func:`outputExtent`
%End
QgsExtentWidget::ExtentState extentState() const;
%Docstring
Returns the currently selected state for the widget's extent.
%End
void setMapCanvas( QgsMapCanvas *canvas );
%Docstring
Sets the map canvas to enable dragging of extent on a canvas.
:param canvas: the map canvas
%End
QSize ratio() const;
%Docstring
Returns the current fixed aspect ratio to be used when dragging extent onto the canvas.
If the aspect ratio isn't fixed, the width and height will be set to zero.
%End
QString extentLayerName() const;
%Docstring
Returns the name of the extent layer.
%End
bool isValid() const;
%Docstring
Returns ``True`` if the widget is in a valid state, i.e. has an extent set.
%End
public slots:
void setOutputExtentFromOriginal();
%Docstring
Sets the output extent to be the same as original extent (may be transformed to output CRS).
%End
void setOutputExtentFromCurrent();
%Docstring
Sets the output extent to be the same as current extent (may be transformed to output CRS).
%End
void setOutputExtentFromUser( const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the output extent to a custom extent (may be transformed to output CRS).
%End
void setOutputExtentFromLayer( const QgsMapLayer *layer );
%Docstring
Sets the output extent to match a ``layer``'s extent (may be transformed to output CRS).
%End
void setOutputExtentFromDrawOnCanvas();
%Docstring
Sets the output extent by dragging on the canvas.
%End
void setRatio( QSize ratio );
%Docstring
Sets a fixed aspect ratio to be used when dragging extent onto the canvas.
To unset a fixed aspect ratio, set the width and height to zero.
:param ratio: aspect ratio's width and height
%End
signals:
void extentChanged( const QgsRectangle &r );
%Docstring
Emitted when the widget's extent is changed.
%End
void validationChanged( bool valid );
%Docstring
Emitted when the widget's validation state changes.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsextentwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/