Use combo box instead of tab in projection selection dialog

to select CRS type, and split widget out from dialog class
qgis · Jan 11, 2022 · e692969 · e692969
1 parent ac11fc7
commit e692969
Show file tree

Hide file tree

Showing 4 changed files with 576 additions and 196 deletions.
diff --git a/python/gui/auto_generated/qgsprojectionselectiondialog.sip.in b/python/gui/auto_generated/qgsprojectionselectiondialog.sip.in
@@ -10,6 +10,120 @@
 
 
 
+class QgsCrsSelectionWidget : QgsPanelWidget
+{
+%Docstring(signature="appended")
+A generic widget allowing users to pick a Coordinate Reference System (or define their own).
+
+.. versionadded:: 3.24
+%End
+
+%TypeHeaderCode
+#include "qgsprojectionselectiondialog.h"
+%End
+  public:
+
+    enum class CrsType
+    {
+      Predefined,
+      Custom,
+    };
+
+    QgsCrsSelectionWidget( QWidget *parent /TransferThis/ = 0 );
+%Docstring
+Constructor for QgsCrsSelectionWidget, with the specified ``parent`` widget.
+%End
+
+    ~QgsCrsSelectionWidget();
+
+    QgsCoordinateReferenceSystem crs() const;
+%Docstring
+Returns the CRS currently selected in the widget.
+
+.. seealso:: :py:func:`setCrs`
+%End
+
+    void setMessage( const QString &message );
+%Docstring
+Sets a ``message`` to show in the dialog.
+%End
+
+    void setShowNoCrs( bool show );
+%Docstring
+Sets whether a "no/invalid" CRS option should be shown. If this
+option is selected, calling :py:func:`~QgsCrsSelectionWidget.crs` will return an invalid :py:class:`QgsCoordinateReferenceSystem`.
+
+.. seealso:: :py:func:`showNoCrs`
+%End
+
+    bool showNoCrs() const;
+%Docstring
+Returns whether the "no/invalid" CRS option is shown. If this
+option is selected, calling :py:func:`~QgsCrsSelectionWidget.crs` will return an invalid :py:class:`QgsCoordinateReferenceSystem`.
+
+.. seealso:: :py:func:`setShowNoCrs`
+%End
+
+    void setNotSetText( const QString &text, const QString &description = QString() );
+%Docstring
+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 :py:func:`~QgsCrsSelectionWidget.setShowNoCrs`.
+
+The ``description`` argument can be used to specify a detailed description which
+is shown when the option is selected.
+%End
+
+    bool hasValidSelection() const;
+%Docstring
+Returns ``True`` if the widget has a valid CRS defined.
+%End
+
+  public slots:
+
+    void setCrs( const QgsCoordinateReferenceSystem &crs );
+%Docstring
+Sets the ``crs`` to show within the widget.
+
+.. seealso:: :py:func:`crs`
+%End
+
+    void setOgcWmsCrsFilter( const QSet<QString> &crsFilter );
+%Docstring
+filters this dialog by the given CRSs
+
+Sets this dialog to filter the available CRSs to those listed
+by the given Coordinate Reference Systems.
+
+:param crsFilter: a list of OGC Coordinate Reference Systems to filter the
+                  list of CRS 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.
+%End
+
+  signals:
+
+    void crsChanged();
+%Docstring
+Emitted when the CRS defined in the widget is changed.
+%End
+
+    void crsDoubleClicked( const QgsCoordinateReferenceSystem &crs );
+%Docstring
+Emitted when a CRS entry in the widget is double-clicked.
+%End
+
+    void hasValidSelectionChanged( bool isValid );
+%Docstring
+Emitted when the widget has a valid selection or not.
+%End
+
+};
+
+
+
 class QgsProjectionSelectionDialog : QDialog
 {
 %Docstring(signature="appended")
@@ -44,8 +158,6 @@ the you probably want to look at :py:class:`QgsProjectionSelectionWidget` instea
 Constructor for QgsProjectionSelectionDialog.
 %End
 
-    ~QgsProjectionSelectionDialog();
-
     QgsCoordinateReferenceSystem crs() const;
 %Docstring
 Returns the CRS currently selected in the widget.
@@ -91,11 +203,14 @@ option is selected, calling :py:func:`~QgsProjectionSelectionDialog.crs` will re
 .. versionadded:: 3.0
 %End
 
-    void setNotSetText( const QString &text );
+    void setNotSetText( const QString &text, const QString &description = QString() );
 %Docstring
 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 :py:func:`~QgsProjectionSelectionDialog.setShowNoProjection`.
 
+Since QGIS 3.24, the ``description`` argument can be used to specify a detailed description which
+is shown when the option is selected.
+
 .. versionadded:: 3.16
 %End