QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Slots | Public Member Functions | List of all members
QgsProjectionSelectionDialog Class Reference

A generic dialog to prompt the user for a Coordinate Reference System. More...

#include <qgsprojectionselectiondialog.h>

Inheritance diagram for QgsProjectionSelectionDialog:
Inheritance graph
[legend]

Public Slots

void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the initial crs to show within the dialog. More...
 
void setOgcWmsCrsFilter (const QSet< QString > &crsFilter)
 filters this dialog by the given CRSs More...
 

Public Member Functions

 QgsProjectionSelectionDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 Constructor for QgsProjectionSelectionDialog. More...
 
 ~QgsProjectionSelectionDialog () override
 
QgsCoordinateReferenceSystem crs () const
 Returns the CRS currently selected in the widget. More...
 
void setMessage (const QString &message)
 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 setRequireValidSelection ()
 Sets the dialog to require a valid selection only, preventing users from accepting the dialog if no selection is present. More...
 
void setShowNoProjection (bool show)
 Sets whether a "no/invalid" projection option should be shown. More...
 
void showNoCrsForLayerMessage ()
 When called, the dialog will show a default "layer has no CRS set" message above the projection selector. More...
 
bool showNoProjection () const
 Returns whether the "no/invalid" projection option is shown. More...
 

Detailed Description

A generic dialog to prompt the user for a Coordinate Reference System.

Typically you will use this when you want to prompt the user for a coordinate system identifier e.g. from a plugin you might do this to get an epsg code:

mySelector = QgsProjectionSelectionDialog( iface.mainWindow() )
mySelector.setCrs( crs )
if mySelector.exec():
mCrs = mySelector.crs()
This class represents a coordinate reference system (CRS).
A generic dialog to prompt the user for a Coordinate Reference System.

If you wish to embed the projection selector into an existing dialog the you probably want to look at QgsProjectionSelectionWidget instead.

Since
QGIS 3.0

Definition at line 51 of file qgsprojectionselectiondialog.h.

Constructor & Destructor Documentation

◆ QgsProjectionSelectionDialog()

QgsProjectionSelectionDialog::QgsProjectionSelectionDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 
)

Constructor for QgsProjectionSelectionDialog.

Definition at line 27 of file qgsprojectionselectiondialog.cpp.

◆ ~QgsProjectionSelectionDialog()

QgsProjectionSelectionDialog::~QgsProjectionSelectionDialog ( )
override

Definition at line 45 of file qgsprojectionselectiondialog.cpp.

Member Function Documentation

◆ crs()

QgsCoordinateReferenceSystem QgsProjectionSelectionDialog::crs ( ) const

Returns the CRS currently selected in the widget.

See also
setCrs()
Since
QGIS 3.0

Definition at line 91 of file qgsprojectionselectiondialog.cpp.

◆ setCrs

void QgsProjectionSelectionDialog::setCrs ( const QgsCoordinateReferenceSystem crs)
slot

Sets the initial crs to show within the dialog.

See also
crs()
Since
QGIS 3.0

Definition at line 96 of file qgsprojectionselectiondialog.cpp.

◆ setMessage()

void QgsProjectionSelectionDialog::setMessage ( const QString &  message)

Sets a message to show in the dialog.

See also
showNoCrsForLayerMessage()

Definition at line 51 of file qgsprojectionselectiondialog.cpp.

◆ setNotSetText()

void QgsProjectionSelectionDialog::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 76 of file qgsprojectionselectiondialog.cpp.

◆ setOgcWmsCrsFilter

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

filters this dialog by the given CRSs

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

Parameters
crsFiltera 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.
Warning
This function's behavior is undefined if it is called after the dialog is shown.

Definition at line 101 of file qgsprojectionselectiondialog.cpp.

◆ setRequireValidSelection()

void QgsProjectionSelectionDialog::setRequireValidSelection ( )

Sets the dialog to require a valid selection only, preventing users from accepting the dialog if no selection is present.

Since
QGIS 3.18

Definition at line 81 of file qgsprojectionselectiondialog.cpp.

◆ setShowNoProjection()

void QgsProjectionSelectionDialog::setShowNoProjection ( bool  show)

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()
Since
QGIS 3.0

Definition at line 66 of file qgsprojectionselectiondialog.cpp.

◆ showNoCrsForLayerMessage()

void QgsProjectionSelectionDialog::showNoCrsForLayerMessage ( )

When called, the dialog will show a default "layer has no CRS set" message above the projection selector.

See also
setMessage()
Since
QGIS 3.16

Definition at line 58 of file qgsprojectionselectiondialog.cpp.

◆ showNoProjection()

bool QgsProjectionSelectionDialog::showNoProjection ( ) const

Returns whether the "no/invalid" projection option is shown.

If this option is selected, calling crs() will return an invalid QgsCoordinateReferenceSystem.

See also
setShowNoProjection()
Since
QGIS 3.0

Definition at line 71 of file qgsprojectionselectiondialog.cpp.


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