Skip to content

Commit e0934d7

Browse files
nyalldawsonnyalldawson
committedJan 16, 2017
[composer][needs-docs] Rename "world file map" option to "reference map"
This option will be used for more than just world file generation, and instead will indicate which map should be considered the master map for the composition from which any composer properties calculating map units will derive the scale from.
1 parent 5abe66b commit e0934d7

File tree

11 files changed

+129
-134
lines changed

11 files changed

+129
-134
lines changed
 

‎doc/api_break.dox

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,7 @@ were removed. Use setSnapTolerance() and snapTolerance() instead.
646646
- sortZList() was removed. Use refreshZList() instead.
647647
- addComposerTable(), composerTableAdded() were removed.
648648
- setAllUnselected() has been renamed to setAllDeselected. <!--#spellok-->
649+
- worldFileMap() and setWorldFileMap() have been renamed to referenceMap() and setReferenceMap()
649650

650651

651652
QgsCoordinateReferenceSystem {#qgis_api_break_3_0_QgsCoordinateReferenceSystem}

‎python/core/composer/qgscomposition.sip

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -359,20 +359,9 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator
359359
*/
360360
void setGenerateWorldFile( bool enabled );
361361

362-
/** Returns the map item which will be used to generate corresponding world files when the
363-
* composition is exported, or nullptr if no corresponding map is set.
364-
* @see setWorldFileMap()
365-
* @see generateWorldFile()
366-
*/
367-
QgsComposerMap* worldFileMap() const;
362+
QgsComposerMap* referenceMap() const;
368363

369-
/** Sets the map item which will be used to generate corresponding world files when the
370-
* composition is exported.
371-
* @param map composer map item
372-
* @see worldFileMap()
373-
* @see setGenerateWorldFile()
374-
*/
375-
void setWorldFileMap( QgsComposerMap* map );
364+
void setReferenceMap( QgsComposerMap* map );
376365

377366
/** Returns true if a composition should use advanced effects such as blend modes */
378367
bool useAdvancedEffects() const;

‎src/app/composer/qgscomposer.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2077,9 +2077,9 @@ void QgsComposer::exportCompositionAsImage( QgsComposer::OutputMode mode )
20772077
mView->setPaintingEnabled( false );
20782078

20792079
int worldFilePageNo = -1;
2080-
if ( mComposition->worldFileMap() )
2080+
if ( mComposition->referenceMap() )
20812081
{
2082-
worldFilePageNo = mComposition->worldFileMap()->page() - 1;
2082+
worldFilePageNo = mComposition->referenceMap()->page() - 1;
20832083
}
20842084

20852085
for ( int i = 0; i < mComposition->numPages(); ++i )
@@ -2315,9 +2315,9 @@ void QgsComposer::exportCompositionAsImage( QgsComposer::OutputMode mode )
23152315
QString filename = QDir( dir ).filePath( atlasMap->currentFilename() ) + fileExt;
23162316

23172317
int worldFilePageNo = -1;
2318-
if ( mComposition->worldFileMap() )
2318+
if ( mComposition->referenceMap() )
23192319
{
2320-
worldFilePageNo = mComposition->worldFileMap()->page() - 1;
2320+
worldFilePageNo = mComposition->referenceMap()->page() - 1;
23212321
}
23222322

23232323
for ( int i = 0; i < mComposition->numPages(); ++i )

‎src/app/composer/qgscompositionwidget.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ QgsCompositionWidget::QgsCompositionWidget( QWidget* parent, QgsComposition* c )
8282
mGenerateWorldFileCheckBox->setChecked( mComposition->generateWorldFile() );
8383

8484
// populate the map list
85-
mWorldFileMapComboBox->setComposition( mComposition );
86-
mWorldFileMapComboBox->setItemType( QgsComposerItem::ComposerMap );
87-
mWorldFileMapComboBox->setItem( mComposition->worldFileMap() );
85+
mReferenceMapComboBox->setComposition( mComposition );
86+
mReferenceMapComboBox->setItemType( QgsComposerItem::ComposerMap );
87+
mReferenceMapComboBox->setItem( mComposition->referenceMap() );
8888

8989
mSnapToleranceSpinBox->setValue( mComposition->snapTolerance() );
9090

@@ -124,7 +124,7 @@ QgsCompositionWidget::QgsCompositionWidget( QWidget* parent, QgsComposition* c )
124124
connect( mPaperOrientationDDBtn, SIGNAL( dataDefinedActivated( bool ) ), this, SLOT( updateDataDefinedProperty() ) );
125125
connect( mPaperOrientationDDBtn, SIGNAL( dataDefinedActivated( bool ) ), mPaperOrientationComboBox, SLOT( setDisabled( bool ) ) );
126126

127-
connect( mWorldFileMapComboBox, SIGNAL( itemChanged( QgsComposerItem* ) ), this, SLOT( worldFileMapChanged( QgsComposerItem* ) ) );
127+
connect( mReferenceMapComboBox, &QgsComposerItemComboBox::itemChanged, this, &QgsCompositionWidget::referenceMapChanged );
128128

129129
//initialize data defined buttons
130130
populateDataDefinedButtons();
@@ -679,15 +679,15 @@ void QgsCompositionWidget::on_mGenerateWorldFileCheckBox_toggled( bool state )
679679
mComposition->setGenerateWorldFile( state );
680680
}
681681

682-
void QgsCompositionWidget::worldFileMapChanged( QgsComposerItem* item )
682+
void QgsCompositionWidget::referenceMapChanged( QgsComposerItem* item )
683683
{
684684
if ( !mComposition )
685685
{
686686
return;
687687
}
688688

689689
QgsComposerMap* map = dynamic_cast< QgsComposerMap* >( item );
690-
mComposition->setWorldFileMap( map );
690+
mComposition->setReferenceMap( map );
691691
}
692692

693693
void QgsCompositionWidget::on_mGridResolutionSpinBox_valueChanged( double d )
@@ -738,6 +738,6 @@ void QgsCompositionWidget::blockSignals( bool block )
738738
mOffsetYSpinBox->blockSignals( block );
739739
mSnapToleranceSpinBox->blockSignals( block );
740740
mGenerateWorldFileCheckBox->blockSignals( block );
741-
mWorldFileMapComboBox->blockSignals( block );
741+
mReferenceMapComboBox->blockSignals( block );
742742
}
743743

‎src/app/composer/qgscompositionwidget.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid
5454
void on_mResolutionSpinBox_valueChanged( const int value );
5555
void on_mPrintAsRasterCheckBox_toggled( bool state );
5656
void on_mGenerateWorldFileCheckBox_toggled( bool state );
57-
void worldFileMapChanged( QgsComposerItem* );
57+
void referenceMapChanged( QgsComposerItem* );
5858

5959
void on_mGridResolutionSpinBox_valueChanged( double d );
6060
void on_mOffsetXSpinBox_valueChanged( double d );

‎src/core/composer/qgscomposition.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -789,12 +789,12 @@ void QgsComposition::setPrintResolution( const int dpi )
789789
mProject->setDirty( true );
790790
}
791791

792-
QgsComposerMap* QgsComposition::worldFileMap() const
792+
QgsComposerMap* QgsComposition::referenceMap() const
793793
{
794794
return dynamic_cast< QgsComposerMap* >( const_cast< QgsComposerItem* >( getComposerItemByUuid( mWorldFileMapId ) ) );
795795
}
796796

797-
void QgsComposition::setWorldFileMap( QgsComposerMap* map )
797+
void QgsComposition::setReferenceMap( QgsComposerMap* map )
798798
{
799799
mWorldFileMapId = map ? map->uuid() : QString();
800800
mProject->setDirty( true );
@@ -3047,7 +3047,7 @@ void QgsComposition::renderRect( QPainter* p, const QRectF& rect )
30473047
double* QgsComposition::computeGeoTransform( const QgsComposerMap* map, const QRectF& region , double dpi ) const
30483048
{
30493049
if ( !map )
3050-
map = worldFileMap();
3050+
map = referenceMap();
30513051

30523052
if ( !map )
30533053
return nullptr;
@@ -3151,7 +3151,7 @@ QGraphicsView *QgsComposition::graphicsView() const
31513151

31523152
void QgsComposition::computeWorldFileParameters( double& a, double& b, double& c, double& d, double& e, double& f ) const
31533153
{
3154-
const QgsComposerMap* map = worldFileMap();
3154+
const QgsComposerMap* map = referenceMap();
31553155
if ( !map )
31563156
{
31573157
return;
@@ -3166,7 +3166,7 @@ void QgsComposition::computeWorldFileParameters( double& a, double& b, double& c
31663166
void QgsComposition::computeWorldFileParameters( const QRectF& exportRegion, double& a, double& b, double& c, double& d, double& e, double& f ) const
31673167
{
31683168
// World file parameters : affine transformation parameters from pixel coordinates to map coordinates
3169-
QgsComposerMap* map = worldFileMap();
3169+
QgsComposerMap* map = referenceMap();
31703170
if ( !map )
31713171
{
31723172
return;

‎src/core/composer/qgscomposition.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -411,32 +411,32 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
411411
/** Returns true if the composition will generate corresponding world files when pages
412412
* are exported.
413413
* @see setGenerateWorldFile()
414-
* @see worldFileMap()
414+
* @see referenceMap()
415415
*/
416416
bool generateWorldFile() const { return mGenerateWorldFile; }
417417

418418
/** Sets whether the composition will generate corresponding world files when pages
419419
* are exported.
420420
* @param enabled set to true to generate world files
421421
* @see generateWorldFile()
422-
* @see setWorldFileMap()
422+
* @see setReferenceMap()
423423
*/
424424
void setGenerateWorldFile( bool enabled ) { mGenerateWorldFile = enabled; }
425425

426426
/** Returns the map item which will be used to generate corresponding world files when the
427427
* composition is exported, or nullptr if no corresponding map is set.
428-
* @see setWorldFileMap()
428+
* @see setReferenceMap()
429429
* @see generateWorldFile()
430430
*/
431-
QgsComposerMap* worldFileMap() const;
431+
QgsComposerMap* referenceMap() const;
432432

433433
/** Sets the map item which will be used to generate corresponding world files when the
434434
* composition is exported.
435435
* @param map composer map item
436-
* @see worldFileMap()
436+
* @see referenceMap()
437437
* @see setGenerateWorldFile()
438438
*/
439-
void setWorldFileMap( QgsComposerMap* map );
439+
void setReferenceMap( QgsComposerMap* map );
440440

441441
//! Returns true if a composition should use advanced effects such as blend modes
442442
bool useAdvancedEffects() const {return mUseAdvancedEffects;}
@@ -692,7 +692,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
692692
/** Georeferences a file (image of PDF) exported from the composition.
693693
* @param file filename of exported file
694694
* @param referenceMap map item to use for georeferencing, or leave as nullptr to use the
695-
* currently defined worldFileMap().
695+
* currently defined referenceMap().
696696
* @param exportRegion set to a valid rectangle to indicate that only part of the composition was
697697
* exported
698698
* @param dpi set to DPI of exported file, or leave as -1 to use composition's DPI.
@@ -1027,7 +1027,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
10271027

10281028
/** Computes a GDAL style geotransform for georeferencing a composition.
10291029
* @param referenceMap map item to use for georeferencing, or leave as nullptr to use the
1030-
* currently defined worldFileMap().
1030+
* currently defined referenceMap().
10311031
* @param exportRegion set to a valid rectangle to indicate that only part of the composition is
10321032
* being exported
10331033
* @param dpi allows overriding the default composition DPI, or leave as -1 to use composition's DPI.

0 commit comments

Comments
 (0)