Merge pull request #1255 from Oslandia/atlas_signals

Atlas signals

Author: nyalldawson

python/core/composer/qgsatlascomposition.sip

@@ -122,4 +122,9 @@ public:
     /**Is emitted when the coverage layer for an atlas changes*/
     void coverageLayerChanged( QgsVectorLayer* layer );
 
+    /**Is emitted when atlas rendering has begun*/
+    void renderBegun();
+
+    /**Is emitted when atlas rendering has ended*/
+    void renderEnded();
 };

python/core/composer/qgscomposermap.sip

@@ -407,6 +407,9 @@ class QgsComposerMap : QgsComposerItem
     /**Is emitted on rotation change to notify north arrow pictures*/
     void mapRotationChanged( double newRotation );
 
+    /**Is emitted when the map has been prepared for atlas rendering, just before actual rendering*/
+    void preparedForAtlas();
+
   public slots:
 
     /**Called if map canvas has changed*/

src/core/composer/qgsatlascomposition.cpp

@@ -266,6 +266,8 @@ bool QgsAtlasComposition::beginRender()
     return false;
   }
 
+  emit renderBegun();
+
   bool featuresUpdated = updateFeatures();
   if ( !featuresUpdated )
   {
@@ -296,6 +298,8 @@ void QgsAtlasComposition::endRender()
   }
 
   updateAtlasMaps();
+
+  emit renderEnded();
 }
 
 void QgsAtlasComposition::updateAtlasMaps()

src/core/composer/qgsatlascomposition.h

@@ -150,6 +150,12 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
     /**Is emitted when the coverage layer for an atlas changes*/
     void coverageLayerChanged( QgsVectorLayer* layer );
 
+    /**Is emitted when atlas rendering has begun*/
+    void renderBegun();
+
+    /**Is emitted when atlas rendering has ended*/
+    void renderEnded();
+
   private:
     /**Updates the filename expression*/
     void updateFilenameExpression();

src/core/composer/qgscomposermap.cpp

@@ -641,6 +641,7 @@ void QgsComposerMap::setNewAtlasFeatureExtent( const QgsRectangle& extent )
 
   mAtlasFeatureExtent = newExtent;
   mCacheUpdated = false;
+  emit preparedForAtlas();
   updateItem();
   emit itemChanged();
   emit extentChanged();

src/core/composer/qgscomposermap.h

@@ -445,6 +445,9 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
     /**Is emitted on rotation change to notify north arrow pictures*/
     void mapRotationChanged( double newRotation );
 
+    /**Is emitted when the map has been prepared for atlas rendering, just before actual rendering*/
+    void preparedForAtlas();
+
   public slots:
 
     /**Called if map canvas has changed*/

src/core/composer/qgscomposition.cpp

@@ -2537,6 +2537,7 @@ bool QgsComposition::setAtlasMode( QgsComposition::AtlasMode mode )
     if ( ! atlasHasFeatures )
     {
       mAtlasMode = QgsComposition::AtlasOff;
+      mAtlasComposition.endRender();
       return false;
     }
   }

tests/src/core/testqgsatlascomposition.cpp

@@ -28,6 +28,7 @@
 #include "qgssymbolv2.h"
 #include "qgssinglesymbolrendererv2.h"
 #include <QObject>
+#include <QSignalSpy>
 #include <QtTest>
 
 class TestQgsAtlasComposition: public QObject
@@ -57,6 +58,8 @@ class TestQgsAtlasComposition: public QObject
     void sorting_render();
     // test rendering with feature filtering
     void filtering_render();
+    // test render signals
+    void test_signals();
   private:
     QgsComposition* mComposition;
     QgsComposerLabel* mLabel1;
@@ -365,5 +368,31 @@ void TestQgsAtlasComposition::filtering_render()
   mAtlas->endRender();
 }
 
+void TestQgsAtlasComposition::test_signals()
+{
+  mAtlasMap->setNewExtent( QgsRectangle( 209838.166, 6528781.020, 610491.166, 6920530.620 ) );
+  mAtlasMap->setAtlasDriven( true );
+  mAtlasMap->setAtlasFixedScale( true );
+  mAtlas->setHideCoverage( false );
+  mAtlas->setSortFeatures( false );
+  mAtlas->setFilterFeatures( false );
+
+  QSignalSpy spyRenderBegun( mAtlas, SIGNAL(renderBegun()) );
+  QSignalSpy spyRenderEnded( mAtlas, SIGNAL(renderEnded()) );
+  QSignalSpy spyPreparedForAtlas( mAtlasMap, SIGNAL(preparedForAtlas()) );  
+  mAtlas->beginRender();
+
+  QVERIFY( spyRenderBegun.count() == 1 );
+
+  for ( int fit = 0; fit < 2; ++fit )
+  {
+    mAtlas->prepareForFeature( fit );
+    mLabel1->adjustSizeToText();
+  }
+  QVERIFY( spyPreparedForAtlas.count() == 2 );
+  mAtlas->endRender();
+  QVERIFY( spyRenderEnded.count() == 1 );
+}
+
 QTEST_MAIN( TestQgsAtlasComposition )
 #include "moc_testqgsatlascomposition.cxx"