Add eyelid to quickly enable or disable a symbol layer in the layer styling panel

The eyelid icon is only available if the layer is not driven by a data defined properties

Author: CeliaBuira

python/PyQt6/gui/auto_generated/symbology/qgssymbolselectordialog.sip.in

@@ -259,6 +259,7 @@ Emitted when the symbol defined in the dialog is modified.
 
 };
 
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

src/gui/symbology/qgssymbollayermodel.cpp

@@ -249,11 +249,17 @@ QVariant QgsSymbolLayerModel::data( const QModelIndex &index, int role ) const
   if ( !index.isValid() )
     return QVariant();
 
-  QgsSymbolLayerModelNode *node = index2node( index );
-  if ( !node )
-    return QVariant();
 
-  return node->data( role );
+  if ( index.column() == NameColumn )
+  {
+    QgsSymbolLayerModelNode *node = index2node( index );
+    if ( !node )
+      return QVariant();
+
+    return node->data( role );
+  }
+
+  return QVariant();
 };
 
 int QgsSymbolLayerModel::rowCount( const QModelIndex &parent ) const
@@ -267,7 +273,7 @@ int QgsSymbolLayerModel::rowCount( const QModelIndex &parent ) const
 
 int QgsSymbolLayerModel::columnCount( const QModelIndex & ) const
 {
-  return 1;
+  return 2;
 };
 
 QModelIndex QgsSymbolLayerModel::index( int row, int column, const QModelIndex &parent ) const

src/gui/symbology/qgssymbollayermodel.h

@@ -244,6 +244,12 @@ class GUI_EXPORT QgsSymbolLayerModel : public QAbstractItemModel
     //! Returns the root node of the model.
     QgsSymbolLayerModelNode *rootNode() const { return mRootNode.get(); }
 
+    //! Columns in the model.
+    enum Columns
+    {
+      NameColumn = 0,
+      EyelidColumn
+    };
 
   private:
     QModelIndex indexOfParentTreeNode( QgsSymbolLayerModelNode *parentNode ) const;

src/gui/symbology/qgssymbolselectordialog.cpp

@@ -115,6 +115,43 @@ void DataDefinedRestorer::restore()
   save();
 }
 
+EyelidLayerDelegate::EyelidLayerDelegate( QTreeView *parent )
+  : QStyledItemDelegate( parent )
+  , mLayersTree( parent )
+{}
+
+void EyelidLayerDelegate::paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const
+{
+  QStyledItemDelegate::paint( painter, option, index );
+
+
+  QgsSymbolLayerModel *symbolLayerModel = static_cast<QgsSymbolLayerModel *>( mLayersTree->model() );
+
+  QgsSymbolLayerModelNode *node = symbolLayerModel->index2node( index );
+
+  if ( !node || !node->isLayer() )
+    return;
+
+  QgsSymbolLayer *symbolLayer = node->layer();
+
+  QIcon icon;
+  if ( symbolLayer->dataDefinedProperties().isActive( QgsSymbolLayer::Property::LayerEnabled ) )
+  {
+    icon = QgsApplication::getThemeIcon( "/mIconDataDefineExpressionOn.svg" );
+  }
+  else if ( symbolLayer->enabled() )
+  {
+    icon = QgsApplication::getThemeIcon( "/mActionShowAllLayers.svg" );
+  }
+  else
+  {
+    icon = QgsApplication::getThemeIcon( "/mActionHideAllLayers.svg" );
+  }
+
+  const QRect iconRect( option.rect.left() + ( option.rect.width() - 16 ) / 2, option.rect.top() + ( option.rect.height() - 16 ) / 2, 16, 16 );
+  icon.paint( painter, iconRect );
+}
+
 ///@endcond
 
 //////////
@@ -183,6 +220,15 @@ QgsSymbolSelectorWidget::QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *s
   layersTree->setModel( mSymbolLayersModel );
   layersTree->setHeaderHidden( true );
 
+  layersTree->header()->setSectionResizeMode( QgsSymbolLayerModel::NameColumn, QHeaderView::Stretch );
+  layersTree->header()->setMinimumSectionSize( 10 );
+  layersTree->header()->setStretchLastSection( false );
+  layersTree->header()->resizeSection( QgsSymbolLayerModel::EyelidColumn, 20 );
+
+  EyelidLayerDelegate *eyeDelegate = new EyelidLayerDelegate( layersTree );
+  layersTree->setItemDelegateForColumn( QgsSymbolLayerModel::EyelidColumn, eyeDelegate );
+  connect( layersTree, &QTreeView::clicked, this, &QgsSymbolSelectorWidget::eyelidClicked );
+
   //get first feature from layer for previews
   if ( mVectorLayer )
   {
@@ -476,6 +522,35 @@ void QgsSymbolSelectorWidget::symbolChanged()
   connect( layersTree->selectionModel(), &QItemSelectionModel::currentChanged, this, &QgsSymbolSelectorWidget::layerChanged );
 }
 
+void QgsSymbolSelectorWidget::eyelidClicked( const QModelIndex &index )
+{
+  if ( index.column() == QgsSymbolLayerModel::EyelidColumn )
+  {
+    QgsSymbolLayerModel *symbolLayerModel = static_cast<QgsSymbolLayerModel *>( layersTree->model() );
+    QgsSymbolLayerModelNode *node = symbolLayerModel->index2node( index );
+
+    if ( !node )
+      return;
+
+    if ( !node->isLayer() )
+      return;
+
+    QgsSymbolLayer *symbolLayer = node->layer();
+    if ( symbolLayer->dataDefinedProperties().isActive( QgsSymbolLayer::Property::LayerEnabled ) )
+    {
+      return;
+    }
+
+    symbolLayer->setEnabled( !symbolLayer->enabled() );
+
+    updatePreview();
+    updateUi();
+    updateLayerPreview();
+    layerChanged();
+    emit symbolModified();
+  }
+}
+
 void QgsSymbolSelectorWidget::setWidget( QWidget *widget )
 {
   const int index = stackedWidget->addWidget( widget );

src/gui/symbology/qgssymbolselectordialog.h

@@ -29,6 +29,7 @@
 #include <QDialogButtonBox>
 #include <QPointer>
 #include <QStandardItemModel>
+#include <QStyledItemDelegate>
 
 class QgsStyle;
 class QgsSymbol;
@@ -76,6 +77,20 @@ class DataDefinedRestorer : public QObject
 
     void save();
 };
+
+class EyelidLayerDelegate : public QStyledItemDelegate SIP_SKIP
+{
+    Q_OBJECT
+  public:
+    EyelidLayerDelegate( QTreeView *parent );
+
+  protected:
+    void paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
+
+  private:
+    QTreeView *mLayersTree;
+};
+
 ///@endcond
 #endif
 
@@ -264,6 +279,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget : public QgsPanelWidget, private Ui::Qg
      * \param widget The widget to set to configure the active symbol layer.
      */
     void setWidget( QWidget *widget );
+    void eyelidClicked( const QModelIndex &index );
 
     QgsStyle *mStyle = nullptr;
     QgsSymbol *mSymbol = nullptr;
@@ -402,4 +418,5 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog
     QDialogButtonBox *mButtonBox = nullptr;
 };
 
+
 #endif