Handle indentation of right-aligned legends

qgis · Jan 16, 2021 · 7de030a · 7de030a
1 parent 09956c8
commit 7de030a
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 6 deletions.
diff --git a/python/core/auto_generated/qgslegendstyle.sip.in b/python/core/auto_generated/qgslegendstyle.sip.in
@@ -107,7 +107,7 @@ Sets the alignment for the legend component.
 
     double indent();
 %Docstring
-Returns the indent of a group or subgroup.
+Returns the indent (in mm) of a group or subgroup.
 
 .. seealso:: :py:func:`indent`
 
@@ -116,7 +116,7 @@ Returns the indent of a group or subgroup.
 
     void setIndent( double indent );
 %Docstring
-Sets the indent of a group or subgroup.
+Sets the indent (in mm) of a group or subgroup.
 
 .. seealso:: :py:func:`indent`
 

diff --git a/src/core/qgslegendrenderer.cpp b/src/core/qgslegendrenderer.cpp
@@ -284,6 +284,7 @@ QList<QgsLegendRenderer::LegendComponentGroup> QgsLegendRenderer::createComponen
     {
       QgsLayerTreeGroup *nodeGroup = QgsLayerTree::toGroup( node );
       QString style = node->customProperty( QStringLiteral( "legend/title-style" ) ).toString();
+      // Update the required indent for the group/subgroup items, starting from the indent accumulated from parent groups
       double newIndent = indent;
       if ( style == QLatin1String( "subgroup" ) )
       {
@@ -680,13 +681,22 @@ QSizeF QgsLegendRenderer::drawGroup( const LegendComponentGroup &group, QgsRende
         double indentWidth =  component.indent;
         if ( s == QgsLegendStyle::Subgroup )
         {
+          // Remove indent - the subgroup items should be indented, not the subgroup title
           indentWidth -= mSettings.style( QgsLegendStyle::Subgroup ).indent( );
         }
         else
         {
+          // Remove indent - the group items should be indented, not the group title
           indentWidth -= mSettings.style( QgsLegendStyle::Group ).indent( );
         }
-        columnContextForItem.left += indentWidth;
+        if ( mSettings.style( QgsLegendStyle::SymbolLabel ).alignment() == Qt::AlignLeft )
+        {
+          columnContextForItem.left += indentWidth;
+        }
+        if ( mSettings.style( QgsLegendStyle::SymbolLabel ).alignment() == Qt::AlignRight )
+        {
+          columnContextForItem.right -= indentWidth;
+        }
         groupSize = drawGroupTitle( groupItem, context, columnContextForItem, currentY );
         size.rwidth() = std::max( groupSize.width(), size.width() );
       }
@@ -719,7 +729,14 @@ QSizeF QgsLegendRenderer::drawGroup( const LegendComponentGroup &group, QgsRende
       ColumnContext columnContextForItem = columnContext;
       double indentWidth = 0;
       indentWidth = component.indent;
-      columnContextForItem.left += indentWidth;
+      if ( mSettings.style( QgsLegendStyle::SymbolLabel ).alignment() == Qt::AlignLeft )
+      {
+        columnContextForItem.left += indentWidth;
+      }
+      if ( mSettings.style( QgsLegendStyle::SymbolLabel ).alignment() == Qt::AlignRight )
+      {
+        columnContextForItem.right -= indentWidth;
+      }
 
       LegendComponent symbolComponent = drawSymbolItem( legendNode, context, columnContextForItem, currentY, component.maxSiblingSymbolWidth );
       // expand width, it may be wider because of label offsets

diff --git a/src/core/qgslegendrenderer.h b/src/core/qgslegendrenderer.h
@@ -144,6 +144,10 @@ class CORE_EXPORT QgsLegendRenderer
         //! Component size
         QSizeF size;
 
+        /**
+         * Starting indent for groups/subgroups nested in other groups/subgroups.
+         * This value is the sum of the indents of all parent groups/subgroups.
+         */
         double indent = 0;
 
         /**

diff --git a/src/core/qgslegendstyle.h b/src/core/qgslegendstyle.h
@@ -122,15 +122,15 @@ class CORE_EXPORT QgsLegendStyle
     void setAlignment( Qt::Alignment alignment ) { mAlignment = alignment; }
 
     /**
-    * Returns the indent of a group or subgroup.
+    * Returns the indent (in mm) of a group or subgroup.
     *
     * \see indent()
     * \since QGIS 3.18
     */
     double indent() { return mIndent; }
 
     /**
-     * Sets the indent of a group or subgroup.
+     * Sets the indent (in mm) of a group or subgroup.
      *
      * \see indent()
      * \since QGIS 3.18

diff --git a/tests/src/core/testqgslegendrenderer.cpp b/tests/src/core/testqgslegendrenderer.cpp
@@ -722,6 +722,25 @@ void TestQgsLegendRenderer::testGroupIndent()
   _renderLegend( QStringLiteral( "legend_group_indent" ), &legendModel, settings );
   QVERIFY( _verifyImage( QStringLiteral( "legend_group_indent" ), mReport ) );
 
+  settings.rstyle( QgsLegendStyle::Group ).setAlignment( Qt::AlignRight );
+  settings.rstyle( QgsLegendStyle::Subgroup ).setAlignment( Qt::AlignRight );
+  settings.rstyle( QgsLegendStyle::SymbolLabel ).setAlignment( Qt::AlignRight );
+  _renderLegend( QStringLiteral( "legend_group_indent_right_align_text" ), &legendModel, settings );
+  QVERIFY( _verifyImage( QStringLiteral( "legend_group_indent_right_align_text" ), mReport ) );
+
+  settings.rstyle( QgsLegendStyle::Group ).setAlignment( Qt::AlignLeft );
+  settings.rstyle( QgsLegendStyle::Subgroup ).setAlignment( Qt::AlignLeft );
+  settings.rstyle( QgsLegendStyle::SymbolLabel ).setAlignment( Qt::AlignLeft );
+  settings.setSymbolAlignment( Qt::AlignRight );
+  _renderLegend( QStringLiteral( "legend_group_indent_right_align_symbol" ), &legendModel, settings );
+  QVERIFY( _verifyImage( QStringLiteral( "legend_group_indent_right_align_symbol" ), mReport ) );
+
+  settings.rstyle( QgsLegendStyle::Group ).setAlignment( Qt::AlignRight );
+  settings.rstyle( QgsLegendStyle::Subgroup ).setAlignment( Qt::AlignRight );
+  settings.rstyle( QgsLegendStyle::SymbolLabel ).setAlignment( Qt::AlignRight );
+  settings.setSymbolAlignment( Qt::AlignRight );
+  _renderLegend( QStringLiteral( "legend_group_indent_right_align_symbol_right_align_text" ), &legendModel, settings );
+  QVERIFY( _verifyImage( QStringLiteral( "legend_group_indent_right_align_symbol_right_align_text" ), mReport ) );
 }
 
 void TestQgsLegendRenderer::testRightAlignText()

diff --git a/...p_indent_right_align_symbol/expected_legend_group_indent_right_align_symbol.png b/...p_indent_right_align_symbol/expected_legend_group_indent_right_align_symbol.png
diff --git a/...align_text/expected_legend_group_indent_right_align_symbol_right_align_text.png b/...align_text/expected_legend_group_indent_right_align_symbol_right_align_text.png
diff --git a/...group_indent_right_align_text/expected_legend_group_indent_right_align_text.png b/...group_indent_right_align_text/expected_legend_group_indent_right_align_text.png