QgsLayerTreeEmbeddedWidgetRegistry is no longer a singleton

nyalldawson · nyalldawson · commit a86b93e95770 · 2017-05-15T07:32:01.000+10:00
Moved the global instance to QgsGui::layerTreeEmbeddedWidgetRegistry()
diff --git a/doc/api_break.dox b/doc/api_break.dox
@@ -1308,6 +1308,12 @@ QgsLayerPropertiesWidget        {#qgis_api_break_3_0_QgsLayerPropertiesWidget}
 - expressionContext(), setExpressionContext(), setMapCanvas() and mapCanvas() have been removed in favor of setContext()/context()
 
 
+QgsLayerTreeEmbeddedWidgetRegistry        {#qgis_api_break_3_0_QgsLayerTreeEmbeddedWidgetRegistry}
+----------------------------------
+
+- QgsLayerTreeEmbeddedWidgetRegistry::instance() has been removed. Use QgsGui::layerTreeEmbeddedWidgetRegistry() instead.
+
+
 QgsLayerTreeGroup        {#qgis_api_break_3_0_QgsLayerTreeGroup}
 -----------------
 
diff --git a/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip b/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip
@@ -47,8 +47,7 @@ class QgsLayerTreeEmbeddedWidgetRegistry
 
   public:
 
-    /** Means of accessing canonical single instance */
-    static QgsLayerTreeEmbeddedWidgetRegistry *instance();
+    QgsLayerTreeEmbeddedWidgetRegistry();
 
     ~QgsLayerTreeEmbeddedWidgetRegistry();
 
@@ -66,10 +65,6 @@ class QgsLayerTreeEmbeddedWidgetRegistry
      * Returns true on success, false if the provider was not registered. */
     bool removeProvider( const QString &providerId );
 
-  protected:
-    //! Protected constructor - use instance() to access the registry.
-    QgsLayerTreeEmbeddedWidgetRegistry();
-
   private:
 
     QgsLayerTreeEmbeddedWidgetRegistry( const QgsLayerTreeEmbeddedWidgetRegistry &other );
diff --git a/python/gui/qgsgui.sip b/python/gui/qgsgui.sip
@@ -43,6 +43,12 @@ class QgsGui
  :rtype: QgsShortcutsManager
 %End
 
+    static QgsLayerTreeEmbeddedWidgetRegistry *layerTreeEmbeddedWidgetRegistry();
+%Docstring
+ Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.
+ :rtype: QgsLayerTreeEmbeddedWidgetRegistry
+%End
+
     ~QgsGui();
 
   private:
diff --git a/src/gui/layertree/qgslayertreeembeddedconfigwidget.cpp b/src/gui/layertree/qgslayertreeembeddedconfigwidget.cpp
@@ -17,7 +17,7 @@
 
 #include "qgsmaplayer.h"
 #include "qgslayertreeembeddedwidgetregistry.h"
-
+#include "qgsgui.h"
 #include <QStringListModel>
 #include <QStandardItemModel>
 
@@ -39,9 +39,9 @@ void QgsLayerTreeEmbeddedConfigWidget::setLayer( QgsMapLayer *layer )
   QStandardItemModel *modelUsed = new QStandardItemModel( this );
 
   // populate available
-  Q_FOREACH ( const QString &providerId, QgsLayerTreeEmbeddedWidgetRegistry::instance()->providers() )
+  Q_FOREACH ( const QString &providerId, QgsGui::layerTreeEmbeddedWidgetRegistry()->providers() )
   {
-    QgsLayerTreeEmbeddedWidgetProvider *provider = QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId );
+    QgsLayerTreeEmbeddedWidgetProvider *provider = QgsGui::layerTreeEmbeddedWidgetRegistry()->provider( providerId );
     QStandardItem *item = new QStandardItem( provider->name() );
     item->setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable );
     item->setData( provider->id(), Qt::UserRole + 1 );
@@ -54,7 +54,7 @@ void QgsLayerTreeEmbeddedConfigWidget::setLayer( QgsMapLayer *layer )
   for ( int i = 0; i < widgetsCount; ++i )
   {
     QString providerId = layer->customProperty( QStringLiteral( "embeddedWidgets/%1/id" ).arg( i ) ).toString();
-    if ( QgsLayerTreeEmbeddedWidgetProvider *provider = QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId ) )
+    if ( QgsLayerTreeEmbeddedWidgetProvider *provider = QgsGui::layerTreeEmbeddedWidgetRegistry()->provider( providerId ) )
     {
       QStandardItem *item = new QStandardItem( provider->name() );
       item->setFlags( Qt::ItemIsEnabled | Qt::ItemIsSelectable );
@@ -71,7 +71,7 @@ void QgsLayerTreeEmbeddedConfigWidget::onAddClicked()
     return;
 
   QString providerId = mListAvailable->model()->data( mListAvailable->currentIndex(), Qt::UserRole + 1 ).toString();
-  QgsLayerTreeEmbeddedWidgetProvider *provider = QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId );
+  QgsLayerTreeEmbeddedWidgetProvider *provider = QgsGui::layerTreeEmbeddedWidgetRegistry()->provider( providerId );
   if ( !provider )
     return;
 
diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.cpp b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.cpp
@@ -18,13 +18,6 @@
 #include "qgslayertreeembeddedwidgetsimpl.h"
 
 
-
-QgsLayerTreeEmbeddedWidgetRegistry *QgsLayerTreeEmbeddedWidgetRegistry::instance()
-{
-  static QgsLayerTreeEmbeddedWidgetRegistry *sInstance( new QgsLayerTreeEmbeddedWidgetRegistry() );
-  return sInstance;
-}
-
 QgsLayerTreeEmbeddedWidgetRegistry::QgsLayerTreeEmbeddedWidgetRegistry()
 {
   // populate with default implementations
diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h
@@ -57,15 +57,23 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider
  * Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
  * Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.
  *
+ * QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through
+ * QgsGui::layerTreeEmbeddedWidgetRegistry().
+ *
  * \see QgsLayerTreeEmbeddedWidgetRegistry
  * \since QGIS 2.16
  */
 class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry
 {
   public:
 
-    //! Means of accessing canonical single instance
-    static QgsLayerTreeEmbeddedWidgetRegistry *instance();
+    /**
+     * Constructor for QgsLayerTreeEmbeddedWidgetRegistry/
+     *
+     * QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through
+     * QgsGui::layerTreeEmbeddedWidgetRegistry().
+     */
+    QgsLayerTreeEmbeddedWidgetRegistry();
 
     ~QgsLayerTreeEmbeddedWidgetRegistry();
 
@@ -89,8 +97,6 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry
     bool removeProvider( const QString &providerId );
 
   protected:
-    //! Protected constructor - use instance() to access the registry.
-    QgsLayerTreeEmbeddedWidgetRegistry();
 
     //! storage of all the providers
     QMap<QString, QgsLayerTreeEmbeddedWidgetProvider *> mProviders;
diff --git a/src/gui/layertree/qgslayertreeview.cpp b/src/gui/layertree/qgslayertreeview.cpp
@@ -21,6 +21,7 @@
 #include "qgslayertreemodellegendnode.h"
 #include "qgslayertreeviewdefaultactions.h"
 #include "qgsmaplayer.h"
+#include "qgsgui.h"
 
 #include <QMenu>
 #include <QContextMenuEvent>
@@ -142,7 +143,7 @@ void QgsLayerTreeView::modelRowsInserted( const QModelIndex &index, int start, i
       for ( int i = 0; i < widgetsCount; ++i )
       {
         QString providerId = layer->customProperty( QStringLiteral( "embeddedWidgets/%1/id" ).arg( i ) ).toString();
-        if ( QgsLayerTreeEmbeddedWidgetProvider *provider = QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId ) )
+        if ( QgsLayerTreeEmbeddedWidgetProvider *provider = QgsGui::layerTreeEmbeddedWidgetRegistry()->provider( providerId ) )
         {
           QModelIndex index = layerTreeModel()->legendNode2index( legendNodes[i] );
           setIndexWidget( index, provider->createWidget( layer, i ) );
diff --git a/src/gui/qgsgui.cpp b/src/gui/qgsgui.cpp
@@ -17,6 +17,7 @@
 
 #include "qgsgui.h"
 #include "qgseditorwidgetregistry.h"
+#include "qgslayertreeembeddedwidgetregistry.h"
 #include "qgsshortcutsmanager.h"
 
 QgsGui *QgsGui::instance()
@@ -35,14 +36,21 @@ QgsShortcutsManager *QgsGui::shortcutsManager()
   return instance()->mShortcutsManager;
 }
 
+QgsLayerTreeEmbeddedWidgetRegistry *QgsGui::layerTreeEmbeddedWidgetRegistry()
+{
+  return instance()->mLayerTreeEmbeddedWidgetRegistry;
+}
+
 QgsGui::~QgsGui()
 {
   delete mEditorWidgetRegistry;
   delete mShortcutsManager;
+  delete mLayerTreeEmbeddedWidgetRegistry;
 }
 
 QgsGui::QgsGui()
 {
   mEditorWidgetRegistry = new QgsEditorWidgetRegistry();
   mShortcutsManager = new QgsShortcutsManager();
+  mLayerTreeEmbeddedWidgetRegistry = new QgsLayerTreeEmbeddedWidgetRegistry();
 }
diff --git a/src/gui/qgsgui.h b/src/gui/qgsgui.h
@@ -22,6 +22,7 @@
 
 class QgsEditorWidgetRegistry;
 class QgsShortcutsManager;
+class QgsLayerTreeEmbeddedWidgetRegistry;
 
 /**
  * \ingroup gui
@@ -54,6 +55,11 @@ class GUI_EXPORT QgsGui
      */
     static QgsShortcutsManager *shortcutsManager();
 
+    /**
+     * Returns the global layer tree embedded widget registry, used for registering widgets that may be embedded into layer tree view.
+     */
+    static QgsLayerTreeEmbeddedWidgetRegistry *layerTreeEmbeddedWidgetRegistry();
+
     ~QgsGui();
 
   private:
@@ -62,6 +68,7 @@ class GUI_EXPORT QgsGui
 
     QgsEditorWidgetRegistry *mEditorWidgetRegistry = nullptr;
     QgsShortcutsManager *mShortcutsManager = nullptr;
+    QgsLayerTreeEmbeddedWidgetRegistry *mLayerTreeEmbeddedWidgetRegistry = nullptr;
 
 #ifdef SIP_RUN
     QgsGui( const QgsGui &other );

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`
`18`	`18`	`#include "qgsgui.h"`
`19`	`19`	`#include "qgseditorwidgetregistry.h"`
	`20`	`+#include "qgslayertreeembeddedwidgetregistry.h"`
`20`	`21`	`#include "qgsshortcutsmanager.h"`
`21`	`22`
`22`	`23`	`QgsGui *QgsGui::instance()`
`@@ -35,14 +36,21 @@ QgsShortcutsManager *QgsGui::shortcutsManager()`
`35`	`36`	`return instance()->mShortcutsManager;`
`36`	`37`	`}`
`37`	`38`
	`39`	`+QgsLayerTreeEmbeddedWidgetRegistry *QgsGui::layerTreeEmbeddedWidgetRegistry()`
	`40`	`+{`
	`41`	`+ return instance()->mLayerTreeEmbeddedWidgetRegistry;`
	`42`	`+}`
	`43`	`+`
`38`	`44`	`QgsGui::~QgsGui()`
`39`	`45`	`{`
`40`	`46`	`delete mEditorWidgetRegistry;`
`41`	`47`	`delete mShortcutsManager;`
	`48`	`+ delete mLayerTreeEmbeddedWidgetRegistry;`
`42`	`49`	`}`
`43`	`50`
`44`	`51`	`QgsGui::QgsGui()`
`45`	`52`	`{`
`46`	`53`	`mEditorWidgetRegistry = new QgsEditorWidgetRegistry();`
`47`	`54`	`mShortcutsManager = new QgsShortcutsManager();`
	`55`	`+ mLayerTreeEmbeddedWidgetRegistry = new QgsLayerTreeEmbeddedWidgetRegistry();`
`48`	`56`	`}`