LCOV - code coverage report
Current view: top level - core - qgsmapthemecollection.cpp (source / functions) Hit Total Coverage
Test: coverage.info.cleaned Lines: 5 468 1.1 %
Date: 2021-03-26 12:19:53 Functions: 0 0 -
Branches: 0 0 -

           Branch data     Line data    Source code
       1                 :            : /***************************************************************************
       2                 :            :   qgsmapthemecollection.cpp
       3                 :            :   --------------------------------------
       4                 :            :   Date                 : September 2014
       5                 :            :   Copyright            : (C) 2014 by Martin Dobias
       6                 :            :   Email                : wonder dot sk at gmail dot com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #include "qgsmapthemecollection.h"
      17                 :            : 
      18                 :            : #include "qgslayertree.h"
      19                 :            : #include "qgslayertreemodel.h"
      20                 :            : #include "qgslayertreemodellegendnode.h"
      21                 :            : #include "qgsmaplayerlistutils.h"
      22                 :            : #include "qgsmaplayerstylemanager.h"
      23                 :            : #include "qgsproject.h"
      24                 :            : #include "qgsrenderer.h"
      25                 :            : #include "qgsvectorlayer.h"
      26                 :            : 
      27                 :            : #include <QInputDialog>
      28                 :            : 
      29                 :          8 : QgsMapThemeCollection::QgsMapThemeCollection( QgsProject *project )
      30                 :          8 :   : mProject( project )
      31                 :         16 : {
      32                 :          8 :   connect( project, static_cast<void ( QgsProject::* )( const QStringList & )>( &QgsProject::layersWillBeRemoved ), this, &QgsMapThemeCollection::registryLayersRemoved );
      33                 :          8 : }
      34                 :            : 
      35                 :          0 : QgsMapThemeCollection::MapThemeLayerRecord QgsMapThemeCollection::createThemeLayerRecord( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model )
      36                 :            : {
      37                 :          0 :   MapThemeLayerRecord layerRec( nodeLayer->layer() );
      38                 :          0 :   layerRec.isVisible = nodeLayer->isVisible();
      39                 :          0 :   layerRec.usingCurrentStyle = true;
      40                 :          0 :   layerRec.currentStyle = nodeLayer->layer()->styleManager()->currentStyle();
      41                 :          0 :   layerRec.expandedLayerNode = nodeLayer->isExpanded();
      42                 :          0 :   layerRec.expandedLegendItems = qgis::listToSet( nodeLayer->customProperty( QStringLiteral( "expandedLegendNodes" ) ).toStringList() );
      43                 :            : 
      44                 :            :   // get checked legend items
      45                 :          0 :   bool hasCheckableItems = false;
      46                 :          0 :   bool someItemsUnchecked = false;
      47                 :          0 :   QSet<QString> checkedItems;
      48                 :          0 :   const QList<QgsLayerTreeModelLegendNode *> layerLegendNodes = model->layerLegendNodes( nodeLayer, true );
      49                 :          0 :   for ( QgsLayerTreeModelLegendNode *legendNode : layerLegendNodes )
      50                 :            :   {
      51                 :          0 :     if ( legendNode->flags() & Qt::ItemIsUserCheckable )
      52                 :            :     {
      53                 :          0 :       hasCheckableItems = true;
      54                 :            : 
      55                 :          0 :       if ( legendNode->data( Qt::CheckStateRole ).toInt() == Qt::Checked )
      56                 :          0 :         checkedItems << legendNode->data( QgsLayerTreeModelLegendNode::RuleKeyRole ).toString();
      57                 :            :       else
      58                 :          0 :         someItemsUnchecked = true;
      59                 :          0 :     }
      60                 :            :   }
      61                 :            : 
      62                 :          0 :   if ( hasCheckableItems && someItemsUnchecked )
      63                 :            :   {
      64                 :          0 :     layerRec.usingLegendItems = true;
      65                 :          0 :     layerRec.checkedLegendItems = checkedItems;
      66                 :          0 :   }
      67                 :          0 :   return layerRec;
      68                 :          0 : }
      69                 :            : 
      70                 :          0 : static QString _groupId( QgsLayerTreeNode *node )
      71                 :            : {
      72                 :          0 :   QStringList lst;
      73                 :          0 :   while ( node->parent() )
      74                 :            :   {
      75                 :          0 :     lst.prepend( node->name() );
      76                 :          0 :     node = node->parent();
      77                 :            :   }
      78                 :          0 :   return lst.join( '/' );
      79                 :          0 : }
      80                 :            : 
      81                 :          0 : void QgsMapThemeCollection::createThemeFromCurrentState( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, QgsMapThemeCollection::MapThemeRecord &rec )
      82                 :            : {
      83                 :          0 :   const QList<QgsLayerTreeNode *> constChildren = parent->children();
      84                 :          0 :   for ( QgsLayerTreeNode *node : constChildren )
      85                 :            :   {
      86                 :          0 :     if ( QgsLayerTree::isGroup( node ) )
      87                 :            :     {
      88                 :          0 :       createThemeFromCurrentState( QgsLayerTree::toGroup( node ), model, rec );
      89                 :          0 :       if ( node->isExpanded() )
      90                 :          0 :         rec.mExpandedGroupNodes.insert( _groupId( node ) );
      91                 :          0 :       if ( node->itemVisibilityChecked() != Qt::Unchecked )
      92                 :          0 :         rec.mCheckedGroupNodes.insert( _groupId( node ) );
      93                 :          0 :     }
      94                 :          0 :     else if ( QgsLayerTree::isLayer( node ) )
      95                 :            :     {
      96                 :          0 :       QgsLayerTreeLayer *nodeLayer = QgsLayerTree::toLayer( node );
      97                 :          0 :       if ( node->itemVisibilityChecked() != Qt::Unchecked && nodeLayer->layer() )
      98                 :          0 :         rec.mLayerRecords << createThemeLayerRecord( nodeLayer, model );
      99                 :          0 :     }
     100                 :            :   }
     101                 :          0 : }
     102                 :            : 
     103                 :          0 : QgsMapThemeCollection::MapThemeRecord QgsMapThemeCollection::createThemeFromCurrentState( QgsLayerTreeGroup *root, QgsLayerTreeModel *model )
     104                 :            : {
     105                 :          0 :   QgsMapThemeCollection::MapThemeRecord rec;
     106                 :          0 :   rec.setHasExpandedStateInfo( true );  // all newly created theme records have expanded state info
     107                 :          0 :   rec.setHasCheckedStateInfo( true );  // all newly created theme records have checked state info
     108                 :          0 :   createThemeFromCurrentState( root, model, rec );
     109                 :          0 :   return rec;
     110                 :          0 : }
     111                 :            : 
     112                 :          0 : bool QgsMapThemeCollection::findRecordForLayer( QgsMapLayer *layer, const QgsMapThemeCollection::MapThemeRecord &rec, QgsMapThemeCollection::MapThemeLayerRecord &layerRec )
     113                 :            : {
     114                 :          0 :   for ( const QgsMapThemeCollection::MapThemeLayerRecord &lr : std::as_const( rec.mLayerRecords ) )
     115                 :            :   {
     116                 :          0 :     if ( lr.layer() == layer )
     117                 :            :     {
     118                 :          0 :       layerRec = lr;
     119                 :          0 :       return true;
     120                 :            :     }
     121                 :            :   }
     122                 :          0 :   return false;
     123                 :          0 : }
     124                 :            : 
     125                 :          0 : void QgsMapThemeCollection::applyThemeToLayer( QgsLayerTreeLayer *nodeLayer, QgsLayerTreeModel *model, const QgsMapThemeCollection::MapThemeRecord &rec )
     126                 :            : {
     127                 :          0 :   MapThemeLayerRecord layerRec;
     128                 :          0 :   const bool recordExists = findRecordForLayer( nodeLayer->layer(), rec, layerRec );
     129                 :            : 
     130                 :            :   // Make sure the whole tree is visible
     131                 :          0 :   if ( recordExists )
     132                 :            :   {
     133                 :          0 :     if ( rec.hasCheckedStateInfo() )
     134                 :          0 :       nodeLayer->setItemVisibilityChecked( true );
     135                 :            :     else
     136                 :          0 :       nodeLayer->setItemVisibilityCheckedParentRecursive( true );
     137                 :          0 :   }
     138                 :            :   else
     139                 :          0 :     nodeLayer->setItemVisibilityChecked( false );
     140                 :            : 
     141                 :          0 :   if ( !recordExists )
     142                 :          0 :     return;
     143                 :            : 
     144                 :          0 :   if ( layerRec.usingCurrentStyle )
     145                 :            :   {
     146                 :            :     // apply desired style first
     147                 :          0 :     nodeLayer->layer()->styleManager()->setCurrentStyle( layerRec.currentStyle );
     148                 :          0 :   }
     149                 :            : 
     150                 :          0 :   if ( layerRec.usingLegendItems )
     151                 :            :   {
     152                 :            :     // some nodes are not checked
     153                 :          0 :     const QList<QgsLayerTreeModelLegendNode *> constLayerLegendNodes = model->layerLegendNodes( nodeLayer, true );
     154                 :          0 :     for ( QgsLayerTreeModelLegendNode *legendNode : constLayerLegendNodes )
     155                 :            :     {
     156                 :          0 :       QString ruleKey = legendNode->data( QgsLayerTreeModelLegendNode::RuleKeyRole ).toString();
     157                 :          0 :       Qt::CheckState shouldHaveState = layerRec.checkedLegendItems.contains( ruleKey ) ? Qt::Checked : Qt::Unchecked;
     158                 :          0 :       if ( ( legendNode->flags() & Qt::ItemIsUserCheckable ) &&
     159                 :          0 :            legendNode->data( Qt::CheckStateRole ).toInt() != shouldHaveState )
     160                 :          0 :         legendNode->setData( shouldHaveState, Qt::CheckStateRole );
     161                 :          0 :     }
     162                 :          0 :   }
     163                 :            :   else
     164                 :            :   {
     165                 :            :     // all nodes should be checked
     166                 :          0 :     const QList<QgsLayerTreeModelLegendNode *> constLayerLegendNodes = model->layerLegendNodes( nodeLayer, true );
     167                 :          0 :     for ( QgsLayerTreeModelLegendNode *legendNode : constLayerLegendNodes )
     168                 :            :     {
     169                 :          0 :       if ( ( legendNode->flags() & Qt::ItemIsUserCheckable ) &&
     170                 :          0 :            legendNode->data( Qt::CheckStateRole ).toInt() != Qt::Checked )
     171                 :          0 :         legendNode->setData( Qt::Checked, Qt::CheckStateRole );
     172                 :            :     }
     173                 :          0 :   }
     174                 :            : 
     175                 :            :   // apply expanded/collapsed state to the layer and its legend nodes
     176                 :          0 :   if ( rec.hasExpandedStateInfo() )
     177                 :            :   {
     178                 :          0 :     nodeLayer->setExpanded( layerRec.expandedLayerNode );
     179                 :          0 :     nodeLayer->setCustomProperty( QStringLiteral( "expandedLegendNodes" ), QStringList( qgis::setToList( layerRec.expandedLegendItems ) ) );
     180                 :          0 :   }
     181                 :          0 : }
     182                 :            : 
     183                 :            : 
     184                 :          0 : void QgsMapThemeCollection::applyThemeToGroup( QgsLayerTreeGroup *parent, QgsLayerTreeModel *model, const QgsMapThemeCollection::MapThemeRecord &rec )
     185                 :            : {
     186                 :          0 :   const QList<QgsLayerTreeNode *> constChildren = parent->children();
     187                 :          0 :   for ( QgsLayerTreeNode *node : constChildren )
     188                 :            :   {
     189                 :          0 :     if ( QgsLayerTree::isGroup( node ) )
     190                 :            :     {
     191                 :          0 :       applyThemeToGroup( QgsLayerTree::toGroup( node ), model, rec );
     192                 :          0 :       if ( rec.hasExpandedStateInfo() )
     193                 :          0 :         node->setExpanded( rec.expandedGroupNodes().contains( _groupId( node ) ) );
     194                 :          0 :       if ( rec.hasCheckedStateInfo() )
     195                 :          0 :         node->setItemVisibilityChecked( rec.checkedGroupNodes().contains( _groupId( node ) ) );
     196                 :          0 :     }
     197                 :          0 :     else if ( QgsLayerTree::isLayer( node ) )
     198                 :          0 :       applyThemeToLayer( QgsLayerTree::toLayer( node ), model, rec );
     199                 :            :   }
     200                 :          0 : }
     201                 :            : 
     202                 :            : 
     203                 :          0 : void QgsMapThemeCollection::applyTheme( const QString &name, QgsLayerTreeGroup *root, QgsLayerTreeModel *model )
     204                 :            : {
     205                 :          0 :   applyThemeToGroup( root, model, mapThemeState( name ) );
     206                 :            : 
     207                 :            :   // also make sure that the preset is up-to-date (not containing any non-existent legend items)
     208                 :          0 :   update( name, createThemeFromCurrentState( root, model ) );
     209                 :          0 : }
     210                 :            : 
     211                 :          0 : QgsProject *QgsMapThemeCollection::project()
     212                 :            : {
     213                 :          0 :   return mProject;
     214                 :            : }
     215                 :            : 
     216                 :          0 : void QgsMapThemeCollection::setProject( QgsProject *project )
     217                 :            : {
     218                 :          0 :   if ( project == mProject )
     219                 :          0 :     return;
     220                 :            : 
     221                 :          0 :   disconnect( mProject, static_cast<void ( QgsProject::* )( const QStringList & )>( &QgsProject::layersWillBeRemoved ), this, &QgsMapThemeCollection::registryLayersRemoved );
     222                 :          0 :   mProject = project;
     223                 :          0 :   connect( mProject, static_cast<void ( QgsProject::* )( const QStringList & )>( &QgsProject::layersWillBeRemoved ), this, &QgsMapThemeCollection::registryLayersRemoved );
     224                 :          0 :   emit projectChanged();
     225                 :          0 : }
     226                 :            : 
     227                 :          0 : QList<QgsMapLayer *> QgsMapThemeCollection::masterLayerOrder() const
     228                 :            : {
     229                 :          0 :   if ( !mProject )
     230                 :          0 :     return QList< QgsMapLayer * >();
     231                 :            : 
     232                 :          0 :   return mProject->layerTreeRoot()->layerOrder();
     233                 :          0 : }
     234                 :            : 
     235                 :          0 : QList<QgsMapLayer *> QgsMapThemeCollection::masterVisibleLayers() const
     236                 :            : {
     237                 :          0 :   const QList< QgsMapLayer *> allLayers = masterLayerOrder();
     238                 :          0 :   const QList< QgsMapLayer * > visibleLayers = mProject->layerTreeRoot()->checkedLayers();
     239                 :            : 
     240                 :          0 :   if ( allLayers.isEmpty() )
     241                 :            :   {
     242                 :            :     // no project layer order set
     243                 :          0 :     return visibleLayers;
     244                 :            :   }
     245                 :            :   else
     246                 :            :   {
     247                 :          0 :     QList< QgsMapLayer * > orderedVisibleLayers;
     248                 :          0 :     for ( QgsMapLayer *layer : allLayers )
     249                 :            :     {
     250                 :          0 :       if ( visibleLayers.contains( layer ) )
     251                 :          0 :         orderedVisibleLayers << layer;
     252                 :            :     }
     253                 :          0 :     return orderedVisibleLayers;
     254                 :          0 :   }
     255                 :          0 : }
     256                 :            : 
     257                 :            : 
     258                 :          0 : bool QgsMapThemeCollection::hasMapTheme( const QString &name ) const
     259                 :            : {
     260                 :          0 :   return mMapThemes.contains( name );
     261                 :            : }
     262                 :            : 
     263                 :          0 : void QgsMapThemeCollection::insert( const QString &name, const QgsMapThemeCollection::MapThemeRecord &state )
     264                 :            : {
     265                 :          0 :   mMapThemes.insert( name, state );
     266                 :            : 
     267                 :          0 :   reconnectToLayersStyleManager();
     268                 :          0 :   emit mapThemeChanged( name );
     269                 :          0 :   emit mapThemesChanged();
     270                 :          0 : }
     271                 :            : 
     272                 :          0 : void QgsMapThemeCollection::update( const QString &name, const MapThemeRecord &state )
     273                 :            : {
     274                 :          0 :   if ( !mMapThemes.contains( name ) )
     275                 :          0 :     return;
     276                 :            : 
     277                 :          0 :   mMapThemes[name] = state;
     278                 :            : 
     279                 :          0 :   reconnectToLayersStyleManager();
     280                 :          0 :   emit mapThemeChanged( name );
     281                 :          0 :   emit mapThemesChanged();
     282                 :          0 : }
     283                 :            : 
     284                 :          0 : bool QgsMapThemeCollection::renameMapTheme( const QString &name,  const QString &newName )
     285                 :            : {
     286                 :          0 :   if ( !mMapThemes.contains( name ) || mMapThemes.contains( newName ) )
     287                 :          0 :     return false;
     288                 :            : 
     289                 :          0 :   const MapThemeRecord state = mMapThemes[name];
     290                 :          0 :   const MapThemeRecord newState = state;
     291                 :          0 :   insert( newName, newState );
     292                 :          0 :   emit mapThemeRenamed( name, newName );
     293                 :          0 :   removeMapTheme( name );
     294                 :          0 :   return true;
     295                 :          0 : }
     296                 :            : 
     297                 :          0 : void QgsMapThemeCollection::removeMapTheme( const QString &name )
     298                 :            : {
     299                 :          0 :   if ( !mMapThemes.contains( name ) )
     300                 :          0 :     return;
     301                 :            : 
     302                 :          0 :   mMapThemes.remove( name );
     303                 :            : 
     304                 :          0 :   reconnectToLayersStyleManager();
     305                 :          0 :   emit mapThemesChanged();
     306                 :          0 : }
     307                 :            : 
     308                 :          0 : void QgsMapThemeCollection::clear()
     309                 :            : {
     310                 :          0 :   mMapThemes.clear();
     311                 :            : 
     312                 :          0 :   reconnectToLayersStyleManager();
     313                 :          0 :   emit mapThemesChanged();
     314                 :          0 : }
     315                 :            : 
     316                 :          0 : QStringList QgsMapThemeCollection::mapThemes() const
     317                 :            : {
     318                 :          0 :   return mMapThemes.keys();
     319                 :            : }
     320                 :            : 
     321                 :          0 : QStringList QgsMapThemeCollection::mapThemeVisibleLayerIds( const QString &name ) const
     322                 :            : {
     323                 :          0 :   QStringList layerIds;
     324                 :          0 :   const QList<QgsMapLayer *> constMapThemeVisibleLayers = mapThemeVisibleLayers( name );
     325                 :          0 :   for ( QgsMapLayer *layer : constMapThemeVisibleLayers )
     326                 :            :   {
     327                 :          0 :     layerIds << layer->id();
     328                 :            :   }
     329                 :          0 :   return layerIds;
     330                 :          0 : }
     331                 :            : 
     332                 :          0 : QList<QgsMapLayer *> QgsMapThemeCollection::mapThemeVisibleLayers( const QString &name ) const
     333                 :            : {
     334                 :          0 :   QList<QgsMapLayer *> layers;
     335                 :          0 :   const QList<MapThemeLayerRecord> recs = mMapThemes.value( name ).mLayerRecords;
     336                 :          0 :   const QList<QgsMapLayer *> layerOrder = masterLayerOrder();
     337                 :          0 :   if ( layerOrder.isEmpty() )
     338                 :            :   {
     339                 :            :     // no master layer order - so we have to just use the stored theme layer order as a fallback
     340                 :          0 :     const QList<MapThemeLayerRecord> records { mMapThemes.value( name ).mLayerRecords };
     341                 :          0 :     for ( const MapThemeLayerRecord &layerRec : records )
     342                 :            :     {
     343                 :          0 :       if ( layerRec.isVisible && layerRec.layer() )
     344                 :          0 :         layers << layerRec.layer();
     345                 :            :     }
     346                 :          0 :   }
     347                 :            :   else
     348                 :            :   {
     349                 :          0 :     for ( QgsMapLayer *layer : layerOrder )
     350                 :            :     {
     351                 :          0 :       for ( const MapThemeLayerRecord &layerRec : recs )
     352                 :            :       {
     353                 :          0 :         if ( layerRec.isVisible && layerRec.layer() == layer )
     354                 :          0 :           layers << layerRec.layer();
     355                 :            :       }
     356                 :            :     }
     357                 :            :   }
     358                 :            : 
     359                 :          0 :   return layers;
     360                 :          0 : }
     361                 :            : 
     362                 :            : 
     363                 :          0 : void QgsMapThemeCollection::applyMapThemeCheckedLegendNodesToLayer( const MapThemeLayerRecord &layerRec, QgsMapLayer *layer )
     364                 :            : {
     365                 :          0 :   QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer );
     366                 :          0 :   if ( !vlayer || !vlayer->renderer() )
     367                 :          0 :     return;
     368                 :            : 
     369                 :          0 :   QgsFeatureRenderer *renderer = vlayer->renderer();
     370                 :          0 :   if ( !renderer->legendSymbolItemsCheckable() )
     371                 :          0 :     return; // no need to do anything
     372                 :            : 
     373                 :          0 :   bool someNodesUnchecked = layerRec.usingLegendItems;
     374                 :            : 
     375                 :          0 :   const auto constLegendSymbolItems = vlayer->renderer()->legendSymbolItems();
     376                 :          0 :   for ( const QgsLegendSymbolItem &item : constLegendSymbolItems )
     377                 :            :   {
     378                 :          0 :     bool checked = renderer->legendSymbolItemChecked( item.ruleKey() );
     379                 :          0 :     bool shouldBeChecked = someNodesUnchecked ? layerRec.checkedLegendItems.contains( item.ruleKey() ) : true;
     380                 :          0 :     if ( checked != shouldBeChecked )
     381                 :          0 :       renderer->checkLegendSymbolItem( item.ruleKey(), shouldBeChecked );
     382                 :            :   }
     383                 :          0 : }
     384                 :            : 
     385                 :            : 
     386                 :          0 : QMap<QString, QString> QgsMapThemeCollection::mapThemeStyleOverrides( const QString &presetName )
     387                 :            : {
     388                 :          0 :   QMap<QString, QString> styleOverrides;
     389                 :          0 :   if ( !mMapThemes.contains( presetName ) )
     390                 :          0 :     return styleOverrides;
     391                 :            : 
     392                 :          0 :   const QList<MapThemeLayerRecord> records {mMapThemes.value( presetName ).mLayerRecords};
     393                 :          0 :   for ( const MapThemeLayerRecord &layerRec : records )
     394                 :            :   {
     395                 :          0 :     if ( !layerRec.layer() )
     396                 :          0 :       continue;
     397                 :            : 
     398                 :          0 :     if ( layerRec.usingCurrentStyle )
     399                 :            :     {
     400                 :          0 :       QgsMapLayer *layer = layerRec.layer();
     401                 :          0 :       QgsMapLayerStyleOverride styleOverride( layer );
     402                 :          0 :       styleOverride.setOverrideStyle( layerRec.currentStyle );
     403                 :            : 
     404                 :            :       // set the checked legend nodes
     405                 :          0 :       applyMapThemeCheckedLegendNodesToLayer( layerRec, layer );
     406                 :            : 
     407                 :            :       // save to overrides
     408                 :          0 :       QgsMapLayerStyle layerStyle;
     409                 :          0 :       layerStyle.readFromLayer( layer );
     410                 :          0 :       styleOverrides[layer->id()] = layerStyle.xmlData();
     411                 :          0 :     }
     412                 :            :   }
     413                 :          0 :   return styleOverrides;
     414                 :          0 : }
     415                 :            : 
     416                 :          0 : void QgsMapThemeCollection::reconnectToLayersStyleManager()
     417                 :            : {
     418                 :            :   // disconnect( 0, 0, this, SLOT( layerStyleRenamed( QString, QString ) ) );
     419                 :            : 
     420                 :          0 :   QSet<QgsMapLayer *> layers;
     421                 :          0 :   for ( const MapThemeRecord &rec : std::as_const( mMapThemes ) )
     422                 :            :   {
     423                 :          0 :     for ( const MapThemeLayerRecord &layerRec : std::as_const( rec.mLayerRecords ) )
     424                 :            :     {
     425                 :          0 :       if ( auto *lLayer = layerRec.layer() )
     426                 :          0 :         layers << lLayer;
     427                 :            :     }
     428                 :            :   }
     429                 :            : 
     430                 :          0 :   const QSet<QgsMapLayer *> constLayers = layers;
     431                 :          0 :   for ( QgsMapLayer *ml : constLayers )
     432                 :            :   {
     433                 :          0 :     connect( ml->styleManager(), &QgsMapLayerStyleManager::styleRenamed, this, &QgsMapThemeCollection::layerStyleRenamed );
     434                 :            :   }
     435                 :          0 : }
     436                 :            : 
     437                 :          0 : void QgsMapThemeCollection::readXml( const QDomDocument &doc )
     438                 :            : {
     439                 :          0 :   clear();
     440                 :            : 
     441                 :          0 :   QDomElement visPresetsElem = doc.firstChildElement( QStringLiteral( "qgis" ) ).firstChildElement( QStringLiteral( "visibility-presets" ) );
     442                 :          0 :   if ( visPresetsElem.isNull() )
     443                 :          0 :     return;
     444                 :            : 
     445                 :          0 :   QDomElement visPresetElem = visPresetsElem.firstChildElement( QStringLiteral( "visibility-preset" ) );
     446                 :          0 :   while ( !visPresetElem.isNull() )
     447                 :            :   {
     448                 :          0 :     QHash<QString, MapThemeLayerRecord> layerRecords; // key = layer ID
     449                 :            : 
     450                 :          0 :     bool expandedStateInfo = false;
     451                 :          0 :     if ( visPresetElem.hasAttribute( QStringLiteral( "has-expanded-info" ) ) )
     452                 :          0 :       expandedStateInfo = visPresetElem.attribute( QStringLiteral( "has-expanded-info" ) ).toInt();
     453                 :            : 
     454                 :          0 :     bool checkedStateInfo = false;
     455                 :          0 :     if ( visPresetElem.hasAttribute( QStringLiteral( "has-checked-group-info" ) ) )
     456                 :          0 :       checkedStateInfo = visPresetElem.attribute( QStringLiteral( "has-checked-group-info" ) ).toInt();
     457                 :            : 
     458                 :          0 :     QString presetName = visPresetElem.attribute( QStringLiteral( "name" ) );
     459                 :          0 :     QDomElement visPresetLayerElem = visPresetElem.firstChildElement( QStringLiteral( "layer" ) );
     460                 :          0 :     while ( !visPresetLayerElem.isNull() )
     461                 :            :     {
     462                 :          0 :       QString layerID = visPresetLayerElem.attribute( QStringLiteral( "id" ) );
     463                 :          0 :       if ( QgsMapLayer *layer = mProject->mapLayer( layerID ) )
     464                 :            :       {
     465                 :          0 :         layerRecords[layerID] = MapThemeLayerRecord( layer );
     466                 :          0 :         layerRecords[layerID].isVisible = visPresetLayerElem.attribute( QStringLiteral( "visible" ), QStringLiteral( "1" ) ).toInt();
     467                 :            : 
     468                 :          0 :         if ( visPresetLayerElem.hasAttribute( QStringLiteral( "style" ) ) )
     469                 :            :         {
     470                 :          0 :           layerRecords[layerID].usingCurrentStyle = true;
     471                 :          0 :           layerRecords[layerID].currentStyle = visPresetLayerElem.attribute( QStringLiteral( "style" ) );
     472                 :          0 :         }
     473                 :            : 
     474                 :          0 :         if ( visPresetLayerElem.hasAttribute( QStringLiteral( "expanded" ) ) )
     475                 :          0 :           layerRecords[layerID].expandedLayerNode = visPresetLayerElem.attribute( QStringLiteral( "expanded" ) ).toInt();
     476                 :          0 :       }
     477                 :          0 :       visPresetLayerElem = visPresetLayerElem.nextSiblingElement( QStringLiteral( "layer" ) );
     478                 :          0 :     }
     479                 :            : 
     480                 :          0 :     QDomElement checkedLegendNodesElem = visPresetElem.firstChildElement( QStringLiteral( "checked-legend-nodes" ) );
     481                 :          0 :     while ( !checkedLegendNodesElem.isNull() )
     482                 :            :     {
     483                 :          0 :       QSet<QString> checkedLegendNodes;
     484                 :            : 
     485                 :          0 :       QDomElement checkedLegendNodeElem = checkedLegendNodesElem.firstChildElement( QStringLiteral( "checked-legend-node" ) );
     486                 :          0 :       while ( !checkedLegendNodeElem.isNull() )
     487                 :            :       {
     488                 :          0 :         checkedLegendNodes << checkedLegendNodeElem.attribute( QStringLiteral( "id" ) );
     489                 :          0 :         checkedLegendNodeElem = checkedLegendNodeElem.nextSiblingElement( QStringLiteral( "checked-legend-node" ) );
     490                 :            :       }
     491                 :            : 
     492                 :          0 :       QString layerID = checkedLegendNodesElem.attribute( QStringLiteral( "id" ) );
     493                 :          0 :       if ( mProject->mapLayer( layerID ) ) // only use valid IDs
     494                 :            :       {
     495                 :          0 :         layerRecords[layerID].usingLegendItems = true;
     496                 :          0 :         layerRecords[layerID].checkedLegendItems = checkedLegendNodes;
     497                 :          0 :       }
     498                 :          0 :       checkedLegendNodesElem = checkedLegendNodesElem.nextSiblingElement( QStringLiteral( "checked-legend-nodes" ) );
     499                 :          0 :     }
     500                 :            : 
     501                 :          0 :     QSet<QString> expandedGroupNodes;
     502                 :          0 :     if ( expandedStateInfo )
     503                 :            :     {
     504                 :            :       // expanded state of legend nodes
     505                 :          0 :       QDomElement expandedLegendNodesElem = visPresetElem.firstChildElement( QStringLiteral( "expanded-legend-nodes" ) );
     506                 :          0 :       while ( !expandedLegendNodesElem.isNull() )
     507                 :            :       {
     508                 :          0 :         QSet<QString> expandedLegendNodes;
     509                 :            : 
     510                 :          0 :         QDomElement expandedLegendNodeElem = expandedLegendNodesElem.firstChildElement( QStringLiteral( "expanded-legend-node" ) );
     511                 :          0 :         while ( !expandedLegendNodeElem.isNull() )
     512                 :            :         {
     513                 :          0 :           expandedLegendNodes << expandedLegendNodeElem.attribute( QStringLiteral( "id" ) );
     514                 :          0 :           expandedLegendNodeElem = expandedLegendNodeElem.nextSiblingElement( QStringLiteral( "expanded-legend-node" ) );
     515                 :            :         }
     516                 :            : 
     517                 :          0 :         QString layerID = expandedLegendNodesElem.attribute( QStringLiteral( "id" ) );
     518                 :          0 :         if ( mProject->mapLayer( layerID ) ) // only use valid IDs
     519                 :            :         {
     520                 :          0 :           layerRecords[layerID].expandedLegendItems = expandedLegendNodes;
     521                 :          0 :         }
     522                 :          0 :         expandedLegendNodesElem = expandedLegendNodesElem.nextSiblingElement( QStringLiteral( "expanded-legend-nodes" ) );
     523                 :          0 :       }
     524                 :            : 
     525                 :            :       // expanded state of group nodes
     526                 :          0 :       QDomElement expandedGroupNodesElem = visPresetElem.firstChildElement( QStringLiteral( "expanded-group-nodes" ) );
     527                 :          0 :       if ( !expandedGroupNodesElem.isNull() )
     528                 :            :       {
     529                 :          0 :         QDomElement expandedGroupNodeElem = expandedGroupNodesElem.firstChildElement( QStringLiteral( "expanded-group-node" ) );
     530                 :          0 :         while ( !expandedGroupNodeElem.isNull() )
     531                 :            :         {
     532                 :          0 :           expandedGroupNodes << expandedGroupNodeElem.attribute( QStringLiteral( "id" ) );
     533                 :          0 :           expandedGroupNodeElem = expandedGroupNodeElem.nextSiblingElement( QStringLiteral( "expanded-group-node" ) );
     534                 :            :         }
     535                 :          0 :       }
     536                 :          0 :     }
     537                 :            : 
     538                 :          0 :     QSet<QString> checkedGroupNodes;
     539                 :          0 :     if ( checkedStateInfo )
     540                 :            :     {
     541                 :            :       // expanded state of legend nodes
     542                 :          0 :       QDomElement checkedGroupNodesElem = visPresetElem.firstChildElement( QStringLiteral( "checked-group-nodes" ) );
     543                 :          0 :       if ( !checkedGroupNodesElem.isNull() )
     544                 :            :       {
     545                 :          0 :         QDomElement checkedGroupNodeElem = checkedGroupNodesElem.firstChildElement( QStringLiteral( "checked-group-node" ) );
     546                 :          0 :         while ( !checkedGroupNodeElem.isNull() )
     547                 :            :         {
     548                 :          0 :           checkedGroupNodes << checkedGroupNodeElem.attribute( QStringLiteral( "id" ) );
     549                 :          0 :           checkedGroupNodeElem = checkedGroupNodeElem.nextSiblingElement( QStringLiteral( "checked-group-node" ) );
     550                 :            :         }
     551                 :          0 :       }
     552                 :          0 :     }
     553                 :            : 
     554                 :          0 :     MapThemeRecord rec;
     555                 :          0 :     rec.setLayerRecords( layerRecords.values() );
     556                 :          0 :     rec.setHasExpandedStateInfo( expandedStateInfo );
     557                 :          0 :     rec.setExpandedGroupNodes( expandedGroupNodes );
     558                 :          0 :     rec.setHasCheckedStateInfo( checkedStateInfo );
     559                 :          0 :     rec.setCheckedGroupNodes( checkedGroupNodes );
     560                 :          0 :     mMapThemes.insert( presetName, rec );
     561                 :          0 :     emit mapThemeChanged( presetName );
     562                 :            : 
     563                 :          0 :     visPresetElem = visPresetElem.nextSiblingElement( QStringLiteral( "visibility-preset" ) );
     564                 :          0 :   }
     565                 :            : 
     566                 :          0 :   reconnectToLayersStyleManager();
     567                 :          0 :   emit mapThemesChanged();
     568                 :          0 : }
     569                 :            : 
     570                 :          0 : void QgsMapThemeCollection::writeXml( QDomDocument &doc )
     571                 :            : {
     572                 :          0 :   QDomElement visPresetsElem = doc.createElement( QStringLiteral( "visibility-presets" ) );
     573                 :            : 
     574                 :          0 :   QList< QString > keys = mMapThemes.keys();
     575                 :            : 
     576                 :          0 :   std::sort( keys.begin(), keys.end() );
     577                 :            : 
     578                 :          0 :   for ( const QString &grpName : std::as_const( keys ) )
     579                 :            :   {
     580                 :          0 :     const MapThemeRecord &rec = mMapThemes.value( grpName );
     581                 :          0 :     QDomElement visPresetElem = doc.createElement( QStringLiteral( "visibility-preset" ) );
     582                 :          0 :     visPresetElem.setAttribute( QStringLiteral( "name" ), grpName );
     583                 :          0 :     if ( rec.hasExpandedStateInfo() )
     584                 :          0 :       visPresetElem.setAttribute( QStringLiteral( "has-expanded-info" ), QStringLiteral( "1" ) );
     585                 :          0 :     if ( rec.hasCheckedStateInfo() )
     586                 :          0 :       visPresetElem.setAttribute( QStringLiteral( "has-checked-group-info" ), QStringLiteral( "1" ) );
     587                 :          0 :     for ( const MapThemeLayerRecord &layerRec : std::as_const( rec.mLayerRecords ) )
     588                 :            :     {
     589                 :          0 :       if ( !layerRec.layer() )
     590                 :          0 :         continue;
     591                 :          0 :       QString layerID = layerRec.layer()->id();
     592                 :          0 :       QDomElement layerElem = doc.createElement( QStringLiteral( "layer" ) );
     593                 :          0 :       layerElem.setAttribute( QStringLiteral( "id" ), layerID );
     594                 :          0 :       layerElem.setAttribute( QStringLiteral( "visible" ), layerRec.isVisible ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
     595                 :          0 :       if ( layerRec.usingCurrentStyle )
     596                 :          0 :         layerElem.setAttribute( QStringLiteral( "style" ), layerRec.currentStyle );
     597                 :          0 :       visPresetElem.appendChild( layerElem );
     598                 :            : 
     599                 :          0 :       if ( layerRec.usingLegendItems )
     600                 :            :       {
     601                 :          0 :         QDomElement checkedLegendNodesElem = doc.createElement( QStringLiteral( "checked-legend-nodes" ) );
     602                 :          0 :         checkedLegendNodesElem.setAttribute( QStringLiteral( "id" ), layerID );
     603                 :          0 :         for ( const QString &checkedLegendNode : std::as_const( layerRec.checkedLegendItems ) )
     604                 :            :         {
     605                 :          0 :           QDomElement checkedLegendNodeElem = doc.createElement( QStringLiteral( "checked-legend-node" ) );
     606                 :          0 :           checkedLegendNodeElem.setAttribute( QStringLiteral( "id" ), checkedLegendNode );
     607                 :          0 :           checkedLegendNodesElem.appendChild( checkedLegendNodeElem );
     608                 :          0 :         }
     609                 :          0 :         visPresetElem.appendChild( checkedLegendNodesElem );
     610                 :          0 :       }
     611                 :            : 
     612                 :          0 :       if ( rec.hasExpandedStateInfo() )
     613                 :            :       {
     614                 :          0 :         layerElem.setAttribute( QStringLiteral( "expanded" ), layerRec.expandedLayerNode ? QStringLiteral( "1" ) : QStringLiteral( "0" ) );
     615                 :            : 
     616                 :          0 :         QDomElement expandedLegendNodesElem = doc.createElement( QStringLiteral( "expanded-legend-nodes" ) );
     617                 :          0 :         expandedLegendNodesElem.setAttribute( QStringLiteral( "id" ), layerID );
     618                 :          0 :         for ( const QString &expandedLegendNode : std::as_const( layerRec.expandedLegendItems ) )
     619                 :            :         {
     620                 :          0 :           QDomElement expandedLegendNodeElem = doc.createElement( QStringLiteral( "expanded-legend-node" ) );
     621                 :          0 :           expandedLegendNodeElem.setAttribute( QStringLiteral( "id" ), expandedLegendNode );
     622                 :          0 :           expandedLegendNodesElem.appendChild( expandedLegendNodeElem );
     623                 :          0 :         }
     624                 :          0 :         visPresetElem.appendChild( expandedLegendNodesElem );
     625                 :          0 :       }
     626                 :          0 :     }
     627                 :            : 
     628                 :          0 :     if ( rec.hasCheckedStateInfo() )
     629                 :            :     {
     630                 :          0 :       QDomElement checkedGroupElems = doc.createElement( QStringLiteral( "checked-group-nodes" ) );
     631                 :          0 :       const QSet<QString> checkedGroupNodes = rec.checkedGroupNodes();
     632                 :          0 :       for ( const QString &groupId : checkedGroupNodes )
     633                 :            :       {
     634                 :          0 :         QDomElement checkedGroupElem = doc.createElement( QStringLiteral( "checked-group-node" ) );
     635                 :          0 :         checkedGroupElem.setAttribute( QStringLiteral( "id" ), groupId );
     636                 :          0 :         checkedGroupElems.appendChild( checkedGroupElem );
     637                 :          0 :       }
     638                 :          0 :       visPresetElem.appendChild( checkedGroupElems );
     639                 :          0 :     }
     640                 :            : 
     641                 :          0 :     if ( rec.hasExpandedStateInfo() )
     642                 :            :     {
     643                 :          0 :       QDomElement expandedGroupElems = doc.createElement( QStringLiteral( "expanded-group-nodes" ) );
     644                 :          0 :       const QSet<QString> expandedGroupNodes = rec.expandedGroupNodes();
     645                 :          0 :       for ( const QString &groupId : expandedGroupNodes )
     646                 :            :       {
     647                 :          0 :         QDomElement expandedGroupElem = doc.createElement( QStringLiteral( "expanded-group-node" ) );
     648                 :          0 :         expandedGroupElem.setAttribute( QStringLiteral( "id" ), groupId );
     649                 :          0 :         expandedGroupElems.appendChild( expandedGroupElem );
     650                 :          0 :       }
     651                 :          0 :       visPresetElem.appendChild( expandedGroupElems );
     652                 :          0 :     }
     653                 :            : 
     654                 :          0 :     visPresetsElem.appendChild( visPresetElem );
     655                 :          0 :   }
     656                 :            : 
     657                 :          0 :   doc.firstChildElement( QStringLiteral( "qgis" ) ).appendChild( visPresetsElem );
     658                 :          0 : }
     659                 :            : 
     660                 :          0 : void QgsMapThemeCollection::registryLayersRemoved( const QStringList &layerIDs )
     661                 :            : {
     662                 :            :   // while layers are stored as weak pointers, this triggers the mapThemeChanged signal for
     663                 :            :   // affected themes
     664                 :          0 :   QSet< QString > changedThemes;
     665                 :          0 :   MapThemeRecordMap::iterator it = mMapThemes.begin();
     666                 :          0 :   for ( ; it != mMapThemes.end(); ++it )
     667                 :            :   {
     668                 :          0 :     MapThemeRecord &rec = it.value();
     669                 :          0 :     for ( int i = 0; i < rec.mLayerRecords.count(); ++i )
     670                 :            :     {
     671                 :          0 :       MapThemeLayerRecord &layerRec = rec.mLayerRecords[i];
     672                 :          0 :       if ( layerRec.layer() && layerIDs.contains( layerRec.layer()->id() ) )
     673                 :            :       {
     674                 :          0 :         rec.mLayerRecords.removeAt( i-- );
     675                 :          0 :         changedThemes << it.key();
     676                 :          0 :       }
     677                 :          0 :     }
     678                 :          0 :   }
     679                 :            : 
     680                 :          0 :   for ( const QString &theme : std::as_const( changedThemes ) )
     681                 :            :   {
     682                 :          0 :     emit mapThemeChanged( theme );
     683                 :            :   }
     684                 :          0 :   emit mapThemesChanged();
     685                 :          0 : }
     686                 :            : 
     687                 :          0 : void QgsMapThemeCollection::layerStyleRenamed( const QString &oldName, const QString &newName )
     688                 :            : {
     689                 :          0 :   QgsMapLayerStyleManager *styleMgr = qobject_cast<QgsMapLayerStyleManager *>( sender() );
     690                 :          0 :   if ( !styleMgr )
     691                 :          0 :     return;
     692                 :            : 
     693                 :          0 :   QSet< QString > changedThemes;
     694                 :            : 
     695                 :          0 :   MapThemeRecordMap::iterator it = mMapThemes.begin();
     696                 :          0 :   for ( ; it != mMapThemes.end(); ++it )
     697                 :            :   {
     698                 :          0 :     MapThemeRecord &rec = it.value();
     699                 :          0 :     for ( int i = 0; i < rec.mLayerRecords.count(); ++i )
     700                 :            :     {
     701                 :          0 :       MapThemeLayerRecord &layerRec = rec.mLayerRecords[i];
     702                 :          0 :       if ( layerRec.layer() == styleMgr->layer() )
     703                 :            :       {
     704                 :          0 :         if ( layerRec.currentStyle == oldName )
     705                 :            :         {
     706                 :          0 :           layerRec.currentStyle = newName;
     707                 :          0 :           changedThemes << it.key();
     708                 :          0 :         }
     709                 :          0 :       }
     710                 :          0 :     }
     711                 :          0 :   }
     712                 :            : 
     713                 :          0 :   for ( const QString &theme : std::as_const( changedThemes ) )
     714                 :            :   {
     715                 :          0 :     emit mapThemeChanged( theme );
     716                 :            :   }
     717                 :          0 :   emit mapThemesChanged();
     718                 :          0 : }
     719                 :            : 
     720                 :          0 : void QgsMapThemeCollection::MapThemeRecord::removeLayerRecord( QgsMapLayer *layer )
     721                 :            : {
     722                 :          0 :   for ( int i = 0; i < mLayerRecords.length(); ++i )
     723                 :            :   {
     724                 :          0 :     if ( mLayerRecords.at( i ).layer() == layer )
     725                 :          0 :       mLayerRecords.removeAt( i );
     726                 :          0 :   }
     727                 :          0 : }
     728                 :            : 
     729                 :          0 : void QgsMapThemeCollection::MapThemeRecord::addLayerRecord( const QgsMapThemeCollection::MapThemeLayerRecord &record )
     730                 :            : {
     731                 :          0 :   mLayerRecords.append( record );
     732                 :          0 : }
     733                 :            : 
     734                 :          0 : QHash<QgsMapLayer *, QgsMapThemeCollection::MapThemeLayerRecord> QgsMapThemeCollection::MapThemeRecord::validLayerRecords() const
     735                 :            : {
     736                 :          0 :   QHash<QgsMapLayer *, MapThemeLayerRecord> validSet;
     737                 :          0 :   for ( const MapThemeLayerRecord &layerRec : mLayerRecords )
     738                 :            :   {
     739                 :          0 :     if ( auto *lLayer = layerRec.layer() )
     740                 :          0 :       validSet.insert( lLayer, layerRec );
     741                 :            :   }
     742                 :          0 :   return validSet;
     743                 :          0 : }
     744                 :            : 
     745                 :          0 : void QgsMapThemeCollection::MapThemeLayerRecord::setLayer( QgsMapLayer *layer )
     746                 :            : {
     747                 :          0 :   mLayer = layer;
     748                 :          0 : }

Generated by: LCOV version 1.14