QgsMapUnitScaleWidget Class Reference

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>

Inheritance diagram for QgsMapUnitScaleWidget:

Signals
void	mapUnitScaleChanged (const QgsMapUnitScale &scale)
	Emitted when the settings in the widget are modified.
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
void	widgetChanged ()
	Emitted when the widget state changes.

Public Member Functions
	QgsMapUnitScaleWidget (QWidget *parent=nullptr)
	Constructor for QgsMapUnitScaleWidget.
QgsMapUnitScale	mapUnitScale () const
	Returns a QgsMapUnitScale representing the settings shown in the widget.
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the widget.
void	setMapUnitScale (const QgsMapUnitScale &scale)
	Updates the widget to reflect the settings from the specified QgsMapUnitScale object.
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete ()
	The the auto delete property on the widget.
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.
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.
bool	dockMode ()
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle ()
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Properties
QgsMapUnitScale	mapUnitScale

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.
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.
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.
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

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.

See also

QgsMapUnitScaleDialog

QgsUnitSelectionWidget

Definition at line 43 of file qgsunitselectionwidget.h.

Constructor & Destructor Documentation

QgsMapUnitScaleWidget()

QgsMapUnitScaleWidget::QgsMapUnitScaleWidget

(

QWidget *

parent = nullptr

)

Constructor for QgsMapUnitScaleWidget.

Parameters

parent

parent widget

Definition at line 24 of file qgsunitselectionwidget.cpp.

Member Function Documentation

mapUnitScale()

QgsMapUnitScale QgsMapUnitScaleWidget::mapUnitScale

(

)

const

Returns a QgsMapUnitScale representing the settings shown in the widget.

See also

setMapUnitScale()

mapUnitScaleChanged()

Definition at line 111 of file qgsunitselectionwidget.cpp.

mapUnitScaleChanged

void QgsMapUnitScaleWidget::mapUnitScaleChanged ( const QgsMapUnitScale &  scale )

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 77 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 53 of file qgsunitselectionwidget.cpp.

Property Documentation

mapUnitScale

QgsMapUnitScale QgsMapUnitScaleWidget::mapUnitScale

readwrite

Definition at line 46 of file qgsunitselectionwidget.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgsunitselectionwidget.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgsunitselectionwidget.cpp