Merge branch 'multiframe_options'

Author: mhugent

python/core/qgscomposermultiframe.sip

@@ -9,7 +9,9 @@ public:
     enum ResizeMode
     {
       UseExistingFrames = 0,
-      ExtendToNextPage //duplicates last frame to next page to fit the total size
+      ExtendToNextPage, //uses the next page(s) until the content has been printed
+      RepeatOnEveryPage, //repeats the same frame on every page
+      RepeatUntilFinished //duplicates last frame to next page to fit the total size
     };
 
     QgsComposerMultiFrame( QgsComposition* c, bool createUndoCommands );
@@ -41,4 +43,4 @@ public:
     void deleteFrames();
 
     int nFrames() const;
-};
+};

src/app/composer/qgscomposerhtmlwidget.cpp

@@ -13,6 +13,8 @@ QgsComposerHtmlWidget::QgsComposerHtmlWidget( QgsComposerHtml* html, QgsComposer
   blockSignals( true );
   mResizeModeComboBox->addItem( tr( "Use existing frames" ), QgsComposerMultiFrame::UseExistingFrames );
   mResizeModeComboBox->addItem( tr( "Extend to next page" ), QgsComposerMultiFrame::ExtendToNextPage );
+  mResizeModeComboBox->addItem( tr( "Repeat on every page" ), QgsComposerMultiFrame::RepeatOnEveryPage );
+  mResizeModeComboBox->addItem( tr( "Repeat until finished" ), QgsComposerMultiFrame::RepeatUntilFinished );
   blockSignals( false );
   setGuiElementValues();
 

src/core/composer/qgscomposermultiframe.cpp

@@ -19,6 +19,7 @@
 QgsComposerMultiFrame::QgsComposerMultiFrame( QgsComposition* c, bool createUndoCommands ): mComposition( c ), mResizeMode( UseExistingFrames ), mCreateUndoCommands( createUndoCommands )
 {
   mComposition->addMultiFrame( this );
+  connect( mComposition, SIGNAL( nPagesChanged() ), this, SLOT( handlePageChange() ) );
 }
 
 QgsComposerMultiFrame::QgsComposerMultiFrame(): mComposition( 0 ), mResizeMode( UseExistingFrames )
@@ -61,9 +62,9 @@ void QgsComposerMultiFrame::recalculateFrameSizes()
 
   for ( int i = 0; i < mFrameItems.size(); ++i )
   {
-    if ( currentY >= totalHeight )
+    if ( mResizeMode != RepeatOnEveryPage && currentY >= totalHeight )
     {
-      if ( mResizeMode == ExtendToNextPage ) //remove unneeded frames in extent mode
+      if ( mResizeMode == RepeatUntilFinished || mResizeMode == ExtendToNextPage ) //remove unneeded frames in extent mode
       {
         for ( int j = mFrameItems.size(); j > i; --j )
         {
@@ -75,30 +76,67 @@ void QgsComposerMultiFrame::recalculateFrameSizes()
 
     currentItem = mFrameItems.value( i );
     currentHeight = currentItem->rect().height();
-    currentItem->setContentSection( QRectF( 0, currentY, currentItem->rect().width(), currentHeight ) );
+    if ( mResizeMode == RepeatOnEveryPage )
+    {
+      currentItem->setContentSection( QRectF( 0, 0, currentItem->rect().width(), currentHeight ) );
+    }
+    else
+    {
+      currentItem->setContentSection( QRectF( 0, currentY, currentItem->rect().width(), currentHeight ) );
+    }
     currentItem->update();
     currentY += currentHeight;
   }
 
   //at end of frames but there is  still content left. Add other pages if ResizeMode ==
-  if ( mResizeMode == ExtendToNextPage )
+  if ( mResizeMode != UseExistingFrames )
   {
-    while ( currentY < totalHeight )
+    while (( mResizeMode == RepeatOnEveryPage ) || currentY < totalHeight )
     {
       //find out on which page the lower left point of the last frame is
       int page = currentItem->transform().dy() / ( mComposition->paperHeight() + mComposition->spaceBetweenPages() );
+      if ( mResizeMode == RepeatOnEveryPage )
+      {
+        if ( page > mComposition->numPages() - 2 )
+        {
+          break;
+        }
+      }
+      else
+      {
+        if ( mComposition->numPages() < ( page + 2 ) )
+        {
+          mComposition->setNumPages( page + 2 );
+        }
+      }
 
-      //add new pages if necessary
-      if ( mComposition->numPages() < ( page + 2 ) )
+      double frameHeight = 0;
+      if ( mResizeMode == RepeatUntilFinished || mResizeMode == RepeatOnEveryPage )
       {
-        mComposition->setNumPages( page + 2 );
+        frameHeight = currentItem->rect().height();
+      }
+      else //mResizeMode == ExtendToNextPage
+      {
+        frameHeight = ( currentY + mComposition->paperHeight() ) > totalHeight ?  totalHeight - currentY : mComposition->paperHeight();
       }
 
-      //copy last frame
-      QgsComposerFrame* newFrame = new QgsComposerFrame( mComposition, this, currentItem->transform().dx(), currentItem->transform().dy() + mComposition->paperHeight() + mComposition->spaceBetweenPages(),
-          currentItem->rect().width(), currentItem->rect().height() );
-      newFrame->setContentSection( QRectF( 0, currentY, newFrame->rect().width(), newFrame->rect().height() ) );
-      currentY += newFrame->rect().height();
+      double newFrameY = ( page + 1 ) * ( mComposition->paperHeight() + mComposition->spaceBetweenPages() );
+      if ( mResizeMode == RepeatUntilFinished || mResizeMode == RepeatOnEveryPage )
+      {
+        newFrameY += currentItem->transform().dy() - page * ( mComposition->paperHeight() + mComposition->spaceBetweenPages() );
+      }
+      QgsComposerFrame* newFrame = new QgsComposerFrame( mComposition, this, currentItem->transform().dx(),
+          newFrameY,
+          currentItem->rect().width(), frameHeight );
+      if ( mResizeMode == RepeatOnEveryPage )
+      {
+        newFrame->setContentSection( QRectF( 0, 0, newFrame->rect().width(), newFrame->rect().height() ) );
+      }
+      else
+      {
+        newFrame->setContentSection( QRectF( 0, currentY, newFrame->rect().width(), newFrame->rect().height() ) );
+      }
+      currentY += frameHeight;
       currentItem = newFrame;
       addFrame( newFrame, false );
     }
@@ -124,13 +162,55 @@ void QgsComposerMultiFrame::handleFrameRemoval( QgsComposerItem* item )
   }
 }
 
+void QgsComposerMultiFrame::handlePageChange()
+{
+  if ( mComposition->numPages() < 1 )
+  {
+    return;
+  }
+
+  if ( mResizeMode != RepeatOnEveryPage )
+  {
+    return;
+  }
+
+  //remove items beginning on non-existing pages
+  for ( int i = mFrameItems.size() - 1; i >= 0; --i )
+  {
+    QgsComposerFrame* frame = mFrameItems[i];
+    int page = frame->transform().dy() / ( mComposition->paperHeight() + mComposition->spaceBetweenPages() );
+    if ( page > ( mComposition->numPages() - 1 ) )
+    {
+      removeFrame( i );
+    }
+  }
+
+  //page number of the last item
+  QgsComposerFrame* lastFrame = mFrameItems.last();
+  int lastItemPage = lastFrame->transform().dy() / ( mComposition->paperHeight() + mComposition->spaceBetweenPages() );
+
+  for ( int i = lastItemPage + 1; i < mComposition->numPages(); ++i )
+  {
+    //copy last frame to current page
+    QgsComposerFrame* newFrame = new QgsComposerFrame( mComposition, this, lastFrame->transform().dx(),
+        lastFrame->transform().dy() + mComposition->paperHeight() + mComposition->spaceBetweenPages(),
+        lastFrame->rect().width(), lastFrame->rect().height() );
+    addFrame( newFrame, false );
+    lastFrame = newFrame;
+  }
+
+  recalculateFrameSizes();
+  update();
+}
+
 void QgsComposerMultiFrame::removeFrame( int i )
 {
   QgsComposerFrame* frameItem = mFrameItems[i];
   if ( mComposition )
   {
     mComposition->removeComposerItem( frameItem );
   }
+  mFrameItems.removeAt( i );
 }
 
 void QgsComposerMultiFrame::update()

src/core/composer/qgscomposermultiframe.h

@@ -36,7 +36,9 @@ class CORE_EXPORT QgsComposerMultiFrame: public QObject
     enum ResizeMode
     {
       UseExistingFrames = 0,
-      ExtendToNextPage //duplicates last frame to next page to fit the total size
+      ExtendToNextPage, //uses the next page(s) until the content has been printed
+      RepeatOnEveryPage, //repeats the same frame on every page
+      RepeatUntilFinished //duplicates last frame to next page to fit the total size
     };
 
     QgsComposerMultiFrame( QgsComposition* c, bool createUndoCommands );
@@ -80,6 +82,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QObject
     void recalculateFrameSizes();
     /**Called before a frame is going to be removed (update frame list)*/
     void handleFrameRemoval( QgsComposerItem* item );
+    /**Adapts to changed number of pages if resize type is RepeatOnEveryPage*/
+    void handlePageChange();
 
   private:
     QgsComposerMultiFrame(); //forbidden

src/core/composer/qgscomposition.cpp

@@ -118,6 +118,7 @@ void QgsComposition::setNumPages( int pages )
       mPages.removeLast();
     }
   }
+  emit nPagesChanged();
 }
 
 int QgsComposition::numPages() const

src/core/composer/qgscomposition.h

@@ -311,6 +311,7 @@ class CORE_EXPORT QgsComposition: public QGraphicsScene
 
   signals:
     void paperSizeChanged();
+    void nPagesChanged();
 
     /**Is emitted when selected item changed. If 0, no item is selected*/
     void selectedItemChanged( QgsComposerItem* selected );