Skip to content

Commit 5e3b903

Browse files
nyalldawsonnyalldawson
committedMay 8, 2017
[needs-docs][composer] Remove Rectangle mode from composer maps
No longer required - the Cache mode is now performant enough that we don't have to rely on the old rectangle preview when desiring responsive composers
·
ltr-3_40final-3_0_0
1 parent 3f595ee commit 5e3b903

File tree

6 files changed

+14
-50
lines changed

6 files changed

+14
-50
lines changed
 

‎doc/api_break.dox

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,6 +641,7 @@ and setAtlasScalingMode() instead.
641641
associated project's annotationManager()
642642
- setDrawCanvasItems() and drawCanvasItems() were renamed to setDrawAnnotations() and drawAnnotations()
643643
- setCacheUpdated(), updateCachedImage() and cache() were removed. Use invalidateCache() instead.
644+
- The Rectangle mode enum was removed. Use the reworked Cache mode instead.
644645

645646

646647
QgsComposerMapGrid {#qgis_api_break_3_0_QgsComposerMapGrid}

‎python/core/composer/qgscomposermap.sip

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Return correct graphics item type.
4040
{
4141
Cache,
4242
Render,
43-
Rectangle
4443
};
4544

4645
enum AtlasScalingMode

‎src/app/composer/qgscomposermapwidget.cpp

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ QgsComposerMapWidget::QgsComposerMapWidget( QgsComposerMap *composerMap )
6262
blockAllSignals( true );
6363
mPreviewModeComboBox->insertItem( 0, tr( "Cache" ) );
6464
mPreviewModeComboBox->insertItem( 1, tr( "Render" ) );
65-
mPreviewModeComboBox->insertItem( 2, tr( "Rectangle" ) );
6665

6766
mCrsSelector->setOptionVisible( QgsProjectionSelectionWidget::CrsNotSet, true );
6867
mCrsSelector->setNotSetText( tr( "Use project CRS" ) );
@@ -446,20 +445,15 @@ void QgsComposerMapWidget::on_mPreviewModeComboBox_activated( int i )
446445
}
447446

448447
QString comboText = mPreviewModeComboBox->currentText();
449-
if ( comboText == tr( "Cache" ) )
450-
{
451-
mComposerMap->setPreviewMode( QgsComposerMap::Cache );
452-
mUpdatePreviewButton->setEnabled( true );
453-
}
454-
else if ( comboText == tr( "Render" ) )
448+
if ( comboText == tr( "Render" ) )
455449
{
456450
mComposerMap->setPreviewMode( QgsComposerMap::Render );
457451
mUpdatePreviewButton->setEnabled( true );
458452
}
459-
else if ( comboText == tr( "Rectangle" ) )
453+
else
460454
{
461-
mComposerMap->setPreviewMode( QgsComposerMap::Rectangle );
462-
mUpdatePreviewButton->setEnabled( false );
455+
mComposerMap->setPreviewMode( QgsComposerMap::Cache );
456+
mUpdatePreviewButton->setEnabled( true );
463457
}
464458

465459
mComposerMap->invalidateCache();
@@ -630,20 +624,15 @@ void QgsComposerMapWidget::updateGuiElements()
630624
//preview mode
631625
QgsComposerMap::PreviewMode previewMode = mComposerMap->previewMode();
632626
int index = -1;
633-
if ( previewMode == QgsComposerMap::Cache )
634-
{
635-
index = mPreviewModeComboBox->findText( tr( "Cache" ) );
636-
mUpdatePreviewButton->setEnabled( true );
637-
}
638-
else if ( previewMode == QgsComposerMap::Render )
627+
if ( previewMode == QgsComposerMap::Render )
639628
{
640629
index = mPreviewModeComboBox->findText( tr( "Render" ) );
641630
mUpdatePreviewButton->setEnabled( true );
642631
}
643-
else if ( previewMode == QgsComposerMap::Rectangle )
632+
else
644633
{
645-
index = mPreviewModeComboBox->findText( tr( "Rectangle" ) );
646-
mUpdatePreviewButton->setEnabled( false );
634+
index = mPreviewModeComboBox->findText( tr( "Cache" ) );
635+
mUpdatePreviewButton->setEnabled( true );
647636
}
648637
if ( index != -1 )
649638
{

‎src/core/composer/qgscomposermap.cpp

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,6 @@ QgsMapSettings QgsComposerMap::mapSettings( const QgsRectangle &extent, QSizeF s
208208

209209
void QgsComposerMap::recreateCachedImageInBackground()
210210
{
211-
if ( mPreviewMode == Rectangle )
212-
{
213-
return;
214-
}
215-
216211
if ( mPainterJob )
217212
{
218213
disconnect( mPainterJob.get(), &QgsMapRendererCustomPainterJob::finished, this, &QgsComposerMap::painterJobFinished );
@@ -325,16 +320,7 @@ void QgsComposerMap::paint( QPainter *painter, const QStyleOptionGraphicsItem *,
325320
painter->save();
326321
painter->setClipRect( thisPaintRect );
327322

328-
if ( mComposition->plotStyle() == QgsComposition::Preview && mPreviewMode == Rectangle )
329-
{
330-
// Fill with background color
331-
drawBackground( painter );
332-
QFont messageFont( QLatin1String( "" ), 12 );
333-
painter->setFont( messageFont );
334-
painter->setPen( QColor( 0, 0, 0, 125 ) );
335-
painter->drawText( thisPaintRect, tr( "Map will be printed here" ) );
336-
}
337-
else if ( mComposition->plotStyle() == QgsComposition::Preview )
323+
if ( mComposition->plotStyle() == QgsComposition::Preview )
338324
{
339325
if ( !mCacheFinalImage || mCacheFinalImage->isNull() )
340326
{
@@ -416,13 +402,11 @@ void QgsComposerMap::paint( QPainter *painter, const QStyleOptionGraphicsItem *,
416402
}
417403

418404
painter->setClipRect( thisPaintRect, Qt::NoClip );
419-
if ( shouldDrawPart( OverviewMapExtent ) &&
420-
( mComposition->plotStyle() != QgsComposition::Preview || mPreviewMode != Rectangle ) )
405+
if ( shouldDrawPart( OverviewMapExtent ) )
421406
{
422407
mOverviewStack->drawItems( painter );
423408
}
424-
if ( shouldDrawPart( Grid ) &&
425-
( mComposition->plotStyle() != QgsComposition::Preview || mPreviewMode != Rectangle ) )
409+
if ( shouldDrawPart( Grid ) )
426410
{
427411
mGridStack->drawItems( painter );
428412
}
@@ -1304,21 +1288,16 @@ bool QgsComposerMap::readXml( const QDomElement &itemElem, const QDomDocument &d
13041288
mId = idRead.toInt();
13051289
updateToolTip();
13061290
}
1307-
mPreviewMode = Rectangle;
13081291

13091292
//previewMode
13101293
QString previewMode = itemElem.attribute( QStringLiteral( "previewMode" ) );
1311-
if ( previewMode == QLatin1String( "Cache" ) )
1312-
{
1313-
mPreviewMode = Cache;
1314-
}
1315-
else if ( previewMode == QLatin1String( "Render" ) )
1294+
if ( previewMode == QLatin1String( "Render" ) )
13161295
{
13171296
mPreviewMode = Render;
13181297
}
13191298
else
13201299
{
1321-
mPreviewMode = Rectangle;
1300+
mPreviewMode = Cache;
13221301
}
13231302

13241303
//extent

‎src/core/composer/qgscomposermap.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
6969
{
7070
Cache = 0, // Use raster cache
7171
Render, // Render the map
72-
Rectangle // Display only rectangle
7372
};
7473

7574
/** Scaling modes used for the serial rendering (atlas)

‎tests/src/core/testqgsatlascomposition.cpp

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,6 @@ void TestQgsAtlasComposition::init()
151151
// the atlas map
152152
mAtlasMap = new QgsComposerMap( mComposition, 20, 20, 130, 130 );
153153
mAtlasMap->setFrameEnabled( true );
154-
// Make sure it doesn't try to render a map for caching onto a still 0-sized image
155-
mAtlasMap->setPreviewMode( QgsComposerMap::Rectangle );
156154
mComposition->addComposerMap( mAtlasMap );
157155
mAtlasMap->setLayers( QList<QgsMapLayer *>() << mVectorLayer );
158156

@@ -165,7 +163,6 @@ void TestQgsAtlasComposition::init()
165163
mOverview = new QgsComposerMap( mComposition, 180, 20, 50, 50 );
166164
mOverview->setFrameEnabled( true );
167165
mOverview->overview()->setFrameMap( mAtlasMap->id() );
168-
mOverview->setPreviewMode( QgsComposerMap::Rectangle );
169166
mOverview->setLayers( QList<QgsMapLayer *>() << mVectorLayer );
170167
mComposition->addComposerMap( mOverview );
171168
mOverview->setNewExtent( QgsRectangle( 49670.718, 6415139.086, 699672.519, 7065140.887 ) );

0 commit comments

Comments
 (0)
Please sign in to comment.