Class: QgsExtentGroupBox

class qgis.gui.QgsExtentGroupBox(parent: QWidget = None)

Bases: qgis._gui.QgsCollapsibleGroupBox

Constructor for QgsExtentGroupBox.

Collapsible group box for configuration of extent, typically for a save operation.

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.

New in version 2.4: Enums

Methods

actionEvent
changeEvent
childEvent
clearModifiers
closeEvent
collapseExpandFixes
connectNotify
contextMenuEvent
create
currentCrs Returns the coordinate reference system for the current extent set for the widget.
currentExtent Returns the current extent set for the widget.
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
extentState Returns the currently selected state for the widget’s extent.
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
init
initPainter
initStyleOption
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
loadState
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
originalCrs Returns the original coordinate reference system set for the widget.
originalExtent Returns the original extent set for the widget.
outputCrs Returns the current output CRS, used in the display.
outputExtent Returns the extent shown in the widget - in output CRS coordinates.
paintEvent
ratio Returns the current fixed aspect ratio to be used when dragging extent onto the canvas.
receivers
resizeEvent
saveKey
saveState
sender
senderSignalIndex
setCurrentExtent Sets the current extent to show in the widget - should be called as part of initialization (or whenever current extent changes).
setMapCanvas Sets the map canvas to enable dragging of extent on a canvas.
setOriginalExtent Sets the original extent and coordinate reference system for the widget.
setOutputCrs Sets the output CRS - may need to be used for transformation from original/current extent.
setOutputExtentFromCurrent Sets the output extent to be the same as current extent (may be transformed to output CRS).
setOutputExtentFromDrawOnCanvas Sets the output extent by dragging on the canvas.
setOutputExtentFromLayer Sets the output extent to match a layer’s extent (may be transformed to output CRS).
setOutputExtentFromOriginal Sets the output extent to be the same as original extent (may be transformed to output CRS).
setOutputExtentFromUser Sets the output extent to a custom extent (may be transformed to output CRS).
setRatio Sets a fixed aspect ratio to be used when dragging extent onto the canvas.
setTitleBase Sets the base part of title of the group box (will be appended with extent state)
sharedPainter
showEvent
tabletEvent
timerEvent
titleBase Returns the base part of title of the group box (will be appended with extent state).
titleRect
updateMicroFocus
updateStyle
wheelEvent

Signals

extentChanged Emitted when the widget’s extent is changed.

Attributes

CurrentExtent
DrawOnCanvas
OriginalExtent
ProjectLayerExtent
UserExtent
CurrentExtent = 1
DrawOnCanvas = 4
class ExtentState

Bases: int

OriginalExtent = 0
ProjectLayerExtent = 3
UserExtent = 2
actionEvent()
changeEvent()
childEvent()
clearModifiers()
closeEvent()
collapseExpandFixes()
connectNotify()
contextMenuEvent()
create()
currentCrs(self) → QgsCoordinateReferenceSystem

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.

See also

currentExtent()

currentExtent(self) → QgsRectangle

Returns the current extent set for the widget. The current extent is usually set to match the current map canvas extent.

See also

currentCrs()

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
extentChanged

Emitted when the widget’s extent is changed. [signal]

extentState(self) → QgsExtentGroupBox.ExtentState

Returns the currently selected state for the widget’s extent.

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
init()
initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadState()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
originalCrs(self) → QgsCoordinateReferenceSystem

Returns the original coordinate reference system set for the widget.

See also

originalExtent()

originalExtent(self) → QgsRectangle

Returns the original extent set for the widget.

See also

originalCrs()

outputCrs(self) → QgsCoordinateReferenceSystem

Returns the current output CRS, used in the display.

See also

outputExtent()

New in version 3.0.

outputExtent(self) → QgsRectangle

Returns the extent shown in the widget - in output CRS coordinates.

See also

outputCrs()

paintEvent()
ratio(self) → QSize

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.

New in version 3.0.

receivers()
resizeEvent()
saveKey()
saveState()
sender()
senderSignalIndex()
setCurrentExtent(self, currentExtent: QgsRectangle, currentCrs: QgsCoordinateReferenceSystem)

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.

See also

currentExtent()

See also

currentCrs()

setMapCanvas(self, canvas: QgsMapCanvas)

Sets the map canvas to enable dragging of extent on a canvas.

Parameters:canvas – the map canvas

New in version 3.0.

setOriginalExtent(self, originalExtent: QgsRectangle, originalCrs: QgsCoordinateReferenceSystem)

Sets the original extent and coordinate reference system for the widget. This should be called as part of initialization.

See also

originalExtent()

See also

originalCrs()

setOutputCrs(self, outputCrs: QgsCoordinateReferenceSystem)

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.

setOutputExtentFromCurrent(self)

Sets the output extent to be the same as current extent (may be transformed to output CRS).

setOutputExtentFromDrawOnCanvas(self)

Sets the output extent by dragging on the canvas.

New in version 3.0.

setOutputExtentFromLayer(self, layer: QgsMapLayer)

Sets the output extent to match a layer’s extent (may be transformed to output CRS).

New in version 3.0.

setOutputExtentFromOriginal(self)

Sets the output extent to be the same as original extent (may be transformed to output CRS).

setOutputExtentFromUser(self, extent: QgsRectangle, crs: QgsCoordinateReferenceSystem)

Sets the output extent to a custom extent (may be transformed to output CRS).

setRatio(self, ratio: QSize)

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.

Parameters:ratio – aspect ratio’s width and height

New in version 3.0.

setTitleBase(self, title: str)

Sets the base part of title of the group box (will be appended with extent state)

See also

titleBase()

New in version 2.12.

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
titleBase(self) → str

Returns the base part of title of the group box (will be appended with extent state).

See also

setTitleBase()

New in version 2.12.

titleRect()
updateMicroFocus()
updateStyle()
wheelEvent()