Class: QgsProjectionSelectionTreeWidget

A widget for selecting a coordinate reference system from a tree.

This widget implements a tree view of projections, as seen in the QgsProjectionSelectionDialog dialog. In most cases it is more suitable to use the compact QgsProjectionSelectionWidget widget.

See also

QgsProjectionSelectionDialog

See also

QgsProjectionSelectionWidget

QgsProjectionSelectionTreeWidget

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

clearRecentCrs	Clear the list of recent projections.
crs	Returns the CRS currently selected in the widget.
filters	Returns the filters set on the available CRS.
hasValidSelection	Returns True if the current selection in the widget is a valid choice.
previewRect	The initial "preview" rectangle for the bounds overview map.
pushProjectionToFront	Marks the current selected projection for push to front of recent projections list.
setCrs	Sets the initial crs to show within the dialog.
setFilters	Sets filters for the available CRS.
setNotSetText	Sets the text to show for the not set option.
setOgcWmsCrsFilter	Filters this widget by the given CRSs.
setPreviewRect	Sets the initial "preview" rectangle for the bounds overview map.
setShowBoundsMap	Sets whether to show the bounds preview map.
setShowNoProjection	Sets whether a "no/invalid" projection option should be shown.
showBoundsMap	Returns whether the bounds preview map is shown.
showNoProjection	Returns whether the "no/invalid" projection option is shown.

Signals

crsSelected	Emitted when a projection is selected in the widget.
hasValidSelectionChanged	Emitted when the selection in the tree is changed from a valid selection to an invalid selection, or vice-versa.
initialized	Notifies others that the widget is now fully initialized, including deferred selection of projection.
projectionDoubleClicked	Emitted when a projection is double clicked in the list.

class qgis.gui.QgsProjectionSelectionTreeWidget

Bases: QWidget

__init__(parent: QWidget | None = None, filters: QgsCoordinateReferenceSystemProxyModel.Filters | QgsCoordinateReferenceSystemProxyModel.Filter = QgsCoordinateReferenceSystemProxyModel.FilterHorizontal | QgsCoordinateReferenceSystemProxyModel.FilterCompound)

Constructor for QgsProjectionSelectionTreeWidget, with the specified parent widget.

Since QGIS 3.34, the optional filter argument can be used to specify filters on the systems shown in the widget. The default is to show all horizontal and compound CRS in order to match the behavior of older QGIS releases. The filter can be altered to also include vertical CRS if desired.

Parameters:

• parent (Optional[QWidget] = None)

• filters (Union[QgsCoordinateReferenceSystemProxyModel.Filters, QgsCoordinateReferenceSystemProxyModel.Filter] = QgsCoordinateReferenceSystemProxyModel.FilterHorizontal|QgsCoordinateReferenceSystemProxyModel.FilterCompound)

clearRecentCrs(self)

Clear the list of recent projections.

Added in version 3.32.

crs(self) → QgsCoordinateReferenceSystem

Returns the CRS currently selected in the widget.

See also

setCrs()

Return type:

QgsCoordinateReferenceSystem

signal crsSelected

Emitted when a projection is selected in the widget.

filters(self) → QgsCoordinateReferenceSystemProxyModel.Filters

Returns the filters set on the available CRS.

See also

setFilters()

Added in version 3.34.

Return type:

QgsCoordinateReferenceSystemProxyModel.Filters

hasValidSelection(self) → bool

Returns True if the current selection in the widget is a valid choice. Valid selections include any projection and also the “no/invalid projection” option (if setShowNoProjection() was called). Invalid selections are the group headers (such as “Geographic Coordinate Systems”)

Return type:

bool

signal hasValidSelectionChanged(isValid: bool)

Emitted when the selection in the tree is changed from a valid selection to an invalid selection, or vice-versa.

Added in version 3.18.

Parameters:

isValid (bool)

signal initialized

Notifies others that the widget is now fully initialized, including deferred selection of projection.

Deprecated since version 3.40: No longer emitted.

previewRect(self) → QgsRectangle

The initial “preview” rectangle for the bounds overview map.

See also

previewRect()

Return type:

QgsRectangle

signal projectionDoubleClicked

Emitted when a projection is double clicked in the list.

pushProjectionToFront(self)

Marks the current selected projection for push to front of recent projections list.

Deprecated since version 3.40: Has no effect since QGIS 3.20.

setCrs(self, crs: QgsCoordinateReferenceSystem)

Sets the initial crs to show within the dialog.

See also

crs()

Parameters:

crs (QgsCoordinateReferenceSystem)

setFilters(self, filters: QgsCoordinateReferenceSystemProxyModel.Filters | QgsCoordinateReferenceSystemProxyModel.Filter)

Sets filters for the available CRS.

See also

filters()

Added in version 3.34.

Parameters:

filters (Union[QgsCoordinateReferenceSystemProxyModel.Filters, QgsCoordinateReferenceSystemProxyModel.Filter])

setNotSetText(self, text: str | None)

Sets the text to show for the not set option. Note that this option is not shown by default and must be set visible by calling setShowNoProjection().

Added in version 3.16.

Parameters:

text (Optional[str])

setOgcWmsCrsFilter(self, crsFilter: Iterable[str | None])

Filters this widget by the given CRSs.

Sets this widget to filter the available projections to those listed by the given Coordinate Reference Systems.

Parameters:

crsFilter (Iterable[Optional[str]]) – a list of the authority:id strings for Coordinate Reference Systems to include in the widget.

setPreviewRect(self, rect: QgsRectangle)

Sets the initial “preview” rectangle for the bounds overview map.

See also

previewRect()

Parameters:

rect (QgsRectangle)

setShowBoundsMap(self, show: bool)

Sets whether to show the bounds preview map.

See also

showBoundsMap()

Parameters:

show (bool)

setShowNoProjection(self, show: bool)

Sets whether a “no/invalid” projection option should be shown. If this option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem.

See also

showNoProjection()

Parameters:

show (bool)

showBoundsMap(self) → bool

Returns whether the bounds preview map is shown.

See also

setShowBoundsMap()

Return type:

bool

showNoProjection(self) → bool

Returns whether the “no/invalid” projection option is shown. If this option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem.

See also

setShowNoProjection()

Return type:

bool