A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters. More...
#include <qgsunitselectionwidget.h>
Signals | |
| void | mapUnitScaleChanged (const QgsMapUnitScale &scale) |
| Emitted when the settings in the widget are modified. More... | |
 Signals inherited from QgsPanelWidget | |
| void | panelAccepted (QgsPanelWidget *panel) |
| Emitted when the panel is accepted by the user. More... | |
| void | showPanel (QgsPanelWidget *panel) |
| Emit when you require a panel to be show in the interface. More... | |
| void | widgetChanged () |
| Emitted when the widget state changes. More... | |
Public Member Functions | |
| QgsMapUnitScaleWidget (QWidget *parent=nullptr) | |
| Constructor for QgsMapUnitScaleWidget. More... | |
| QgsMapUnitScale | mapUnitScale () const |
| Returns a QgsMapUnitScale representing the settings shown in the widget. More... | |
| void | setMapCanvas (QgsMapCanvas *canvas) |
| Sets the map canvas associated with the widget. More... | |
| void | setMapUnitScale (const QgsMapUnitScale &scale) |
| Updates the widget to reflect the settings from the specified QgsMapUnitScale object. More... | |
| Public Member Functions inherited from QgsPanelWidget | |
| QgsPanelWidget (QWidget *parent=nullptr) | |
| Base class for any widget that can be shown as a inline panel. More... | |
| bool | autoDelete () |
| The the auto delete property on the widget. More... | |
| void | connectChildPanel (QgsPanelWidget *panel) |
| Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More... | |
| void | connectChildPanels (const QList< QgsPanelWidget * > &panels) |
| Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More... | |
| bool | dockMode () |
| Returns the dock mode state. More... | |
| virtual QMenu * | menuButtonMenu () |
Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More... | |
| virtual QString | menuButtonTooltip () const |
| Returns the (translated) tooltip text to use for the menu button for this panel. More... | |
| QString | panelTitle () |
| The title of the panel. More... | |
| void | setAutoDelete (bool autoDelete) |
| The the auto delete property on the widget. More... | |
| virtual void | setDockMode (bool dockMode) |
| Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More... | |
| void | setPanelTitle (const QString &panelTitle) |
| Set the title of the panel when shown in the interface. More... | |
Properties | |
| QgsMapUnitScale | mapUnitScale |
Additional Inherited Members | |
| Public Slots inherited from QgsPanelWidget | |
| void | acceptPanel () |
| Accept the panel. More... | |
| void | openPanel (QgsPanelWidget *panel) |
Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More... | |
| Static Public Member Functions inherited from QgsPanelWidget | |
| static QgsPanelWidget * | findParentPanel (QWidget *widget) |
| Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More... | |
| Protected Member Functions inherited from QgsPanelWidget | |
| void | keyPressEvent (QKeyEvent *event) override |
| Overridden key press event to handle the esc event on the widget. More... | |
Detailed Description
A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.
This widget is designed to allow users to edit the properties of a QgsMapUnitScale object.
- Since
- QGIS 3.0
Definition at line 42 of file qgsunitselectionwidget.h.
Constructor & Destructor Documentation
◆ QgsMapUnitScaleWidget()
| QgsMapUnitScaleWidget::QgsMapUnitScaleWidget | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsMapUnitScaleWidget.
- Parameters
-
parent parent widget
Definition at line 23 of file qgsunitselectionwidget.cpp.
Member Function Documentation
◆ mapUnitScale()
| QgsMapUnitScale QgsMapUnitScaleWidget::mapUnitScale | ( | ) | const |
Returns a QgsMapUnitScale representing the settings shown in the widget.
Definition at line 110 of file qgsunitselectionwidget.cpp.
◆ mapUnitScaleChanged
|
signal |
Emitted when the settings in the widget are modified.
- Parameters
-
scale QgsMapUnitScale reflecting new settings from the widget
◆ setMapCanvas()
| void QgsMapUnitScaleWidget::setMapCanvas | ( | QgsMapCanvas * | canvas | ) |
Sets the map canvas associated with the widget.
This allows the widget to retrieve the current map scale from the canvas.
- Parameters
-
canvas map canvas
Definition at line 76 of file qgsunitselectionwidget.cpp.
◆ setMapUnitScale()
| void QgsMapUnitScaleWidget::setMapUnitScale | ( | const QgsMapUnitScale & | scale | ) |
Updates the widget to reflect the settings from the specified QgsMapUnitScale object.
- Parameters
-
scale map unit scale to show in widget
- See also
- mapUnitScale()
- mapUnitScaleChanged()
Definition at line 52 of file qgsunitselectionwidget.cpp.
Property Documentation
◆ mapUnitScale
|
readwrite |
Definition at line 1 of file qgsunitselectionwidget.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.18.1+99unstable/src/gui/qgsunitselectionwidget.h
- /build/qgis-3.18.1+99unstable/src/gui/qgsunitselectionwidget.cpp
