[addlayerbutton] Use enum for window mode instead of booleans

Author: elpaso

python/core/qgsproviderregistry.sip

@@ -35,6 +35,13 @@ class QgsProviderRegistry
 %End
   public:
 
+    enum WidgetMode
+    {
+      None,
+      Embedded,
+      Manager,
+    };
+
     static QgsProviderRegistry *instance( const QString &pluginPath = QString::null );
 %Docstring
 Means of accessing canonical single instance
@@ -88,7 +95,9 @@ Set library directory where to search for plugins
 %End
 
     QWidget *createSelectionWidget( const QString &providerKey,
-                                    QWidget *parent = 0, Qt::WindowFlags fl = Qt::WindowFlags(), bool embeddedMode = false );
+                                    QWidget *parent = 0,
+                                    Qt::WindowFlags fl = Qt::WindowFlags(),
+                                    QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None );
 %Docstring
  Returns a new widget for selecting layers from a provider.
  Either the ``parent`` widget must be set or the caller becomes

python/gui/qgsowssourceselect.sip

@@ -23,7 +23,7 @@ class QgsOWSSourceSelect : QDialog
     };
 
     //! Constructor
-    QgsOWSSourceSelect( const QString &service, QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags, bool managerMode = false, bool embeddedMode = false );
+    QgsOWSSourceSelect( const QString &service, QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &fl = QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None);
     //! Destructor
     ~QgsOWSSourceSelect();
 

src/app/ogr/qgsopenvectorlayerdialog.cpp

@@ -31,13 +31,13 @@
 #include "qgscontexthelp.h"
 #include "qgsapplication.h"
 
-QgsOpenVectorLayerDialog::QgsOpenVectorLayerDialog( QWidget *parent, Qt::WindowFlags fl, bool embeddedMode )
+QgsOpenVectorLayerDialog::QgsOpenVectorLayerDialog( QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode )
   : QDialog( parent, fl ),
-    mEmbeddedMode( embeddedMode )
+    mWidgetMode( widgetMode )
 {
   setupUi( this );
 
-  if ( mEmbeddedMode )
+  if ( mWidgetMode != QgsProviderRegistry::WidgetMode::None )
   {
     buttonBox->removeButton( buttonBox->button( QDialogButtonBox::Cancel ) );
   }
@@ -387,7 +387,7 @@ void QgsOpenVectorLayerDialog::accept()
   // Save the used encoding
   settings.setValue( QStringLiteral( "UI/encoding" ), encoding() );
 
-  if ( ! mEmbeddedMode )
+  if ( mWidgetMode == QgsProviderRegistry::WidgetMode::None )
   {
     QDialog::accept();
   }

src/app/ogr/qgsopenvectorlayerdialog.h

@@ -22,6 +22,7 @@
 #include <ui_qgsopenvectorlayerdialogbase.h>
 #include <QDialog>
 #include "qgshelp.h"
+#include "qgsproviderregistry.h"
 
 /**
  *  Class for a  dialog to select the type and source for ogr vectors, supports
@@ -32,7 +33,7 @@ class QgsOpenVectorLayerDialog : public QDialog, private Ui::QgsOpenVectorLayerD
     Q_OBJECT
 
   public:
-    QgsOpenVectorLayerDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = 0, bool embeddedMode = false );
+    QgsOpenVectorLayerDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = 0, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None );
     ~QgsOpenVectorLayerDialog();
     //! Opens a dialog to select a file datasource*/
     QStringList openFile();
@@ -54,7 +55,7 @@ class QgsOpenVectorLayerDialog : public QDialog, private Ui::QgsOpenVectorLayerD
     //! Stores the datasource type
     QString mDataSourceType;
     //! Embedded dialog (do not call parent's accept) and emit signals
-    bool mEmbeddedMode;
+    QgsProviderRegistry::WidgetMode mWidgetMode = QgsProviderRegistry::WidgetMode::None;
 
   private slots:
     //! Opens the create connection dialog to build a new connection

src/app/qgsdatasourcemanagerdialog.cpp

@@ -48,7 +48,7 @@ QgsDataSourceManagerDialog::QgsDataSourceManagerDialog( QgsMapCanvas *mapCanvas,
   ui->mOptionsStackedWidget->addWidget( mBrowserWidget );
 
   // VECTOR Layers (completely different interface: it's not a provider)
-  QgsOpenVectorLayerDialog *ovl = new QgsOpenVectorLayerDialog( this, Qt::Widget, true );
+  QgsOpenVectorLayerDialog *ovl = new QgsOpenVectorLayerDialog( this, Qt::Widget, QgsProviderRegistry::WidgetMode::Embedded );
   ui->mOptionsStackedWidget->addWidget( ovl );
   QListWidgetItem *ogrItem = new QListWidgetItem( tr( "Vector files" ), ui->mOptionsListWidget );
   ogrItem->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "/mActionAddOgrLayer.svg" ) ) );
@@ -129,7 +129,7 @@ void QgsDataSourceManagerDialog::vectorLayersAdded( const QStringList &layerQStr
 
 QDialog *QgsDataSourceManagerDialog::providerDialog( const QString providerKey, const QString providerName, const QString icon )
 {
-  QDialog *dlg = dynamic_cast<QDialog *>( QgsProviderRegistry::instance()->createSelectionWidget( providerKey, this, Qt::Widget, true ) );
+  QDialog *dlg = dynamic_cast<QDialog *>( QgsProviderRegistry::instance()->createSelectionWidget( providerKey, this, Qt::Widget, QgsProviderRegistry::WidgetMode::Embedded ) );
   if ( !dlg )
   {
     QMessageBox::warning( this, providerName, tr( "Cannot get %1 select dialog from provider %2." ).arg( providerName, providerKey ) );

src/core/qgsproviderregistry.cpp

@@ -438,18 +438,18 @@ int QgsProviderRegistry::providerCapabilities( const QString &providerKey ) cons
 }
 
 // This should be QWidget, not QDialog
-typedef QWidget *selectFactoryFunction_t( QWidget *parent, Qt::WindowFlags fl, bool embeddedMode );
+typedef QWidget *selectFactoryFunction_t( QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode );
 
 QWidget *QgsProviderRegistry::createSelectionWidget( const QString &providerKey,
-    QWidget *parent, Qt::WindowFlags fl, bool embeddedMode )
+    QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode )
 {
   selectFactoryFunction_t *selectFactory =
     reinterpret_cast< selectFactoryFunction_t * >( cast_to_fptr( function( providerKey, "selectWidget" ) ) );
 
   if ( !selectFactory )
     return nullptr;
 
-  return selectFactory( parent, fl, embeddedMode );
+  return selectFactory( parent, fl, widgetMode );
 }
 
 QFunctionPointer QgsProviderRegistry::function( QString const &providerKey,

src/core/qgsproviderregistry.h

@@ -53,6 +53,15 @@ class CORE_EXPORT QgsProviderRegistry
 
   public:
 
+    //! Different ways a source select dialog can be used
+    //! (embedded is for the data source manager dialog)
+    enum WidgetMode
+    {
+      None,
+      Embedded,
+      Manager,
+    };
+
     //! Means of accessing canonical single instance
     static QgsProviderRegistry *instance( const QString &pluginPath = QString::null );
 
@@ -98,7 +107,9 @@ class CORE_EXPORT QgsProviderRegistry
      * responsible for deleting the returned widget.
      */
     QWidget *createSelectionWidget( const QString &providerKey,
-                                    QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::WindowFlags(), bool embeddedMode = false );
+                                    QWidget *parent = nullptr,
+                                    Qt::WindowFlags fl = Qt::WindowFlags(),
+                                    QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None );
 
     /**
      * Get pointer to provider function

src/gui/qgsowssourceselect.cpp

@@ -54,16 +54,15 @@
 #include <QNetworkRequest>
 #include <QNetworkReply>
 
-QgsOWSSourceSelect::QgsOWSSourceSelect( const QString &service, QWidget *parent, Qt::WindowFlags fl, bool embeddedMode, bool managerMode )
+QgsOWSSourceSelect::QgsOWSSourceSelect( const QString &service, QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode )
   : QDialog( parent, fl )
   , mService( service )
-  , mManagerMode( managerMode )
-  , mEmbeddedMode( embeddedMode )
+  , mWidgetMode( widgetMode )
   , mCurrentTileset( nullptr )
 {
   setupUi( this );
 
-  if ( mEmbeddedMode )
+  if ( mWidgetMode != QgsProviderRegistry::WidgetMode::None )
   {
     buttonBox->removeButton( buttonBox->button( QDialogButtonBox::Close ) );
   }
@@ -90,7 +89,7 @@ QgsOWSSourceSelect::QgsOWSSourceSelect( const QString &service, QWidget *parent,
   // 'Prefer network' is the default noted in the combobox's tool tip
   mCacheComboBox->setCurrentIndex( mCacheComboBox->findData( QNetworkRequest::PreferNetwork ) );
 
-  if ( !mManagerMode )
+  if ( mWidgetMode != QgsProviderRegistry::WidgetMode::Manager )
   {
     connect( mAddButton, &QAbstractButton::clicked, this, &QgsOWSSourceSelect::addClicked );
     //set the current project CRS if available

src/gui/qgsowssourceselect.h

@@ -25,6 +25,7 @@
 #include "qgsdatasourceuri.h"
 #include "qgsguiutils.h"
 #include "qgscontexthelp.h"
+#include "qgsproviderregistry.h"
 
 #include <QStringList>
 #include <QPushButton>
@@ -60,7 +61,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel
     };
 
     //! Constructor
-    QgsOWSSourceSelect( const QString &service, QWidget *parent = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, bool embeddedMode = false, bool managerMode = false );
+    QgsOWSSourceSelect( const QString &service, QWidget *parent = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::None );
 
     ~QgsOWSSourceSelect();
 
@@ -172,7 +173,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel
     bool mManagerMode;
 
     //! Embedded mode, without 'Close'
-    bool mEmbeddedMode;
+    QgsProviderRegistry::WidgetMode mWidgetMode = QgsProviderRegistry::WidgetMode::None;
 
 
     /**

src/gui/qgssourceselectdialog.cpp

@@ -50,7 +50,11 @@ class QgsSourceSelectItemDelegate : public QItemDelegate
 
 
 QgsSourceSelectDialog::QgsSourceSelectDialog( const QString &serviceName, ServiceType serviceType, QWidget *parent, Qt::WindowFlags fl )
-  : QDialog( parent, fl ), mServiceName( serviceName ), mServiceType( serviceType ), mBuildQueryButton( 0 ), mImageEncodingGroup( 0 )
+  : QDialog( parent, fl ),
+    mServiceName( serviceName ),
+    mServiceType( serviceType ),
+    mBuildQueryButton( 0 ),
+    mImageEncodingGroup( 0 )
 {
   setupUi( this );
   setWindowTitle( QStringLiteral( "Add %1 Layer from a Server" ).arg( mServiceName ) );