A widget for selecting a projection. More...

#include <qgsprojectionselectionwidget.h>

Inheritance diagram for QgsProjectionSelectionWidget:

Public Types
enum	CrsOption { LayerCrs , ProjectCrs , CurrentCrs , DefaultCrs , RecentCrs , CrsNotSet }
	Predefined CRS options shown in widget. More...

Public Slots
void	selectCrs ()
	Opens the dialog for selecting a new CRS. More...

void	setCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the current CRS for the widget. More...

void	setLayerCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the layer CRS for the widget. More...

Signals
void	cleared ()
	Emitted when the not set option is selected. More...

void	crsChanged (const QgsCoordinateReferenceSystem &)
	Emitted when the selected CRS is changed. More...

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

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

QString	dialogTitle () const
	Returns the title for the CRS selector dialog window. More...

bool	optionVisible (CrsOption option) const
	Returns whether the specified CRS option is visible in the widget. More...

void	setDialogTitle (const QString &title)
	Sets the title for the CRS selector dialog window. More...

void	setMessage (const QString &text)
	Sets a message to show in the dialog. More...

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

void	setOptionVisible (CrsOption option, bool visible)
	Sets whether a predefined CRS option should be shown in the widget. More...

void	setShowAccuracyWarnings (bool show)
	Sets whether the widget will show warnings to users when they select a CRS which has low accuracy. More...

void	setSourceEnsemble (const QString &ensemble)
	Sets the original source ensemble datum name. More...

bool	showAccuracyWarnings () const
	Returns `true` if the widget will show a warning to users when they select a CRS which has low accuracy. More...

QString	sourceEnsemble () const
	Returns the original source ensemble datum name. More...

Static Public Member Functions
static QString	crsOptionText (const QgsCoordinateReferenceSystem &crs)
	Returns display text for the specified crs. More...

Protected Member Functions
void	dragEnterEvent (QDragEnterEvent *event) override

void	dragLeaveEvent (QDragLeaveEvent *event) override

void	dropEvent (QDropEvent *event) override

Detailed Description

A widget for selecting a projection.

Since: QGIS 2.7

Definition at line 40 of file qgsprojectionselectionwidget.h.

Member Enumeration Documentation

◆ CrsOption

enum QgsProjectionSelectionWidget::CrsOption

Predefined CRS options shown in widget.

Enumerator
LayerCrs	Optional layer CRS.
ProjectCrs	Current project CRS (if OTF reprojection enabled)
CurrentCrs	Current user selected CRS.
DefaultCrs	Global default QGIS CRS.
RecentCrs	Recently used CRS.
CrsNotSet	Not set (hidden by default)

Definition at line 48 of file qgsprojectionselectionwidget.h.

Constructor & Destructor Documentation

◆ QgsProjectionSelectionWidget()

QgsProjectionSelectionWidget::QgsProjectionSelectionWidget ( QWidget * parent = nullptr )

explicit

Constructor for QgsProjectionSelectionWidget.

Definition at line 27 of file qgsprojectionselectionwidget.cpp.

Member Function Documentation

◆ cleared

void QgsProjectionSelectionWidget::cleared ( )

signal

Emitted when the not set option is selected.

Since: QGIS 3.0

◆ crs()

QgsCoordinateReferenceSystem QgsProjectionSelectionWidget::crs ( ) const

Returns the currently selected CRS for the widget.

Returns: current CRS

Definition at line 97 of file qgsprojectionselectionwidget.cpp.

◆ crsChanged

void QgsProjectionSelectionWidget::crsChanged ( const QgsCoordinateReferenceSystem & )

signal

Emitted when the selected CRS is changed.

◆ crsOptionText()

QString QgsProjectionSelectionWidget::crsOptionText ( const QgsCoordinateReferenceSystem & crs )

static

Returns display text for the specified crs.

Note: Not available in Python bindings

Since: QGIS 3.8

Definition at line 563 of file qgsprojectionselectionwidget.cpp.

◆ dialogTitle()

QString QgsProjectionSelectionWidget::dialogTitle ( ) const

Returns the title for the CRS selector dialog window.

See also: setDialogTitle()

Since: QGIS 3.24

Definition at line 346 of file qgsprojectionselectionwidget.cpp.

◆ dragEnterEvent()

void QgsProjectionSelectionWidget::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

Definition at line 274 of file qgsprojectionselectionwidget.cpp.

◆ dragLeaveEvent()

void QgsProjectionSelectionWidget::dragLeaveEvent ( QDragLeaveEvent * event )

overrideprotected

Definition at line 296 of file qgsprojectionselectionwidget.cpp.

◆ dropEvent()

void QgsProjectionSelectionWidget::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 310 of file qgsprojectionselectionwidget.cpp.

◆ optionVisible()

bool QgsProjectionSelectionWidget::optionVisible ( QgsProjectionSelectionWidget::CrsOption option ) const

Returns whether the specified CRS option is visible in the widget.

See also: setOptionVisible()

Since: QGIS 3.0

Definition at line 194 of file qgsprojectionselectionwidget.cpp.

◆ selectCrs

void QgsProjectionSelectionWidget::selectCrs ( )

slot

Opens the dialog for selecting a new CRS.

Definition at line 200 of file qgsprojectionselectionwidget.cpp.

◆ setCrs

void QgsProjectionSelectionWidget::setCrs ( const QgsCoordinateReferenceSystem & crs )

slot

Sets the current CRS for the widget.

Parameters

crs new CRS

Definition at line 478 of file qgsprojectionselectionwidget.cpp.

◆ setDialogTitle()

void QgsProjectionSelectionWidget::setDialogTitle ( const QString & title )

Sets the title for the CRS selector dialog window.

See also: dialogTitle()

Since: QGIS 3.24

Definition at line 341 of file qgsprojectionselectionwidget.cpp.

◆ setLayerCrs

void QgsProjectionSelectionWidget::setLayerCrs ( const QgsCoordinateReferenceSystem & crs )

slot

Sets the layer CRS for the widget.

If set, this will be added as an option to the preset CRSes shown in the widget.

Parameters

crs layer CRS

Definition at line 519 of file qgsprojectionselectionwidget.cpp.

◆ setMessage()

void QgsProjectionSelectionWidget::setMessage ( const QString & text )

Sets a message to show in the dialog.

If an empty string is passed, the message will be a generic 'define the CRS for this layer'.

Since: QGIS 3.0

Definition at line 189 of file qgsprojectionselectionwidget.cpp.

◆ setNotSetText()

void QgsProjectionSelectionWidget::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 setOptionVisible().

Since: QGIS 3.0

Definition at line 179 of file qgsprojectionselectionwidget.cpp.

◆ setOptionVisible()

void QgsProjectionSelectionWidget::setOptionVisible	(	const QgsProjectionSelectionWidget::CrsOption	option,
		bool	visible
	)

Sets whether a predefined CRS option should be shown in the widget.

Parameters

option	CRS option to show/hide
visible	whether the option should be shown

See also: optionVisible()

Definition at line 121 of file qgsprojectionselectionwidget.cpp.

◆ setShowAccuracyWarnings()

void QgsProjectionSelectionWidget::setShowAccuracyWarnings ( bool show )

Sets whether the widget will show warnings to users when they select a CRS which has low accuracy.

See also: showAccuracyWarnings()

Since: QGIS 3.20

Definition at line 365 of file qgsprojectionselectionwidget.cpp.

◆ setSourceEnsemble()

void QgsProjectionSelectionWidget::setSourceEnsemble ( const QString & ensemble )

Sets the original source ensemble datum name.

If set, CRS accuracy warnings will not be shown when the selected CRS in the widget has a matching ensemble datum, regardless of the ensemble's accuracy.

See also: sourceEnsemble()

Since: QGIS 3.20

Definition at line 351 of file qgsprojectionselectionwidget.cpp.

◆ showAccuracyWarnings()

bool QgsProjectionSelectionWidget::showAccuracyWarnings ( ) const

Returns true if the widget will show a warning to users when they select a CRS which has low accuracy.

See also: setShowAccuracyWarnings()

Since: QGIS 3.20

Definition at line 360 of file qgsprojectionselectionwidget.cpp.

◆ sourceEnsemble()

QString QgsProjectionSelectionWidget::sourceEnsemble ( ) const

Returns the original source ensemble datum name.

If set, CRS accuracy warnings will not be shown when the selected CRS in the widget has a matching ensemble datum, regardless of the ensemble's accuracy.

See also: setSourceEnsemble()

Since: QGIS 3.20

Definition at line 336 of file qgsprojectionselectionwidget.cpp.

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

/build/qgis-3.24.2+99sid/src/gui/qgsprojectionselectionwidget.h
/build/qgis-3.24.2+99sid/src/gui/qgsprojectionselectionwidget.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ CrsOption

Constructor & Destructor Documentation

◆ QgsProjectionSelectionWidget()

Member Function Documentation

◆ cleared

◆ crs()

◆ crsChanged

◆ crsOptionText()

◆ dialogTitle()

◆ dragEnterEvent()

◆ dragLeaveEvent()

◆ dropEvent()

◆ optionVisible()

◆ selectCrs

◆ setCrs

◆ setDialogTitle()

◆ setLayerCrs

◆ setMessage()

◆ setNotSetText()

◆ setOptionVisible()

◆ setShowAccuracyWarnings()

◆ setSourceEnsemble()

◆ showAccuracyWarnings()

◆ sourceEnsemble()