Manual backport of #57461

python/PyQt6/core/auto_additions/qgslayertreemodellegendnode.py

@@ -13,7 +13,11 @@
 QgsLayerTreeModelLegendNode.LegendNodeRoles.NodeTypeRole = QgsLayerTreeModelLegendNode.CustomRole.NodeType
 QgsLayerTreeModelLegendNode.NodeTypeRole.is_monkey_patched = True
 QgsLayerTreeModelLegendNode.NodeTypeRole.__doc__ = "Type of node. Added in 3.16"
-QgsLayerTreeModelLegendNode.CustomRole.__doc__ = "Legend node data roles\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as QgsLayerTreeModelLegendNode.LegendNodeRoles\n\n.. versionadded:: 3.36\n\n" + '* ``RuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.RuleKey.__doc__ + '\n' + '* ``ParentRuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.ParentRuleKey.__doc__ + '\n' + '* ``NodeTypeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.NodeType.__doc__
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole = QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize
+QgsLayerTreeModelLegendNode.LegendNodeRoles.IsDataDefinedSizeRole = QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole.is_monkey_patched = True
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole.__doc__ = "Set when a node is related to data defined size (title or separated legend items). Added in 3.38"
+QgsLayerTreeModelLegendNode.CustomRole.__doc__ = "Legend node data roles\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as QgsLayerTreeModelLegendNode.LegendNodeRoles\n\n.. versionadded:: 3.36\n\n" + '* ``RuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.RuleKey.__doc__ + '\n' + '* ``ParentRuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.ParentRuleKey.__doc__ + '\n' + '* ``NodeTypeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.NodeType.__doc__ + '\n' + '* ``IsDataDefinedSizeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize.__doc__
 # --
 QgsLayerTreeModelLegendNode.CustomRole.baseClass = QgsLayerTreeModelLegendNode
 QgsLayerTreeModelLegendNode.SimpleLegend = QgsLayerTreeModelLegendNode.NodeTypes.SimpleLegend

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

@@ -51,6 +51,7 @@ and customized look.
       RuleKey,
       ParentRuleKey,
       NodeType,
+      IsDataDefinedSize,
     };
 
     enum NodeTypes /BaseType=IntEnum/

python/PyQt6/core/auto_generated/symbology/qgslegendsymbolitem.sip.in

@@ -110,6 +110,24 @@ Takes ownership of the settings object.
     QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings() const;
 %Docstring
 Returns extra information for data-defined size legend rendering. Normally it returns ``None``.
+%End
+
+    void setUserData( int key, QVariant &value );
+%Docstring
+Adds a ``key`` - ``value`` pair to the item's user data.
+
+.. seealso:: :py:func:`userData`
+
+.. versionadded:: 3.38
+%End
+
+    QVariant userData( int key ) const;
+%Docstring
+Retrieves the item's user data with the specified ``key``.
+
+.. seealso:: :py:func:`setUserData`
+
+.. versionadded:: 3.38
 %End
 
 };

python/core/auto_additions/qgslayertreemodellegendnode.py

@@ -13,6 +13,10 @@
 QgsLayerTreeModelLegendNode.LegendNodeRoles.NodeTypeRole = QgsLayerTreeModelLegendNode.CustomRole.NodeType
 QgsLayerTreeModelLegendNode.NodeTypeRole.is_monkey_patched = True
 QgsLayerTreeModelLegendNode.NodeTypeRole.__doc__ = "Type of node. Added in 3.16"
-QgsLayerTreeModelLegendNode.CustomRole.__doc__ = "Legend node data roles\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as QgsLayerTreeModelLegendNode.LegendNodeRoles\n\n.. versionadded:: 3.36\n\n" + '* ``RuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.RuleKey.__doc__ + '\n' + '* ``ParentRuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.ParentRuleKey.__doc__ + '\n' + '* ``NodeTypeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.NodeType.__doc__
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole = QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize
+QgsLayerTreeModelLegendNode.LegendNodeRoles.IsDataDefinedSizeRole = QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole.is_monkey_patched = True
+QgsLayerTreeModelLegendNode.IsDataDefinedSizeRole.__doc__ = "Set when a node is related to data defined size (title or separated legend items). Added in 3.38"
+QgsLayerTreeModelLegendNode.CustomRole.__doc__ = "Legend node data roles\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as QgsLayerTreeModelLegendNode.LegendNodeRoles\n\n.. versionadded:: 3.36\n\n" + '* ``RuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.RuleKey.__doc__ + '\n' + '* ``ParentRuleKeyRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.ParentRuleKey.__doc__ + '\n' + '* ``NodeTypeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.NodeType.__doc__ + '\n' + '* ``IsDataDefinedSizeRole``: ' + QgsLayerTreeModelLegendNode.CustomRole.IsDataDefinedSize.__doc__
 # --
 QgsLayerTreeModelLegendNode.CustomRole.baseClass = QgsLayerTreeModelLegendNode

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

@@ -51,6 +51,7 @@ and customized look.
       RuleKey,
       ParentRuleKey,
       NodeType,
+      IsDataDefinedSize,
     };
 
     enum NodeTypes

python/core/auto_generated/symbology/qgslegendsymbolitem.sip.in

@@ -110,6 +110,24 @@ Takes ownership of the settings object.
     QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings() const;
 %Docstring
 Returns extra information for data-defined size legend rendering. Normally it returns ``None``.
+%End
+
+    void setUserData( int key, QVariant &value );
+%Docstring
+Adds a ``key`` - ``value`` pair to the item's user data.
+
+.. seealso:: :py:func:`userData`
+
+.. versionadded:: 3.38
+%End
+
+    QVariant userData( int key ) const;
+%Docstring
+Retrieves the item's user data with the specified ``key``.
+
+.. seealso:: :py:func:`setUserData`
+
+.. versionadded:: 3.38
 %End
 
 };

src/core/layertree/qgslayertreemodel.cpp

@@ -1301,7 +1301,8 @@ QList<QgsLayerTreeModelLegendNode *> QgsLayerTreeModel::filterLegendNodes( const
     {
       for ( QgsLayerTreeModelLegendNode *node : std::as_const( nodes ) )
       {
-        switch ( node->data( static_cast< int >( QgsLayerTreeModelLegendNode::CustomRole::NodeType ) ).value<QgsLayerTreeModelLegendNode::NodeTypes>() )
+        const QgsLayerTreeModelLegendNode::NodeTypes nodeType = node->data( static_cast< int >( QgsLayerTreeModelLegendNode::CustomRole::NodeType ) ).value<QgsLayerTreeModelLegendNode::NodeTypes>();
+        switch ( nodeType )
         {
           case QgsLayerTreeModelLegendNode::EmbeddedWidget:
             filtered << node;
@@ -1316,6 +1317,7 @@ QList<QgsLayerTreeModelLegendNode *> QgsLayerTreeModel::filterLegendNodes( const
           case QgsLayerTreeModelLegendNode::ColorRampLegend:
           {
             const QString ruleKey = node->data( static_cast< int >( QgsLayerTreeModelLegendNode::CustomRole::RuleKey ) ).toString();
+            const bool isDataDefinedSize = node->data( static_cast< int >( QgsLayerTreeModelLegendNode::CustomRole::IsDataDefinedSize ) ).toBool();
             const bool checked = ( mFilterSettings && !( mFilterSettings->flags() & Qgis::LayerTreeFilterFlag::SkipVisibilityCheck ) )
                                  || node->data( Qt::CheckStateRole ).toInt() == Qt::Checked;
 
@@ -1324,7 +1326,11 @@ QList<QgsLayerTreeModelLegendNode *> QgsLayerTreeModel::filterLegendNodes( const
               if ( QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( node->layerNode()->layer() ) )
               {
                 auto it = mHitTestResults.constFind( vl->id() );
-                if ( it != mHitTestResults.constEnd() && it->contains( ruleKey ) )
+                if ( it != mHitTestResults.constEnd() &&
+                     ( it->contains( ruleKey ) ||
+                       ( !it->isEmpty() && isDataDefinedSize )
+                     )
+                   )
                 {
                   filtered << node;
                 }

src/core/layertree/qgslayertreemodellegendnode.h

@@ -92,6 +92,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
       RuleKey SIP_MONKEYPATCH_COMPAT_NAME( RuleKeyRole ) = Qt::UserRole, //!< Rule key of the node (QString)
       ParentRuleKey SIP_MONKEYPATCH_COMPAT_NAME( ParentRuleKeyRole ), //!< Rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2.8
       NodeType SIP_MONKEYPATCH_COMPAT_NAME( NodeTypeRole ), //!< Type of node. Added in 3.16
+      IsDataDefinedSize SIP_MONKEYPATCH_COMPAT_NAME( IsDataDefinedSizeRole ), //!< Set when a node is related to data defined size (title or separated legend items). Added in 3.38
     };
     Q_ENUM( CustomRole )
     // *INDENT-ON*

src/core/qgsdatadefinedsizelegend.cpp

@@ -15,6 +15,7 @@
 
 #include "qgsdatadefinedsizelegend.h"
 
+#include "qgslayertreemodellegendnode.h"
 #include "qgsproperty.h"
 #include "qgspropertytransformer.h"
 #include "qgssymbollayerutils.h"
@@ -124,9 +125,11 @@ void QgsDataDefinedSizeLegend::updateFromSymbolAndProperty( const QgsMarkerSymbo
 QgsLegendSymbolList QgsDataDefinedSizeLegend::legendSymbolList() const
 {
   QgsLegendSymbolList lst;
+  QVariant isDataDefinedSize( true );
   if ( !mTitleLabel.isEmpty() )
   {
     QgsLegendSymbolItem title( nullptr, mTitleLabel, QString() );
+    title.setUserData( static_cast<int>( QgsLayerTreeModelLegendNode::CustomRole::IsDataDefinedSize ), isDataDefinedSize );
     lst << title;
   }
 
@@ -136,6 +139,7 @@ QgsLegendSymbolList QgsDataDefinedSizeLegend::legendSymbolList() const
     {
       QgsLegendSymbolItem i;
       i.setDataDefinedSizeLegendSettings( new QgsDataDefinedSizeLegend( *this ) );
+      i.setUserData( static_cast<int>( QgsLayerTreeModelLegendNode::CustomRole::IsDataDefinedSize ), isDataDefinedSize );
       lst << i;
       break;
     }
@@ -146,6 +150,7 @@ QgsLegendSymbolList QgsDataDefinedSizeLegend::legendSymbolList() const
       for ( const SizeClass &cl : mSizeClasses )
       {
         QgsLegendSymbolItem si( mSymbol.get(), cl.label, QString() );
+        si.setUserData( static_cast<int>( QgsLayerTreeModelLegendNode::CustomRole::IsDataDefinedSize ), isDataDefinedSize );
         QgsMarkerSymbol *s = static_cast<QgsMarkerSymbol *>( si.symbol() );
         double size = cl.size;
         if ( mSizeScaleTransformer )

src/core/symbology/qgslegendsymbolitem.cpp

@@ -59,6 +59,7 @@ QgsLegendSymbolItem &QgsLegendSymbolItem::operator=( const QgsLegendSymbolItem &
   mScaleMaxDenom = other.mScaleMaxDenom;
   mLevel = other.mLevel;
   mParentKey = other.mParentKey;
+  mUserData = other.mUserData;
 
   return *this;
 }
@@ -93,3 +94,13 @@ QgsDataDefinedSizeLegend *QgsLegendSymbolItem::dataDefinedSizeLegendSettings() c
 {
   return mDataDefinedSizeLegendSettings;
 }
+
+void QgsLegendSymbolItem::setUserData( int key, QVariant &value )
+{
+  mUserData.insert( key, value );
+}
+
+QVariant QgsLegendSymbolItem::userData( int key ) const
+{
+  return mUserData.value( key, QVariant() );
+}

src/core/symbology/qgslegendsymbolitem.h

@@ -108,6 +108,22 @@ class CORE_EXPORT QgsLegendSymbolItem
      */
     QgsDataDefinedSizeLegend *dataDefinedSizeLegendSettings() const;
 
+    /**
+     * Adds a \a key - \a value pair to the item's user data.
+     *
+     * \see userData()
+     * \since QGIS 3.38
+     */
+    void setUserData( int key, QVariant &value );
+
+    /**
+     * Retrieves the item's user data with the specified \a key.
+     *
+     * \see setUserData()
+     * \since QGIS 3.38
+     */
+    QVariant userData( int key ) const;
+
   private:
     //! Legend symbol -- may be NULLPTR.
     QgsSymbol *mSymbol = nullptr;
@@ -135,6 +151,8 @@ class CORE_EXPORT QgsLegendSymbolItem
     int mLevel = 0;
     //! Key of the parent legend node. For legends with tree hierarchy
     QString mParentKey;
+
+    QMap< int, QVariant > mUserData;
 };
 
 typedef QList< QgsLegendSymbolItem > QgsLegendSymbolList;