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

#include <qgsprojectionselectiontreewidget.h>

Inheritance diagram for QgsProjectionSelectionTreeWidget:

Public Slots
void	clearRecentCrs ()
	Clear the list of recent projections. More...

QgsRectangle	previewRect () const
	The initial "preview" rectangle for the bounds overview map. More...

Q_DECL_DEPRECATED void	pushProjectionToFront ()
	Marks the current selected projection for push to front of recent projections list. More...

void	setCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the initial crs to show within the dialog. More...

void	setOgcWmsCrsFilter (const QSet< QString > &crsFilter)
	filters this widget by the given CRSs More...

void	setPreviewRect (const QgsRectangle &rect)
	Sets the initial "preview" rectangle for the bounds overview map. More...

Signals
void	crsSelected ()
	Emitted when a projection is selected in the widget. More...

void	hasValidSelectionChanged (bool isValid)
	Emitted when the selection in the tree is changed from a valid selection to an invalid selection, or vice-versa. More...

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

void	projectionDoubleClicked ()
	Emitted when a projection is double clicked in the list. More...

Public Member Functions
	QgsProjectionSelectionTreeWidget (QWidget *parent=nullptr)
	Constructor for QgsProjectionSelectionTreeWidget. More...

	~QgsProjectionSelectionTreeWidget () override

QgsCoordinateReferenceSystem	crs () const
	Returns the CRS currently selected in the widget. More...

bool	hasValidSelection () const
	Returns `true` if the current selection in the widget is a valid choice. More...

void	setNotSetText (const QString &text)
	Sets the text to show for the not set option. More...

void	setShowBoundsMap (bool show)
	Sets whether to show the bounds preview map. More...

void	setShowNoProjection (bool show)
	Sets whether a "no/invalid" projection option should be shown. More...

bool	showBoundsMap () const
	Returns whether the bounds preview map is shown. More...

bool	showNoProjection () const
	Returns whether the "no/invalid" projection option is shown. More...

Protected Member Functions
bool	eventFilter (QObject obj, QEvent ev) override

void	resizeEvent (QResizeEvent *event) override

void	showEvent (QShowEvent *event) override

Detailed Description

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.; QgsProjectionSelectionWidget

Since: QGIS 3.0

Definition at line 39 of file qgsprojectionselectiontreewidget.h.

Constructor & Destructor Documentation

◆ QgsProjectionSelectionTreeWidget()

QgsProjectionSelectionTreeWidget::QgsProjectionSelectionTreeWidget ( QWidget * parent = nullptr )

Constructor for QgsProjectionSelectionTreeWidget.

Definition at line 40 of file qgsprojectionselectiontreewidget.cpp.

◆ ~QgsProjectionSelectionTreeWidget()

QgsProjectionSelectionTreeWidget::~QgsProjectionSelectionTreeWidget ( )

override

Definition at line 128 of file qgsprojectionselectiontreewidget.cpp.

Member Function Documentation

◆ clearRecentCrs

void QgsProjectionSelectionTreeWidget::clearRecentCrs ( )

slot

Clear the list of recent projections.

Since: QGIS 3.32

Definition at line 1119 of file qgsprojectionselectiontreewidget.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsProjectionSelectionTreeWidget::crs ( ) const

Returns the CRS currently selected in the widget.

See also: setCrs()

Since: QGIS 3.0

Definition at line 468 of file qgsprojectionselectiontreewidget.cpp.

◆ crsSelected

void QgsProjectionSelectionTreeWidget::crsSelected ( )

signal

Emitted when a projection is selected in the widget.

◆ eventFilter()

bool QgsProjectionSelectionTreeWidget::eventFilter	(	QObject *	obj,
		QEvent *	ev
	)

overrideprotected

Definition at line 181 of file qgsprojectionselectiontreewidget.cpp.

◆ hasValidSelection()

bool QgsProjectionSelectionTreeWidget::hasValidSelection ( ) const

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")

Definition at line 504 of file qgsprojectionselectiontreewidget.cpp.

◆ hasValidSelectionChanged

void QgsProjectionSelectionTreeWidget::hasValidSelectionChanged ( bool isValid )

signal

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

Since: QGIS 3.18

◆ initialized

void QgsProjectionSelectionTreeWidget::initialized ( )

signal

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

Since: QGIS 2.4

◆ previewRect

QgsRectangle QgsProjectionSelectionTreeWidget::previewRect ( ) const

slot

The initial "preview" rectangle for the bounds overview map.

See also: previewRect()

Since: QGIS 3.0

Definition at line 367 of file qgsprojectionselectiontreewidget.cpp.

◆ projectionDoubleClicked

void QgsProjectionSelectionTreeWidget::projectionDoubleClicked ( )

signal

Emitted when a projection is double clicked in the list.

Since: QGIS 2.14

◆ pushProjectionToFront

void QgsProjectionSelectionTreeWidget::pushProjectionToFront ( )

slot

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

Deprecated:: Has no effect since QGIS 3.20

Definition at line 905 of file qgsprojectionselectiontreewidget.cpp.

◆ resizeEvent()

void QgsProjectionSelectionTreeWidget::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 139 of file qgsprojectionselectiontreewidget.cpp.

◆ setCrs

void QgsProjectionSelectionTreeWidget::setCrs ( const QgsCoordinateReferenceSystem & crs )

slot

Sets the initial crs to show within the dialog.

See also: crs()

Since: QGIS 3.0

Definition at line 332 of file qgsprojectionselectiontreewidget.cpp.

◆ setNotSetText()

void QgsProjectionSelectionTreeWidget::setNotSetText ( const QString & text )

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().

Since: QGIS 3.16

Definition at line 494 of file qgsprojectionselectiontreewidget.cpp.

◆ setOgcWmsCrsFilter

void QgsProjectionSelectionTreeWidget::setOgcWmsCrsFilter ( const QSet< QString > & crsFilter )

slot

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 a list of OGC Coordinate Reference Systems to filter the list of projections by. This is useful in (e.g.) WMS situations where you just want to offer what the WMS server can support.