Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport queued_ltr_backports] Correctly move layout legend nodes when they are filtered #60928

Merged
merged 2 commits into from
Mar 11, 2025
Merged

[Backport queued_ltr_backports] Correctly move layout legend nodes when they are filtered #60928

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
360affd
fix(layoutlegendwidget): correctly move legend nodes when they are fi…
Djedouas Feb 10, 2025
a91f8f7
fix(clang-tidy): use unnamed namespace instead of static keyword
Djedouas Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 47 additions & 33 deletions src/gui/layout/qgslayoutlegendwidget.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,22 +53,40 @@

///@cond PRIVATE

static int _unfilteredLegendNodeIndex( QgsLayerTreeModelLegendNode *legendNode )
namespace
{
return legendNode->model()->layerOriginalLegendNodes( legendNode->layerNode() ).indexOf( legendNode );
}
int _unfilteredLegendNodeIndex( QgsLayerTreeModelLegendNode *legendNode )
{
return legendNode->model()->layerOriginalLegendNodes( legendNode->layerNode() ).indexOf( legendNode );
}

static int _originalLegendNodeIndex( QgsLayerTreeModelLegendNode *legendNode )
{
// figure out index of the legend node as it comes out of the map layer legend.
// first legend nodes may be reordered, output of that is available in layerOriginalLegendNodes().
// next the nodes may be further filtered (by scale, map content etc).
// so here we go in reverse order: 1. find index before filtering, 2. find index before reorder
int unfilteredNodeIndex = _unfilteredLegendNodeIndex( legendNode );
QList<int> order = QgsMapLayerLegendUtils::legendNodeOrder( legendNode->layerNode() );
return ( unfilteredNodeIndex >= 0 && unfilteredNodeIndex < order.count() ? order[unfilteredNodeIndex] : -1 );
}
int _originalLegendNodeIndex( QgsLayerTreeModelLegendNode *legendNode )
{
// figure out index of the legend node as it comes out of the map layer legend.
// first legend nodes may be reordered, output of that is available in layerOriginalLegendNodes().
// next the nodes may be further filtered (by scale, map content etc).
// so here we go in reverse order: 1. find index before filtering, 2. find index before reorder
int unfilteredNodeIndex = _unfilteredLegendNodeIndex( legendNode );
QList<int> order = QgsMapLayerLegendUtils::legendNodeOrder( legendNode->layerNode() );
return ( unfilteredNodeIndex >= 0 && unfilteredNodeIndex < order.count() ? order[unfilteredNodeIndex] : -1 );
}

void _moveLegendNode( QgsLayerTreeLayer *nodeLayer, int legendNodeIndex, int destLegendNodeIndex )
{
QList<int> order = QgsMapLayerLegendUtils::legendNodeOrder( nodeLayer );
const int offset = destLegendNodeIndex - legendNodeIndex;

if ( legendNodeIndex < 0 || legendNodeIndex >= order.count() )
return;
if ( legendNodeIndex + offset < 0 || legendNodeIndex + offset >= order.count() )
return;

int id = order.takeAt( legendNodeIndex );
order.insert( legendNodeIndex + offset, id );

QgsMapLayerLegendUtils::setLegendNodeOrder( nodeLayer, order );
}
} //namespace

QgsLayoutLegendWidget::QgsLayoutLegendWidget( QgsLayoutItemLegend *legend, QgsMapCanvas *mapCanvas )
: QgsLayoutItemBaseWidget( nullptr, legend )
Expand Down Expand Up @@ -726,22 +744,6 @@ void QgsLayoutLegendWidget::mColumnSpaceSpinBox_valueChanged( double d )
}
}

static void _moveLegendNode( QgsLayerTreeLayer *nodeLayer, int legendNodeIndex, int offset )
{
QList<int> order = QgsMapLayerLegendUtils::legendNodeOrder( nodeLayer );

if ( legendNodeIndex < 0 || legendNodeIndex >= order.count() )
return;
if ( legendNodeIndex + offset < 0 || legendNodeIndex + offset >= order.count() )
return;

int id = order.takeAt( legendNodeIndex );
order.insert( legendNodeIndex + offset, id );

QgsMapLayerLegendUtils::setLegendNodeOrder( nodeLayer, order );
}


void QgsLayoutLegendWidget::mMoveDownToolButton_clicked()
{
if ( !mLegend )
Expand Down Expand Up @@ -770,8 +772,14 @@ void QgsLayoutLegendWidget::mMoveDownToolButton_clicked()
}
else // legend node
{
_moveLegendNode( legendNode->layerNode(), _unfilteredLegendNodeIndex( legendNode ), 1 );
mItemTreeView->layerTreeModel()->refreshLayerLegend( legendNode->layerNode() );
// get the next index, the one that will have to be above our index,
const QModelIndex nextIndex = index.siblingAtRow( index.row() + 1 );
QgsLayerTreeModelLegendNode *nextLegendNode = nextIndex.isValid() ? mItemTreeView->index2legendNode( nextIndex ) : nullptr;
if ( nextLegendNode )
{
_moveLegendNode( legendNode->layerNode(), _unfilteredLegendNodeIndex( legendNode ), _unfilteredLegendNodeIndex( nextLegendNode ) );
mItemTreeView->layerTreeModel()->refreshLayerLegend( legendNode->layerNode() );
}
}

mItemTreeView->setCurrentIndex( mItemTreeView->proxyModel()->mapFromSource( mItemTreeView->layerTreeModel()->index( sourceIndex.row() + 1, 0, parentIndex ) ) );
Expand Down Expand Up @@ -808,8 +816,14 @@ void QgsLayoutLegendWidget::mMoveUpToolButton_clicked()
}
else // legend node
{
_moveLegendNode( legendNode->layerNode(), _unfilteredLegendNodeIndex( legendNode ), -1 );
mItemTreeView->layerTreeModel()->refreshLayerLegend( legendNode->layerNode() );
// get the previous index, the one that will have to be below our index,
const QModelIndex prevIndex = index.siblingAtRow( index.row() - 1 );
QgsLayerTreeModelLegendNode *prevLegendNode = prevIndex.isValid() ? mItemTreeView->index2legendNode( prevIndex ) : nullptr;
if ( prevLegendNode )
{
_moveLegendNode( legendNode->layerNode(), _unfilteredLegendNodeIndex( legendNode ), _unfilteredLegendNodeIndex( prevLegendNode ) );
mItemTreeView->layerTreeModel()->refreshLayerLegend( legendNode->layerNode() );
}
}

mItemTreeView->setCurrentIndex( mItemTreeView->proxyModel()->mapFromSource( mItemTreeView->layerTreeModel()->index( sourceIndex.row() - 1, 0, parentIndex ) ) );
Expand Down
Loading