Merge pull request #8612 from elpaso/vector-legend-toggle-items

Add a toggle action to vector layer legend items [feature]

Author: elpaso

images/images.qrc

@@ -277,6 +277,7 @@
         <file>themes/default/mActionHelpContents.svg</file>
         <file>themes/default/mActionHelpSponsors.png</file>
         <file>themes/default/mActionHideAllLayers.svg</file>
+        <file>themes/default/mActionToggleAllLayers.svg</file>
         <file>themes/default/mActionHideSelectedLayers.svg</file>
         <file>themes/default/mActionHideDeselectedLayers.svg</file>
         <file>themes/default/mActionHistory.svg</file>

images/themes/default/mActionToggleAllLayers.svg

@@ -269,6 +269,8 @@ Checks all items belonging to the same layer as this node.
 
 .. seealso:: :py:func:`uncheckAllItems`
 
+.. seealso:: :py:func:`toggleAllItems`
+
 .. versionadded:: 2.14
 %End
 
@@ -278,7 +280,20 @@ Unchecks all items belonging to the same layer as this node.
 
 .. seealso:: :py:func:`checkAllItems`
 
+.. seealso:: :py:func:`toggleAllItems`
+
 .. versionadded:: 2.14
+%End
+
+    void toggleAllItems();
+%Docstring
+Toggle all items belonging to the same layer as this node.
+
+.. seealso:: :py:func:`checkAllItems`
+
+.. seealso:: :py:func:`uncheckAllItems`
+
+.. versionadded:: 3.6
 %End
 
 };

python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in

@@ -476,6 +476,8 @@ QMenu *QgsAppLayerTreeViewMenuProvider::createContextMenu()
       // symbology item
       if ( symbolNode->flags() & Qt::ItemIsUserCheckable )
       {
+        menu->addAction( QgsApplication::getThemeIcon( QStringLiteral( "/mActionToggleAllLayers.svg" ) ), tr( "&Toggle Items" ),
+                         symbolNode, &QgsSymbolLegendNode::toggleAllItems );
         menu->addAction( QgsApplication::getThemeIcon( QStringLiteral( "/mActionShowAllLayers.svg" ) ), tr( "&Show All Items" ),
                          symbolNode, &QgsSymbolLegendNode::checkAllItems );
         menu->addAction( QgsApplication::getThemeIcon( QStringLiteral( "/mActionHideAllLayers.svg" ) ), tr( "&Hide All Items" ),

src/app/qgsapplayertreeviewmenuprovider.cpp

@@ -227,6 +227,22 @@ void QgsSymbolLegendNode::uncheckAllItems()
   checkAll( false );
 }
 
+void QgsSymbolLegendNode::toggleAllItems()
+{
+  QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( mLayerNode->layer() );
+  if ( !vlayer || !vlayer->renderer() )
+    return;
+
+  const QgsLegendSymbolList symbolList = vlayer->renderer()->legendSymbolItems();
+  for ( const auto &item : symbolList )
+  {
+    vlayer->renderer()->checkLegendSymbolItem( item.ruleKey(), ! vlayer->renderer()->legendSymbolItemChecked( item.ruleKey() ) );
+  }
+
+  emit dataChanged();
+  vlayer->triggerRepaint();
+}
+
 QgsRenderContext *QgsLayerTreeModelLegendNode::createTemporaryRenderContext() const
 {
   double scale = 0.0;
@@ -239,7 +255,7 @@ QgsRenderContext *QgsLayerTreeModelLegendNode::createTemporaryRenderContext() co
     return nullptr;
 
   // setup temporary render context
-  std::unique_ptr<QgsRenderContext> context( new QgsRenderContext );
+  std::unique_ptr<QgsRenderContext> context = qgis::make_unique<QgsRenderContext>( );
   context->setScaleFactor( dpi / 25.4 );
   context->setRendererScale( scale );
   context->setMapToPixel( QgsMapToPixel( mupp ) );
@@ -252,8 +268,8 @@ void QgsSymbolLegendNode::checkAll( bool state )
   if ( !vlayer || !vlayer->renderer() )
     return;
 
-  QgsLegendSymbolList symbolList = vlayer->renderer()->legendSymbolItems();
-  Q_FOREACH ( const QgsLegendSymbolItem &item, symbolList )
+  const QgsLegendSymbolList symbolList = vlayer->renderer()->legendSymbolItems();
+  for ( const auto &item : symbolList )
   {
     vlayer->renderer()->checkLegendSymbolItem( item.ruleKey(), state );
   }

src/core/layertree/qgslayertreemodellegendnode.cpp

@@ -251,17 +251,27 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
     /**
      * Checks all items belonging to the same layer as this node.
      * \see uncheckAllItems()
+     * \see toggleAllItems()
      * \since QGIS 2.14
      */
     void checkAllItems();
 
     /**
      * Unchecks all items belonging to the same layer as this node.
      * \see checkAllItems()
+     * \see toggleAllItems()
      * \since QGIS 2.14
      */
     void uncheckAllItems();
 
+    /**
+     * Toggle all items belonging to the same layer as this node.
+     * \see checkAllItems()
+     * \see uncheckAllItems()
+     * \since QGIS 3.6
+     */
+    void toggleAllItems();
+
   private:
     void updateLabel();