Start porting atlas GUI

src/app/CMakeLists.txt

@@ -180,6 +180,7 @@ SET(QGIS_APP_SRCS
 
   layout/qgslayoutaddpagesdialog.cpp
   layout/qgslayoutapputils.cpp
+  layout/qgslayoutatlaswidget.cpp
   layout/qgslayoutattributeselectiondialog.cpp
   layout/qgslayoutattributetablewidget.cpp
   layout/qgslayoutdesignerdialog.cpp
@@ -399,6 +400,7 @@ SET (QGIS_APP_MOC_HDRS
 
   layout/qgslayoutaddpagesdialog.h
   layout/qgslayoutappmenuprovider.h
+  layout/qgslayoutatlaswidget.h
   layout/qgslayoutattributeselectiondialog.h
   layout/qgslayoutattributetablewidget.h
   layout/qgslayoutdesignerdialog.h

src/app/layout/qgslayoutatlaswidget.cpp

@@ -0,0 +1,343 @@
+/***************************************************************************
+                              qgslayoutatlaswidget.cpp
+                              -----------------------------
+    begin                : October 2012
+    copyright            : (C) 2012 Hugo Mercier
+    email                : hugo dot mercier at oslandia dot com
+ ***************************************************************************/
+/***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#include <QComboBox>
+#include <QImageWriter>
+#include <QMessageBox>
+
+#include "qgslayoutatlaswidget.h"
+#include "qgsprintlayout.h"
+#include "qgslayoutatlas.h"
+#include "qgsexpressionbuilderdialog.h"
+
+QgsLayoutAtlasWidget::QgsLayoutAtlasWidget( QWidget *parent, QgsPrintLayout *layout )
+  : QWidget( parent )
+  , mAtlas( layout->atlas() )
+{
+  setupUi( this );
+  connect( mUseAtlasCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutAtlasWidget::mUseAtlasCheckBox_stateChanged );
+  connect( mAtlasFilenamePatternEdit, &QLineEdit::editingFinished, this, &QgsLayoutAtlasWidget::mAtlasFilenamePatternEdit_editingFinished );
+  connect( mAtlasFilenameExpressionButton, &QToolButton::clicked, this, &QgsLayoutAtlasWidget::mAtlasFilenameExpressionButton_clicked );
+  connect( mAtlasHideCoverageCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutAtlasWidget::mAtlasHideCoverageCheckBox_stateChanged );
+  connect( mAtlasSingleFileCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutAtlasWidget::mAtlasSingleFileCheckBox_stateChanged );
+  connect( mAtlasSortFeatureCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutAtlasWidget::mAtlasSortFeatureCheckBox_stateChanged );
+  connect( mAtlasSortFeatureDirectionButton, &QToolButton::clicked, this, &QgsLayoutAtlasWidget::mAtlasSortFeatureDirectionButton_clicked );
+  connect( mAtlasFeatureFilterEdit, &QLineEdit::editingFinished, this, &QgsLayoutAtlasWidget::mAtlasFeatureFilterEdit_editingFinished );
+  connect( mAtlasFeatureFilterButton, &QToolButton::clicked, this, &QgsLayoutAtlasWidget::mAtlasFeatureFilterButton_clicked );
+  connect( mAtlasFeatureFilterCheckBox, &QCheckBox::stateChanged, this, &QgsLayoutAtlasWidget::mAtlasFeatureFilterCheckBox_stateChanged );
+
+  mAtlasCoverageLayerComboBox->setFilters( QgsMapLayerProxyModel::VectorLayer );
+
+  connect( mAtlasCoverageLayerComboBox, &QgsMapLayerComboBox::layerChanged, mAtlasSortFeatureKeyComboBox, &QgsFieldComboBox::setLayer );
+  connect( mAtlasCoverageLayerComboBox, &QgsMapLayerComboBox::layerChanged, mPageNameWidget, &QgsFieldExpressionWidget::setLayer );
+  connect( mAtlasCoverageLayerComboBox, &QgsMapLayerComboBox::layerChanged, this, &QgsLayoutAtlasWidget::changeCoverageLayer );
+  connect( mAtlasSortFeatureKeyComboBox, &QgsFieldComboBox::fieldChanged, this, &QgsLayoutAtlasWidget::changesSortFeatureField );
+  connect( mPageNameWidget, static_cast < void ( QgsFieldExpressionWidget::* )( const QString &, bool ) > ( &QgsFieldExpressionWidget::fieldChanged ), this, &QgsLayoutAtlasWidget::pageNameExpressionChanged );
+
+  // Sort direction
+  mAtlasSortFeatureDirectionButton->setEnabled( false );
+  mAtlasSortFeatureKeyComboBox->setEnabled( false );
+
+  // connect to updates
+  connect( mAtlas, &QgsLayoutAtlas::changed, this, &QgsLayoutAtlasWidget::updateGuiElements );
+
+  mPageNameWidget->registerExpressionContextGenerator( mLayout );
+
+  QList<QByteArray> formats = QImageWriter::supportedImageFormats();
+  for ( int i = 0; i < formats.size(); ++i )
+  {
+    mAtlasFileFormat->addItem( QString( formats.at( i ) ) );
+  }
+  connect( mAtlasFileFormat, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, [ = ]( int ) { changeFileFormat(); } );
+
+  updateGuiElements();
+}
+
+void QgsLayoutAtlasWidget::mUseAtlasCheckBox_stateChanged( int state )
+{
+  if ( state == Qt::Checked )
+  {
+    mAtlas->setEnabled( true );
+    mConfigurationGroup->setEnabled( true );
+    mOutputGroup->setEnabled( true );
+  }
+  else
+  {
+    mAtlas->setEnabled( false );
+    mConfigurationGroup->setEnabled( false );
+    mOutputGroup->setEnabled( false );
+  }
+}
+
+void QgsLayoutAtlasWidget::changeCoverageLayer( QgsMapLayer *layer )
+{
+  QgsVectorLayer *vl = dynamic_cast<QgsVectorLayer *>( layer );
+
+  if ( !vl )
+  {
+    mAtlas->setCoverageLayer( nullptr );
+  }
+  else
+  {
+    mAtlas->setCoverageLayer( vl );
+    updateAtlasFeatures();
+  }
+}
+
+void QgsLayoutAtlasWidget::mAtlasFilenamePatternEdit_editingFinished()
+{
+  QString error;
+  if ( !mAtlas->setFilenameExpression( mAtlasFilenamePatternEdit->text(), error ) )
+  {
+    //expression could not be set
+    QMessageBox::warning( this
+                          , tr( "Could not evaluate filename pattern" )
+                          , tr( "Could not set filename pattern as '%1'.\nParser error:\n%2" )
+                          .arg( mAtlasFilenamePatternEdit->text(),
+                                error )
+                        );
+  }
+}
+
+void QgsLayoutAtlasWidget::mAtlasFilenameExpressionButton_clicked()
+{
+  if ( !mAtlas || !mAtlas->coverageLayer() )
+  {
+    return;
+  }
+
+  QgsExpressionContext context = mLayout->createExpressionContext();
+  QgsExpressionBuilderDialog exprDlg( mAtlas->coverageLayer(), mAtlasFilenamePatternEdit->text(), this, QStringLiteral( "generic" ), context );
+  exprDlg.setWindowTitle( tr( "Expression Based Filename" ) );
+
+  if ( exprDlg.exec() == QDialog::Accepted )
+  {
+    QString expression = exprDlg.expressionText();
+    if ( !expression.isEmpty() )
+    {
+      //set atlas filename expression
+      mAtlasFilenamePatternEdit->setText( expression );
+      QString error;
+      if ( !mAtlas->setFilenameExpression( expression, error ) )
+      {
+        //expression could not be set
+        QMessageBox::warning( this
+                              , tr( "Could not evaluate filename pattern" )
+                              , tr( "Could not set filename pattern as '%1'.\nParser error:\n%2" )
+                              .arg( expression,
+                                    error )
+                            );
+      }
+    }
+  }
+}
+
+void QgsLayoutAtlasWidget::mAtlasHideCoverageCheckBox_stateChanged( int state )
+{
+  mAtlas->setHideCoverage( state == Qt::Checked );
+}
+
+void QgsLayoutAtlasWidget::mAtlasSingleFileCheckBox_stateChanged( int state )
+{
+  if ( state == Qt::Checked )
+  {
+    mAtlasFilenamePatternEdit->setEnabled( false );
+    mAtlasFilenameExpressionButton->setEnabled( false );
+  }
+  else
+  {
+    mAtlasFilenamePatternEdit->setEnabled( true );
+    mAtlasFilenameExpressionButton->setEnabled( true );
+  }
+#if 0 //TODO
+  mAtlas->setSingleFile( state == Qt::Checked );
+#endif
+}
+
+void QgsLayoutAtlasWidget::mAtlasSortFeatureCheckBox_stateChanged( int state )
+{
+  if ( state == Qt::Checked )
+  {
+    mAtlasSortFeatureDirectionButton->setEnabled( true );
+    mAtlasSortFeatureKeyComboBox->setEnabled( true );
+  }
+  else
+  {
+    mAtlasSortFeatureDirectionButton->setEnabled( false );
+    mAtlasSortFeatureKeyComboBox->setEnabled( false );
+  }
+  mAtlas->setSortFeatures( state == Qt::Checked );
+  updateAtlasFeatures();
+}
+
+void QgsLayoutAtlasWidget::updateAtlasFeatures()
+{
+#if 0 //TODO
+  bool updated = mAtlas->updateFeatures();
+  if ( !updated )
+  {
+    QMessageBox::warning( nullptr, tr( "Atlas preview" ),
+                          tr( "No matching atlas features found!" ),
+                          QMessageBox::Ok,
+                          QMessageBox::Ok );
+
+    //Perhaps atlas preview should be disabled now? If so, it may get annoying if user is editing
+    //the filter expression and it keeps disabling itself.
+    return;
+  }
+#endif
+}
+
+void QgsLayoutAtlasWidget::changesSortFeatureField( const QString &fieldName )
+{
+  mAtlas->setSortExpression( fieldName );
+  updateAtlasFeatures();
+}
+
+void QgsLayoutAtlasWidget::mAtlasFeatureFilterCheckBox_stateChanged( int state )
+{
+  if ( state == Qt::Checked )
+  {
+    mAtlasFeatureFilterEdit->setEnabled( true );
+    mAtlasFeatureFilterButton->setEnabled( true );
+  }
+  else
+  {
+    mAtlasFeatureFilterEdit->setEnabled( false );
+    mAtlasFeatureFilterButton->setEnabled( false );
+  }
+  mAtlas->setFilterFeatures( state == Qt::Checked );
+  updateAtlasFeatures();
+}
+
+void QgsLayoutAtlasWidget::pageNameExpressionChanged( const QString &, bool valid )
+{
+  QString expression = mPageNameWidget->asExpression();
+  if ( !valid && !expression.isEmpty() )
+  {
+    return;
+  }
+
+  mAtlas->setPageNameExpression( expression );
+}
+
+void QgsLayoutAtlasWidget::mAtlasFeatureFilterEdit_editingFinished()
+{
+  QString error;
+  mAtlas->setFilterExpression( mAtlasFeatureFilterEdit->text(), error );
+  updateAtlasFeatures();
+}
+
+void QgsLayoutAtlasWidget::mAtlasFeatureFilterButton_clicked()
+{
+  QgsVectorLayer *vl = dynamic_cast<QgsVectorLayer *>( mAtlasCoverageLayerComboBox->currentLayer() );
+
+  if ( !vl )
+  {
+    return;
+  }
+
+  QgsExpressionContext context = mLayout->createExpressionContext();
+  QgsExpressionBuilderDialog exprDlg( vl, mAtlasFeatureFilterEdit->text(), this, QStringLiteral( "generic" ), context );
+  exprDlg.setWindowTitle( tr( "Expression Based Filter" ) );
+
+  if ( exprDlg.exec() == QDialog::Accepted )
+  {
+    QString expression = exprDlg.expressionText();
+    if ( !expression.isEmpty() )
+    {
+      mAtlasFeatureFilterEdit->setText( expression );
+      QString error;
+      mAtlas->setFilterExpression( mAtlasFeatureFilterEdit->text(), error );
+      updateAtlasFeatures();
+    }
+  }
+}
+
+void QgsLayoutAtlasWidget::mAtlasSortFeatureDirectionButton_clicked()
+{
+  Qt::ArrowType at = mAtlasSortFeatureDirectionButton->arrowType();
+  at = ( at == Qt::UpArrow ) ? Qt::DownArrow : Qt::UpArrow;
+  mAtlasSortFeatureDirectionButton->setArrowType( at );
+
+  mAtlas->setSortAscending( at == Qt::UpArrow );
+  updateAtlasFeatures();
+}
+
+void QgsLayoutAtlasWidget::changeFileFormat()
+{
+#if 0 //TODO
+  QgsAtlasComposition *atlasMap = mAtlas;
+  atlasMap->setFileFormat( mAtlasFileFormat->currentText() );
+#endif
+}
+void QgsLayoutAtlasWidget::updateGuiElements()
+{
+  blockAllSignals( true );
+  mUseAtlasCheckBox->setCheckState( mAtlas->enabled() ? Qt::Checked : Qt::Unchecked );
+  mConfigurationGroup->setEnabled( mAtlas->enabled() );
+  mOutputGroup->setEnabled( mAtlas->enabled() );
+
+  mAtlasCoverageLayerComboBox->setLayer( mAtlas->coverageLayer() );
+  mPageNameWidget->setLayer( mAtlas->coverageLayer() );
+  mPageNameWidget->setField( mAtlas->pageNameExpression() );
+
+  mAtlasSortFeatureKeyComboBox->setLayer( mAtlas->coverageLayer() );
+  mAtlasSortFeatureKeyComboBox->setField( mAtlas->sortExpression() );
+
+  mAtlasFilenamePatternEdit->setText( mAtlas->filenameExpression() );
+  mAtlasHideCoverageCheckBox->setCheckState( mAtlas->hideCoverage() ? Qt::Checked : Qt::Unchecked );
+
+#if 0 //TODO
+  mAtlasSingleFileCheckBox->setCheckState( mAtlas->singleFile() ? Qt::Checked : Qt::Unchecked );
+  mAtlasFilenamePatternEdit->setEnabled( !mAtlas->singleFile() );
+  mAtlasFilenameExpressionButton->setEnabled( !mAtlas->singleFile() );
+#endif
+
+  mAtlasSortFeatureCheckBox->setCheckState( mAtlas->sortFeatures() ? Qt::Checked : Qt::Unchecked );
+  mAtlasSortFeatureDirectionButton->setEnabled( mAtlas->sortFeatures() );
+  mAtlasSortFeatureKeyComboBox->setEnabled( mAtlas->sortFeatures() );
+
+  mAtlasSortFeatureDirectionButton->setArrowType( mAtlas->sortAscending() ? Qt::UpArrow : Qt::DownArrow );
+  mAtlasFeatureFilterEdit->setText( mAtlas->filterExpression() );
+
+  mAtlasFeatureFilterCheckBox->setCheckState( mAtlas->filterFeatures() ? Qt::Checked : Qt::Unchecked );
+  mAtlasFeatureFilterEdit->setEnabled( mAtlas->filterFeatures() );
+  mAtlasFeatureFilterButton->setEnabled( mAtlas->filterFeatures() );
+
+#if 0 //TODO
+  mAtlasFileFormat->setCurrentIndex( mAtlasFileFormat->findText( mAtlas->fileFormat() ) );
+#endif
+
+  blockAllSignals( false );
+}
+
+void QgsLayoutAtlasWidget::blockAllSignals( bool b )
+{
+  mUseAtlasCheckBox->blockSignals( b );
+  mConfigurationGroup->blockSignals( b );
+  mOutputGroup->blockSignals( b );
+  mAtlasCoverageLayerComboBox->blockSignals( b );
+  mPageNameWidget->blockSignals( b );
+  mAtlasSortFeatureKeyComboBox->blockSignals( b );
+  mAtlasFilenamePatternEdit->blockSignals( b );
+  mAtlasHideCoverageCheckBox->blockSignals( b );
+  mAtlasSingleFileCheckBox->blockSignals( b );
+  mAtlasSortFeatureCheckBox->blockSignals( b );
+  mAtlasSortFeatureDirectionButton->blockSignals( b );
+  mAtlasFeatureFilterEdit->blockSignals( b );
+  mAtlasFeatureFilterCheckBox->blockSignals( b );
+}