Integration of embedded widgets into layer tree + config GUI

Author: wonder-sk

python/core/qgsdataitem.sip

@@ -75,7 +75,7 @@ class QgsDataItem : QObject
 
     /** Create children. Children are not expected to have parent set.
      * This method MUST BE THREAD SAFE. */
-    virtual QVector<QgsDataItem*> createChildren();
+    virtual QVector<QgsDataItem*> createChildren() /Factory/;
 
     enum State
     {

src/app/qgisapp.cpp

@@ -2815,6 +2815,7 @@ void QgisApp::initLayerTreeView()
   model->setFlag( QgsLayerTreeModel::AllowNodeRename );
   model->setFlag( QgsLayerTreeModel::AllowNodeChangeVisibility );
   model->setFlag( QgsLayerTreeModel::ShowLegendAsTree );
+  model->setFlag( QgsLayerTreeModel::UseEmbeddedWidgets );
   model->setAutoCollapseLegendNodes( 10 );
 
   mLayerTreeView->setModel( model );

src/app/qgsapplayertreeviewmenuprovider.cpp

@@ -237,6 +237,9 @@ QMenu* QgsAppLayerTreeViewMenuProvider::createContextMenu()
         duplicateLayersAction->setEnabled( false );
       }
 
+      QAction* embeddedAction = menu->addAction( tr( "Embedded widgets..."), this, SLOT( editEmbeddedWidgets() ) );
+      embeddedAction->setProperty( "layerId", layer->id() );
+
       addCustomLayerActions( menu, layer );
 
       if ( layer && QgsProject::instance()->layerIsEmbedded( layer->id() ).isEmpty() )
@@ -555,3 +558,26 @@ void QgsAppLayerTreeViewMenuProvider::setSymbolLegendNodeColor( const QColor &co
   newSymbol->setColor( color );
   node->setSymbol( newSymbol );
 }
+
+#include "qgslayertreeembeddedconfigwidget.h"
+void QgsAppLayerTreeViewMenuProvider::editEmbeddedWidgets()
+{
+  QAction* action = qobject_cast< QAction*>( sender() );
+  if ( !action )
+    return;
+
+  QString layerId = action->property( "layerId" ).toString();
+  QgsLayerTreeLayer* nodeLayer = QgsProject::instance()->layerTreeRoot()->findLayer( layerId );
+  if ( !nodeLayer )
+    return;
+
+  QDialog d;
+  QgsLayerTreeEmbeddedConfigWidget* widget = new QgsLayerTreeEmbeddedConfigWidget(nodeLayer, &d);
+
+  QLayout* l = new QVBoxLayout(&d);
+  l->addWidget(widget);
+  d.setLayout(l);
+  d.exec();
+
+  mView->layerTreeModel()->refreshLayerLegend( nodeLayer );
+}

src/app/qgsapplayertreeviewmenuprovider.h

@@ -69,6 +69,7 @@ class QgsAppLayerTreeViewMenuProvider : public QObject, public QgsLayerTreeViewM
     void setVectorSymbolColor( const QColor &color );
     void editSymbolLegendNodeSymbol();
     void setSymbolLegendNodeColor( const QColor &color );
+    void editEmbeddedWidgets();
 };
 
 #endif // QGSAPPLAYERTREEVIEWMENUPROVIDER_H

src/core/layertree/qgslayertreemodel.cpp

@@ -1149,6 +1149,21 @@ void QgsLayerTreeModel::removeLegendFromLayer( QgsLayerTreeLayer* nodeLayer )
   }
 }
 
+class EmbeddedWidgetLegendNode : public QgsLayerTreeModelLegendNode
+{
+  public:
+    EmbeddedWidgetLegendNode( QgsLayerTreeLayer* nodeL )
+        : QgsLayerTreeModelLegendNode( nodeL )
+    {
+    }
+
+    virtual QVariant data( int role ) const override
+    {
+      Q_UNUSED( role );
+      return QVariant();
+    }
+
+};
 
 void QgsLayerTreeModel::addLegendToLayer( QgsLayerTreeLayer* nodeL )
 {
@@ -1169,6 +1184,16 @@ void QgsLayerTreeModel::addLegendToLayer( QgsLayerTreeLayer* nodeL )
   // apply filtering defined in layer node's custom properties (reordering, filtering, custom labels)
   QgsMapLayerLegendUtils::applyLayerNodeProperties( nodeL, lstNew );
 
+  if ( testFlag( UseEmbeddedWidgets ) )
+  {
+    int widgetsCount = nodeL->customProperty( "embeddedWidgets/count", 0 ).toInt();
+    while ( widgetsCount > 0 )
+    {
+      lstNew.insert( 0, new EmbeddedWidgetLegendNode( nodeL ) );
+      --widgetsCount;
+    }
+  }
+
   QList<QgsLayerTreeModelLegendNode*> filteredLstNew = filterLegendNodes( lstNew );
 
   bool isEmbedded = filteredLstNew.count() == 1 && filteredLstNew[0]->isEmbeddedInParent();

src/core/layertree/qgslayertreemodel.h

@@ -80,6 +80,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
       ShowRasterPreviewIcon      = 0x0002,  //!< Will use real preview of raster layer as icon (may be slow)
       ShowLegendAsTree           = 0x0004,  //!< For legends that support it, will show them in a tree instead of a list (needs also ShowLegend). Added in 2.8
       DeferredLegendInvalidation = 0x0008,  //!< defer legend model invalidation
+      UseEmbeddedWidgets         = 0x0010,  //!< Layer nodes may optionally include extra embedded widgets (if used in QgsLayerTreeView). Added in 2.16
 
       // behavioral flags
       AllowNodeReorder           = 0x1000,  //!< Allow reordering with drag'n'drop

src/core/layertree/qgslayertreenode.h

@@ -58,6 +58,7 @@ class QDomElement;
  * - "embedded_project" - path to the external project (embedded root node only)
  * - "legend/..." - properties for legend appearance customization
  * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
+ * - "embeddedWidgets/..." - properties for embedded widgets (layer node only)
  *
  * @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
  * @note added in 2.4

src/gui/CMakeLists.txt

@@ -153,6 +153,8 @@ SET(QGIS_GUI_SRCS
   editorwidgets/qgsvaluerelationwidgetfactory.cpp
 
   layertree/qgscustomlayerorderwidget.cpp
+  layertree/qgslayertreeembeddedconfigwidget.cpp
+  layertree/qgslayertreeembeddedwidgetregistry.cpp
   layertree/qgslayertreemapcanvasbridge.cpp
   layertree/qgslayertreeview.cpp
   layertree/qgslayertreeviewdefaultactions.cpp
@@ -574,6 +576,8 @@ SET(QGIS_GUI_MOC_HDRS
   editorwidgets/qgsvaluerelationwidgetwrapper.h
 
   layertree/qgscustomlayerorderwidget.h
+  layertree/qgslayertreeembeddedconfigwidget.h
+  layertree/qgslayertreeembeddedwidgetregistry.h
   layertree/qgslayertreemapcanvasbridge.h
   layertree/qgslayertreeview.h
   layertree/qgslayertreeviewdefaultactions.h
@@ -669,6 +673,9 @@ SET(QGIS_GUI_HDRS
   editorwidgets/qgsvaluemapwidgetfactory.h
   editorwidgets/qgsvaluerelationwidgetfactory.h
 
+  layertree/qgslayertreeembeddedconfigwidget.h
+  layertree/qgslayertreeembeddedwidgetregistry.h
+
   raster/qgsrasterrendererwidget.h
 )
 

src/gui/layertree/qgslayertreeembeddedconfigwidget.cpp

@@ -0,0 +1,87 @@
+#include "qgslayertreeembeddedconfigwidget.h"
+
+#include "qgslayertree.h"
+#include "qgslayertreeembeddedwidgetregistry.h"
+
+#include <QStringListModel>
+
+QgsLayerTreeEmbeddedConfigWidget::QgsLayerTreeEmbeddedConfigWidget( QgsLayerTreeLayer* nodeLayer, QWidget* parent )
+    : QWidget( parent )
+    , mNodeLayer( nodeLayer )
+{
+  setupUi( this );
+
+  connect( mBtnAdd, SIGNAL(clicked(bool)), this, SLOT(onAddClicked()));
+  connect( mBtnRemove, SIGNAL(clicked(bool)), this, SLOT(onRemoveClicked()));
+
+  // populate available
+  QStringList lst;
+  Q_FOREACH ( const QString& providerId, QgsLayerTreeEmbeddedWidgetRegistry::instance()->providers() )
+  {
+    QgsLayerTreeEmbeddedWidgetProvider* provider = QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId );
+    lst << provider->id();
+  }
+  mListAvailable->setModel( new QStringListModel( lst, this ) );
+
+  // populate used
+  QStringList lstUsed;
+  int widgetsCount = nodeLayer->customProperty( "embeddedWidgets/count", 0 ).toInt();
+  for ( int i = 0; i < widgetsCount; ++i )
+  {
+    QString providerId = nodeLayer->customProperty( QString( "embeddedWidgets/%1/id" ).arg( i ) ).toString();
+    if ( /*QgsLayerTreeEmbeddedWidgetProvider* provider =*/ QgsLayerTreeEmbeddedWidgetRegistry::instance()->provider( providerId ) )
+    {
+      lstUsed << providerId;
+    }
+  }
+  mListUsed->setModel( new QStringListModel( lstUsed, this ) );
+}
+
+void QgsLayerTreeEmbeddedConfigWidget::onAddClicked()
+{
+  if (!mListAvailable->currentIndex().isValid())
+    return;
+
+  QString providerId = mListAvailable->model()->data( mListAvailable->currentIndex() ).toString();
+  if (QStringListModel* model = qobject_cast<QStringListModel*>(mListUsed->model()))
+  {
+    int row = model->rowCount();
+    model->insertRow( row );
+    model->setData( model->index(row, 0), providerId );
+    //QStringList lst = model->stringList();
+    //lst << providerId;
+    //model->setStringList( lst );
+  }
+
+  updateCustomProperties();
+}
+
+void QgsLayerTreeEmbeddedConfigWidget::onRemoveClicked()
+{
+  if (!mListUsed->currentIndex().isValid())
+    return;
+
+  int row = mListUsed->currentIndex().row();
+  mListUsed->model()->removeRow( row );
+
+  updateCustomProperties();
+}
+
+void QgsLayerTreeEmbeddedConfigWidget::updateCustomProperties()
+{
+  // clear old properties
+  int widgetsCount = mNodeLayer->customProperty( "embeddedWidgets/count", 0 ).toInt();
+  for ( int i = 0; i < widgetsCount; ++i )
+  {
+    mNodeLayer->removeCustomProperty( QString( "embeddedWidgets/%1/id" ).arg( i ) );
+  }
+
+  // setup new properties
+  int newCount = mListUsed->model()->rowCount();
+  mNodeLayer->setCustomProperty( "embeddedWidgets/count", newCount );
+  for ( int i = 0; i < newCount; ++i )
+  {
+    QString providerId = mListUsed->model()->data( mListUsed->model()->index(i, 0) ).toString();
+    mNodeLayer->setCustomProperty( QString( "embeddedWidgets/%1/id" ).arg( i ), providerId );
+  }
+}

src/gui/layertree/qgslayertreeembeddedconfigwidget.h

@@ -0,0 +1,25 @@
+#ifndef QGSLAYERTREEEMBEDDEDCONFIGWIDGET_H
+#define QGSLAYERTREEEMBEDDEDCONFIGWIDGET_H
+
+#include "ui_qgslayertreeembeddedconfigwidget.h"
+
+class QgsLayerTreeLayer;
+
+class GUI_EXPORT QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui::QgsLayerTreeEmbeddedConfigWidget
+{
+    Q_OBJECT
+  public:
+    QgsLayerTreeEmbeddedConfigWidget( QgsLayerTreeLayer* nodeLayer, QWidget* parent = nullptr );
+
+  private slots:
+    void onAddClicked();
+    void onRemoveClicked();
+
+  private:
+    void updateCustomProperties();
+
+  private:
+    QgsLayerTreeLayer* mNodeLayer;
+};
+
+#endif // QGSLAYERTREEEMBEDDEDCONFIGWIDGET_H