Rename projection selection widgets and cleanup API

The current names for QgsProjectionSelector and QgsGenericProjectionSelector are confusing
qgis · Feb 27, 2017 · 5312965 · 5312965
1 parent 887ca6f
commit 5312965
Show file tree

Hide file tree

Showing 41 changed files with 394 additions and 499 deletions.
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -257,6 +257,7 @@ should now call QgsCoordinateReferenceSystem::invalidateCache() and QgsCoordinat
 - QgsFormAnnotationItem. Use QgsFormAnnotation instead.
 - QgsHtmlAnnotationItem. Use QgsHtmlAnnotation instead.
 - QgsHttpTransaction. This class was outdated and code should be ported to native Qt or Python implementations.
+- QgsGenericProjectionSelector. Use QgsProjectionSelectionTreeWidget instead.
 - QgsLabel and QgsLabelAttributes. Replaced by labeling based on PAL library, see QgsLabelingEngine.
 - QgsLabelingEngineInterface. Replaced by QgsLabelingEngine.
 - QgsLegendInterface was removed. It was replaced by layer tree API (QgsLayerTreeNode class and others).
@@ -276,6 +277,7 @@ should now call QgsCoordinateReferenceSystem::invalidateCache() and QgsCoordinat
 - QgsRendererV2DataDefinedMenus was removed. Use QgsPropertyOverrideButton instead.
 - QgsSizeScaleWidget. Use QgsPropertyAssistantWidget instead.
 - QgsLegacyHelpers.
+- QgsProjectionSelector. Use QgsProjectionSelectionDialog instead.
 - QgsProviderCountCalcEvent and QgsProviderExtentCalcEvent. These classes were unused in QGIS core and unmaintained.
 - QgsWebviewWidgetWrapper was removed. Use QgsExternalResourceWidgetWrapper instead.
 - QgsEditorWidgetConfig was removed. Use QVariantMap instead.

diff --git a/python/gui/gui.sip b/python/gui/gui.sip
@@ -81,7 +81,6 @@
 %Include qgsfloatingwidget.sip
 %Include qgsfocuswatcher.sip
 %Include qgsformannotation.sip
-%Include qgsgenericprojectionselector.sip
 %Include qgsgeometryrubberband.sip
 %Include qgsgradientcolorrampdialog.sip
 %Include qgsgradientstopeditor.sip
@@ -138,8 +137,9 @@
 %Include qgspluginmanagerinterface.sip
 %Include qgspresetcolorrampdialog.sip
 %Include qgsprevieweffect.sip
+%Include qgsprojectionselectiondialog.sip
+%Include qgsprojectionselectiontreewidget.sip
 %Include qgsprojectionselectionwidget.sip
-%Include qgsprojectionselector.sip
 %Include qgspropertyassistantwidget.sip
 %Include qgspropertyoverridebutton.sip
 %Include qgsquerybuilder.sip

diff --git a/python/gui/qgsgenericprojectionselector.sip b/python/gui/qgsgenericprojectionselector.sip
diff --git a/python/gui/qgsprojectionselectiondialog.sip b/python/gui/qgsprojectionselectiondialog.sip
@@ -0,0 +1,39 @@
+class QgsProjectionSelectionDialog : QDialog //, private Ui::QgsGenericProjectionSelectorBase
+{
+%TypeHeaderCode
+#include <qgsprojectionselectiondialog.h>
+%End
+
+  public:
+    /**
+     * Constructor
+     */
+    QgsProjectionSelectionDialog( QWidget *parent /TransferThis/ = 0,
+                                  const Qt::WindowFlags& fl = QgisGui::ModalDialogFlags );
+
+    //! Destructor
+    ~QgsProjectionSelectionDialog();
+
+    QgsCoordinateReferenceSystem crs() const;
+
+    void setMessage( const QString& message );
+
+  public slots:
+
+
+    void setCrs( const QgsCoordinateReferenceSystem& crs );
+
+    /**
+     * \brief filters this dialog by the given CRSs
+     *
+     * Sets this dialog to filter the available projections to those listed
+     * by the given Coordinate Reference Systems.
+     *
+     * \param 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.
+     *
+     * \warning This function's behavior is undefined if it is called after the dialog is shown.
+     */
+    void setOgcWmsCrsFilter( const QSet<QString>& crsFilter );
+};
diff --git a/python/gui/qgsprojectionselectiontreewidget.sip b/python/gui/qgsprojectionselectiontreewidget.sip
@@ -0,0 +1,31 @@
+class QgsProjectionSelectionTreeWidget : QWidget
+{
+%TypeHeaderCode
+#include <qgsprojectionselectiontreewidget.h>
+%End
+
+  public:
+    QgsProjectionSelectionTreeWidget( QWidget* parent /TransferThis/ );
+
+    ~QgsProjectionSelectionTreeWidget();
+
+    QgsCoordinateReferenceSystem crs() const;
+
+  public slots:
+
+    void setCrs( const QgsCoordinateReferenceSystem& crs );
+    void setOgcWmsCrsFilter( const QSet<QString>& crsFilter );
+    void pushProjectionToFront();
+
+  signals:
+
+    void crsSelected();
+    void initialized();
+    void projectionDoubleClicked();
+
+  protected:
+    void showEvent( QShowEvent * event );
+
+    void resizeEvent( QResizeEvent * event );
+};
+
diff --git a/python/gui/qgsprojectionselectionwidget.sip b/python/gui/qgsprojectionselectionwidget.sip
@@ -30,7 +30,7 @@ class QgsProjectionSelectionWidget : QWidget
      * Can be used to modify how the projection selector dialog behaves.
      * @returns projection selector dialog
      */
-    QgsGenericProjectionSelector* dialog();
+    QgsProjectionSelectionDialog* dialog();
 
     /** Returns the currently selected CRS for the widget
      * @returns current CRS

diff --git a/python/gui/qgsprojectionselector.sip b/python/gui/qgsprojectionselector.sip
diff --git a/python/plugins/processing/gui/wrappers.py b/python/plugins/processing/gui/wrappers.py
@@ -56,7 +56,7 @@
     QgsFieldComboBox,
     QgsFieldExpressionWidget,
     QgsFieldProxyModel,
-    QgsGenericProjectionSelector,
+    QgsProjectionSelectionDialog,
     QgsMapLayerComboBox,
     QgsProjectionSelectionWidget,
 )
@@ -311,13 +311,13 @@ def createWidget(self):
             return widget
 
     def selectProjection(self):
-        dialog = QgsGenericProjectionSelector(self.widget)
+        dialog = QgsProjectionSelectionDialog(self.widget)
         current_crs = QgsCoordinateReferenceSystem(self.combo.currentText())
         if current_crs.isValid():
-            dialog.setSelectedCrsId(current_crs.srsid())
+            dialog.setCrs(current_crs)
 
         if dialog.exec_():
-            self.setValue(dialog.selectedAuthId())
+            self.setValue(dialog.crs().authid())
 
     def setValue(self, value):
         if self.dialogType == DIALOG_MODELER:

diff --git a/src/app/composer/qgscomposermapgridwidget.cpp b/src/app/composer/qgscomposermapgridwidget.cpp
@@ -22,7 +22,7 @@
 #include "qgsproject.h"
 #include "qgssymbollayerutils.h"
 #include "qgsstyle.h"
-#include "qgsgenericprojectionselector.h"
+#include "qgsprojectionselectiondialog.h"
 #include "qgscomposition.h"
 #include "qgsmapsettings.h"
 #include "qgsexpressionbuilderdialog.h"
@@ -1033,18 +1033,16 @@ void QgsComposerMapGridWidget::on_mMapGridCRSButton_clicked()
     return;
   }
 
-  QgsGenericProjectionSelector crsDialog( this );
+  QgsProjectionSelectionDialog crsDialog( this );
   QgsCoordinateReferenceSystem crs = mComposerMapGrid->crs();
-  QString currentAuthId = crs.isValid() ? crs.authid() : mComposerMap->crs().authid();
-  crsDialog.setSelectedAuthId( currentAuthId );
+  crsDialog.setCrs( crs.isValid() ? crs : mComposerMap->crs() );
 
   if ( crsDialog.exec() == QDialog::Accepted )
   {
     mComposerMap->beginCommand( tr( "Grid CRS changed" ) );
-    QString selectedAuthId = crsDialog.selectedAuthId();
-    mComposerMapGrid->setCrs( QgsCoordinateReferenceSystem( selectedAuthId ) );
+    mComposerMapGrid->setCrs( crsDialog.crs() );
     mComposerMap->updateBoundingRect();
-    mMapGridCRSButton->setText( selectedAuthId );
+    mMapGridCRSButton->setText( crsDialog.crs().authid() );
     mComposerMap->endCommand();
   }
 }

diff --git a/src/app/dwg/qgsdwgimportdialog.cpp b/src/app/dwg/qgsdwgimportdialog.cpp
@@ -38,7 +38,7 @@
 #include "qgslinesymbollayer.h"
 #include "qgspallabeling.h"
 #include "qgsmapcanvas.h"
-#include "qgsgenericprojectionselector.h"
+#include "qgsprojectionselectiondialog.h"
 #include "qgsmessagelog.h"
 #include "qgslogger.h"
 #include "qgsproperty.h"

diff --git a/src/app/ogr/qgsvectorlayersaveasdialog.cpp b/src/app/ogr/qgsvectorlayersaveasdialog.cpp
@@ -17,7 +17,7 @@
  ***************************************************************************/
 #include "qgslogger.h"
 #include "qgsvectorlayersaveasdialog.h"
-#include "qgsgenericprojectionselector.h"
+#include "qgsprojectionselectiondialog.h"
 #include "qgsvectordataprovider.h"
 #include "qgscoordinatereferencesystem.h"
 #include "qgseditorwidgetfactory.h"