Class: QgsMapUnitScaleWidget¶

class qgis.gui.QgsMapUnitScaleWidget¶

Bases: QgsPanelWidget

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

See also

QgsUnitSelectionWidget

New in version 3.0.

QgsMapUnitScaleWidget(parent: QWidget = None) Constructor for QgsMapUnitScaleWidget.

Parameters

parent –

parent widget

Methods

`actionEvent`
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`	Overridden key press event to handle the esc event on the widget.
`keyReleaseEvent`
`leaveEvent`
`mapUnitScale`	Returns a `QgsMapUnitScale` representing the settings shown in the widget.
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`resizeEvent`
`sender`
`senderSignalIndex`
`setMapCanvas`	Sets the map canvas associated with the widget.
`setMapUnitScale`	Updates the widget to reflect the settings from the specified `QgsMapUnitScale` object.
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`wheelEvent`

Signals

mapUnitScaleChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

actionEvent(self, QActionEvent)¶

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEvent(self, QCloseEvent)¶

connectNotify(self, QMetaMethod)¶

contextMenuEvent(self, QContextMenuEvent)¶

create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

customEvent(self, QEvent)¶

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disconnectNotify(self, QMetaMethod)¶

dragEnterEvent(self, QDragEnterEvent)¶

dragLeaveEvent(self, QDragLeaveEvent)¶

dragMoveEvent(self, QDragMoveEvent)¶

dropEvent(self, QDropEvent)¶

enterEvent(self, QEvent)¶

event(self, QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOutEvent(self, QFocusEvent)¶

focusPreviousChild(self) → bool¶

hideEvent(self, QHideEvent)¶

initPainter(self, QPainter)¶

inputMethodEvent(self, QInputMethodEvent)¶

isSignalConnected(self, QMetaMethod) → bool¶

keyPressEvent(self, event: QKeyEvent)¶

Overridden key press event to handle the esc event on the widget.

Parameters: event – The key event

keyReleaseEvent(self, QKeyEvent)¶

leaveEvent(self, QEvent)¶

mapUnitScale(self) → QgsMapUnitScale¶

Returns a QgsMapUnitScale representing the settings shown in the widget.

See also

setMapUnitScale()

See also

mapUnitScaleChanged()

Return type: QgsMapUnitScale

mapUnitScaleChanged¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters

name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

metric(self, QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, QMouseEvent)¶

mouseMoveEvent(self, QMouseEvent)¶

mousePressEvent(self, QMouseEvent)¶

mouseReleaseEvent(self, QMouseEvent)¶

moveEvent(self, QMoveEvent)¶

nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) → Tuple[bool, int]¶

paintEvent(self, QPaintEvent)¶

receivers(self, PYQT_SIGNAL) → int¶

resizeEvent(self, QResizeEvent)¶

sender(self) → QObject¶

senderSignalIndex(self) → int¶

setMapCanvas(self, canvas: QgsMapCanvas)¶

Sets the map canvas associated with the widget. This allows the widget to retrieve the current map scale from the canvas.

Parameters: canvas (QgsMapCanvas) – map canvas

setMapUnitScale(self, scale: QgsMapUnitScale)¶

Updates the widget to reflect the settings from the specified QgsMapUnitScale object.

Parameters: scale (QgsMapUnitScale) – map unit scale to show in widget

See also

mapUnitScale()

See also

mapUnitScaleChanged()

sharedPainter(self) → QPainter¶

showEvent(self, QShowEvent)¶

tabletEvent(self, QTabletEvent)¶

timerEvent(self, QTimerEvent)¶

updateMicroFocus(self)¶

wheelEvent(self, QWheelEvent)¶