-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsunitselectionwidget.sip
166 lines (136 loc) · 5.04 KB
/
qgsunitselectionwidget.sip
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
/** \class QgsMapUnitScaleWidget
* \ingroup gui
* A widget which allows the user to choose the minimum and maximum scale of an object in map units
* and millimetres. This widget is designed to allow users to edit the properties of a
* QgsMapUnitScale object.
* \note added in QGIS 3.0
* \see QgsMapUnitScaleDialog
* \see QgsUnitSelectionWidget
*/
class QgsMapUnitScaleWidget : QgsPanelWidget
{
%TypeHeaderCode
#include <qgsunitselectionwidget.h>
%End
public:
/** Constructor for QgsMapUnitScaleWidget.
* @param parent parent widget
*/
QgsMapUnitScaleWidget( QWidget* parent /TransferThis/ = nullptr );
/** Returns a QgsMapUnitScale representing the settings shown in the
* widget.
* @see setMapUnitScale()
* @see mapUnitScaleChanged()
*/
QgsMapUnitScale mapUnitScale() const;
/** Updates the widget to reflect the settings from the specified
* QgsMapUnitScale object.
* @param scale map unit scale to show in widget
* @see mapUnitScale()
* @see mapUnitScaleChanged()
*/
void setMapUnitScale( const QgsMapUnitScale& scale );
/** Sets the map canvas associated with the widget. This allows the
* widget to retrieve the current map scale from the canvas.
* @param canvas map canvas
*/
void setMapCanvas( QgsMapCanvas* canvas );
signals:
/** Emitted when the settings in the widget are modified.
* @param scale QgsMapUnitScale reflecting new settings from the widget
*/
void mapUnitScaleChanged( const QgsMapUnitScale& scale );
};
/** \class QgsMapUnitScaleDialog
* \ingroup gui
* A dialog which allows the user to choose the minimum and maximum scale of an object in map units
* and millimetres. This dialog is designed to allow users to edit the properties of a
* QgsMapUnitScale object.
* \see QgsMapUnitScaleWidget
* \see QgsUnitSelectionWidget
*/
class QgsMapUnitScaleDialog : QDialog
{
%TypeHeaderCode
#include <qgsunitselectionwidget.h>
%End
public:
/** Constructor for QgsMapUnitScaleDialog.
* @param parent parent widget
*/
QgsMapUnitScaleDialog( QWidget* parent /TransferThis/ = 0);
/** Returns a QgsMapUnitScale representing the settings shown in the
* dialog.
* @see setMapUnitScale()
*/
QgsMapUnitScale getMapUnitScale() const;
/** Updates the dialog to reflect the settings from the specified
* QgsMapUnitScale object.
* @param scale map unit scale to show in dialog
* @see mapUnitScale()
*/
void setMapUnitScale( const QgsMapUnitScale& scale );
/** Sets the map canvas associated with the dialog. This allows the dialog to retrieve the current
* map scale from the canvas.
* @param canvas map canvas
* @note added in QGIS 2.12
*/
void setMapCanvas( QgsMapCanvas* canvas );
};
/** \class QgsUnitSelectionWidget
* \ingroup gui
* A widget displaying a combobox allowing the user to choose between various display units,
* such as millimeters or map unit. If the user chooses map units, a button appears allowing
* adjustment of minimum and maximum scaling.
* \see QgsMapUnitScaleWidget
* \see QgsMapUnitScaleDialog
*/
class QgsUnitSelectionWidget : QWidget
{
%TypeHeaderCode
#include <qgsunitselectionwidget.h>
%End
public:
/** Constructor for QgsUnitSelectionWidget.
* @param parent parent widget
*/
QgsUnitSelectionWidget( QWidget* parent /TransferThis/ = 0 );
/** Sets the units which the user can choose from in the combobox.
* @param units list of strings for custom units to display in the widget
* @param mapUnitIdx specifies which entry corresponds to the map units, or -1 if none
*/
void setUnits( const QStringList& units, int mapUnitIdx );
/** Sets the units which the user can choose from in the combobox. Clears any existing units.
* @param units list of valid units
* @note added in QGIS 2.9
*/
void setUnits( const QgsUnitTypes::RenderUnitList& units );
/** Get the selected unit index */
int getUnit() const;
/** Returns the current predefined selected unit (if applicable).
* @returns selected output unit, or QgsSymbol::Mixed if the widget was populated with custom unit types
* @note added in QGIS 2.9
*/
QgsUnitTypes::RenderUnit unit() const;
/** Sets the selected unit index
* @param unitIndex index of unit to set as current
* @note available in Python bindings as setUnitIndex
*/
void setUnit( int unitIndex ) /PyName=setUnitIndex/;
/** Sets the selected unit
* @param unit predefined unit to set as current
*/
void setUnit( QgsUnitTypes::RenderUnit unit );
/** Returns the map unit scale */
QgsMapUnitScale getMapUnitScale() const;
/** Sets the map unit scale */
void setMapUnitScale( const QgsMapUnitScale& scale );
/** Sets the map canvas associated with the widget. This allows the widget to retrieve the current
* map scale from the canvas.
* @param canvas map canvas
* @note added in QGIS 2.12
*/
void setMapCanvas( QgsMapCanvas* canvas );
signals:
void changed();
};