27#include <QContextMenuEvent>
29#include <QInputDialog>
35#include "moc_qgsrasterformatsaveoptionswidget.cpp"
37using namespace Qt::StringLiterals;
39QMap<QString, QStringList> QgsRasterFormatSaveOptionsWidget::sBuiltinProfiles;
41static const QString PYRAMID_JPEG_YCBCR_COMPRESSION( u
"JPEG_QUALITY_OVERVIEW=75 COMPRESS_OVERVIEW=JPEG PHOTOMETRIC_OVERVIEW=YCBCR INTERLEAVE_OVERVIEW=PIXEL"_s );
42static const QString PYRAMID_JPEG_COMPRESSION( u
"JPEG_QUALITY_OVERVIEW=75 COMPRESS_OVERVIEW=JPEG INTERLEAVE_OVERVIEW=PIXEL"_s );
47 , mProvider( provider )
52 mOptionsTable->setMinimumSize( 200, mOptionsTable->verticalHeader()->defaultSectionSize() * 4 + mOptionsTable->horizontalHeader()->height() + 2 );
54 connect( mProfileNewButton, &QPushButton::clicked,
this, &QgsRasterFormatSaveOptionsWidget::mProfileNewButton_clicked );
55 connect( mProfileDeleteButton, &QPushButton::clicked,
this, &QgsRasterFormatSaveOptionsWidget::mProfileDeleteButton_clicked );
56 connect( mProfileResetButton, &QPushButton::clicked,
this, &QgsRasterFormatSaveOptionsWidget::mProfileResetButton_clicked );
57 connect( mOptionsAddButton, &QPushButton::clicked,
this, &QgsRasterFormatSaveOptionsWidget::mOptionsAddButton_clicked );
58 connect( mOptionsDeleteButton, &QPushButton::clicked,
this, &QgsRasterFormatSaveOptionsWidget::mOptionsDeleteButton_clicked );
59 connect( mOptionsLineEdit, &QLineEdit::editingFinished,
this, &QgsRasterFormatSaveOptionsWidget::mOptionsLineEdit_editingFinished );
63 if ( sBuiltinProfiles.isEmpty() )
66 sBuiltinProfiles[u
"z_adefault"_s] = ( QStringList() << QString() << tr(
"Default" ) << QString() );
71 sBuiltinProfiles[u
"z_gtiff_1big"_s] = ( QStringList() << u
"GTiff"_s << tr(
"No Compression" ) << u
"COMPRESS=NONE BIGTIFF=IF_NEEDED"_s );
72 sBuiltinProfiles[u
"z_gtiff_2medium"_s] = ( QStringList() << u
"GTiff"_s << tr(
"Low Compression" ) << u
"COMPRESS=PACKBITS"_s );
73 sBuiltinProfiles[u
"z_gtiff_3small"_s] = ( QStringList() << u
"GTiff"_s << tr(
"High Compression" ) << u
"COMPRESS=DEFLATE PREDICTOR=2 ZLEVEL=9"_s );
74 sBuiltinProfiles[u
"z_gtiff_4jpeg"_s] = ( QStringList() << u
"GTiff"_s << tr(
"JPEG Compression" ) << u
"COMPRESS=JPEG JPEG_QUALITY=75"_s );
79 sBuiltinProfiles[u
"z__pyramids_gtiff_1big"_s] = ( QStringList() << u
"_pyramids"_s << tr(
"No Compression" ) << u
"COMPRESS_OVERVIEW=NONE BIGTIFF_OVERVIEW=IF_NEEDED"_s );
80 sBuiltinProfiles[u
"z__pyramids_gtiff_2medium"_s] = ( QStringList() << u
"_pyramids"_s << tr(
"Low Compression" ) << u
"COMPRESS_OVERVIEW=PACKBITS"_s );
81 sBuiltinProfiles[u
"z__pyramids_gtiff_3small"_s] = ( QStringList() << u
"_pyramids"_s << tr(
"High Compression" ) << u
"COMPRESS_OVERVIEW=DEFLATE PREDICTOR_OVERVIEW=2 ZLEVEL=9"_s );
82 sBuiltinProfiles[u
"z__pyramids_gtiff_4jpeg"_s] = ( QStringList() << u
"_pyramids"_s << tr(
"JPEG Compression" ) << PYRAMID_JPEG_YCBCR_COMPRESSION );
85 connect( mProfileComboBox, &QComboBox::currentTextChanged,
this, &QgsRasterFormatSaveOptionsWidget::updateOptions );
86 connect( mOptionsTable, &QTableWidget::cellChanged,
this, &QgsRasterFormatSaveOptionsWidget::optionsTableChanged );
88 connect( mOptionsValidateButton, &QAbstractButton::clicked,
this, [
this] {
validateOptions(); } );
91 mOptionsLineEdit->installEventFilter(
this );
94 setContextMenuPolicy( Qt::CustomContextMenu );
95 connect(
this, &QWidget::customContextMenuRequested,
this, [
this]( QPoint pos ) {
98 if ( mTableWidget->isVisible() )
99 text = tr(
"Use Simple Interface" );
101 text = tr(
"Use Table Interface" );
102 QAction *swapAction = menu.addAction( text );
103 connect( swapAction, &QAction::triggered,
this, [
this]() { swapOptionsUI( -1 ); } );
104 menu.exec( this->mapToGlobal( pos ) );
123 mProvider = provider;
130 const QList<QWidget *> widgets = this->findChildren<QWidget *>();
134 const auto constWidgets = widgets;
135 for ( QWidget *widget : constWidgets )
136 widget->setVisible(
false );
137 mOptionsWidget->setVisible(
true );
148 const auto constWidgets = widgets;
149 for ( QWidget *widget : constWidgets )
150 widget->setVisible(
true );
152 mProfileButtons->setVisible(
false );
162QString QgsRasterFormatSaveOptionsWidget::pseudoFormat()
const
164 return mPyramids ? u
"_pyramids"_s : mFormat;
170 const QString format = pseudoFormat();
171 QStringList profileKeys = profiles();
172 QMapIterator<QString, QStringList> it( sBuiltinProfiles );
173 while ( it.hasNext() )
176 const QString profileKey = it.key();
177 if ( !profileKeys.contains( profileKey ) && !it.value().isEmpty() )
180 if ( it.value()[0].isEmpty() || it.value()[0] == format )
182 profileKeys.insert( 0, profileKey );
186 std::sort( profileKeys.begin(), profileKeys.end() );
190 mProfileComboBox->blockSignals(
true );
191 mProfileComboBox->clear();
192 const auto constProfileKeys = profileKeys;
193 for (
const QString &profileKey : constProfileKeys )
195 QString profileName, profileOptions;
196 profileOptions = creationOptions( profileKey );
197 if ( sBuiltinProfiles.contains( profileKey ) )
199 profileName = sBuiltinProfiles[profileKey][1];
200 if ( profileOptions.isEmpty() )
201 profileOptions = sBuiltinProfiles[profileKey][2];
205 profileName = profileKey;
207 mOptionsMap[profileKey] = profileOptions;
208 mProfileComboBox->addItem( profileName, profileKey );
212 mProfileComboBox->blockSignals(
false );
215 mProfileComboBox->setCurrentIndex( mProfileComboBox->findData( mySettings.
value( mProvider +
"/driverOptions/" + format.toLower() +
"/defaultProfile",
"z_adefault" ) ) );
219void QgsRasterFormatSaveOptionsWidget::updateOptions()
221 mBlockOptionUpdates++;
222 QString myOptions = mOptionsMap.value( currentProfileKey() );
223 QStringList myOptionsList = myOptions.trimmed().split(
' ', Qt::SkipEmptyParts );
227 if ( mRasterLayer && mRasterLayer->
bandCount() != 3 && myOptions == PYRAMID_JPEG_YCBCR_COMPRESSION )
229 myOptions = PYRAMID_JPEG_COMPRESSION;
232 if ( mTableWidget->isVisible() )
234 mOptionsTable->setRowCount( 0 );
235 for (
int i = 0; i < myOptionsList.count(); i++ )
237 QStringList key_value = myOptionsList[i].split(
'=' );
238 if ( key_value.count() == 2 )
240 mOptionsTable->insertRow( i );
241 mOptionsTable->setItem( i, 0,
new QTableWidgetItem( key_value[0] ) );
242 mOptionsTable->setItem( i, 1,
new QTableWidgetItem( key_value[1] ) );
248 mOptionsLineEdit->setText( myOptions );
249 mOptionsLineEdit->setCursorPosition( 0 );
252 mBlockOptionUpdates--;
258 setCreationOptions();
265 if ( mProvider ==
"gdal"_L1 && !mFormat.isEmpty() && !mPyramids )
268 if ( message.isEmpty() )
269 message = tr(
"Cannot get create options for driver %1" ).arg( mFormat );
271 else if ( mProvider ==
"gdal"_L1 && mPyramids )
273 message = tr(
"For details on pyramids options please see the following pages" );
274 message +=
"\n\nhttps://gdal.org/programs/gdaladdo.html\n\nhttps://gdal.org/drivers/raster/gtiff.html"_L1;
277 message = tr(
"No help available" );
281 dlg->setWindowTitle( tr(
"Create Options for %1" ).arg( mFormat ) );
282 QTextEdit *textEdit =
new QTextEdit( dlg );
283 textEdit->setReadOnly(
true );
285 textEdit->setText( message );
286 dlg->
layout()->addWidget( textEdit );
287 dlg->resize( 600, 400 );
297 const QStringList creationOptions =
options();
300 QgsDebugMsgLevel( u
"layer: [%1] file: [%2] format: [%3]"_s.arg( mRasterLayer ? mRasterLayer->id() :
"none", mRasterFileName, mFormat ), 2 );
304 bool tmpLayer =
false;
305 if ( !( mRasterLayer && rasterLayer->
dataProvider() ) && !mRasterFileName.isNull() )
309 options.skipCrsValidation =
true;
310 rasterLayer =
new QgsRasterLayer( mRasterFileName, QFileInfo( mRasterFileName ).baseName(), u
"gdal"_s,
options );
313 if ( mProvider ==
"gdal"_L1 && mPyramids )
317 QgsDebugMsgLevel( u
"calling validate pyramids on layer's data provider"_s, 2 );
322 message = tr(
"cannot validate pyramid options" );
325 else if ( !creationOptions.isEmpty() && mProvider ==
"gdal"_L1 && !mFormat.isEmpty() )
338 else if ( !creationOptions.isEmpty() )
340 QMessageBox::information(
this, QString(), tr(
"Cannot validate creation options." ), QMessageBox::Close );
348 if ( message.isNull() )
351 QMessageBox::information(
this, QString(), tr(
"Valid" ), QMessageBox::Close );
356 warning(
this, QString(), tr(
"Invalid %1:\n\n%2\n\nClick on help button to get valid creation options for this format." ).arg( mPyramids ? tr(
"pyramid creation option" ) : tr(
"creation option" ), message ), QMessageBox::Close );
366void QgsRasterFormatSaveOptionsWidget::optionsTableChanged()
368 if ( mBlockOptionUpdates )
371 QTableWidgetItem *key, *value;
373 for (
int i = 0; i < mOptionsTable->rowCount(); i++ )
375 key = mOptionsTable->item( i, 0 );
376 if ( !key || key->text().isEmpty() )
378 value = mOptionsTable->item( i, 1 );
379 if ( !value || value->text().isEmpty() )
381 options += key->text() +
'=' + value->text() +
' ';
384 mOptionsMap[currentProfileKey()] =
options;
385 mOptionsLineEdit->setText(
options );
386 mOptionsLineEdit->setCursorPosition( 0 );
389void QgsRasterFormatSaveOptionsWidget::mOptionsLineEdit_editingFinished()
391 mOptionsMap[currentProfileKey()] = mOptionsLineEdit->text().trimmed();
394void QgsRasterFormatSaveOptionsWidget::mProfileNewButton_clicked()
396 QString profileName = QInputDialog::getText(
this, QString(), tr(
"Profile name:" ) );
397 if ( !profileName.isEmpty() )
399 profileName = profileName.trimmed();
400 mOptionsMap[profileName] = QString();
401 mProfileComboBox->addItem( profileName, profileName );
402 mProfileComboBox->setCurrentIndex( mProfileComboBox->count() - 1 );
406void QgsRasterFormatSaveOptionsWidget::mProfileDeleteButton_clicked()
408 const int index = mProfileComboBox->currentIndex();
409 const QString profileKey = currentProfileKey();
410 if ( index != -1 && !sBuiltinProfiles.contains( profileKey ) )
412 mOptionsMap.remove( profileKey );
413 mProfileComboBox->removeItem( index );
417void QgsRasterFormatSaveOptionsWidget::mProfileResetButton_clicked()
419 const QString profileKey = currentProfileKey();
420 if ( sBuiltinProfiles.contains( profileKey ) )
422 mOptionsMap[profileKey] = sBuiltinProfiles[profileKey][2];
426 mOptionsMap[profileKey] = QString();
428 mOptionsLineEdit->setText( mOptionsMap.value( currentProfileKey() ) );
429 mOptionsLineEdit->setCursorPosition( 0 );
433void QgsRasterFormatSaveOptionsWidget::optionsTableEnableDeleteButton()
435 mOptionsDeleteButton->setEnabled( mOptionsTable->currentRow() >= 0 );
438void QgsRasterFormatSaveOptionsWidget::mOptionsAddButton_clicked()
440 mOptionsTable->insertRow( mOptionsTable->rowCount() );
442 const int newRow = mOptionsTable->rowCount() - 1;
443 QTableWidgetItem *item =
new QTableWidgetItem();
444 mOptionsTable->setItem( newRow, 0, item );
445 mOptionsTable->setCurrentItem( item );
448void QgsRasterFormatSaveOptionsWidget::mOptionsDeleteButton_clicked()
450 if ( mOptionsTable->currentRow() >= 0 )
452 mOptionsTable->removeRow( mOptionsTable->currentRow() );
454 QTableWidgetItem *item = mOptionsTable->item( mOptionsTable->currentRow(), 0 );
455 mOptionsTable->setCurrentItem( item );
456 optionsTableChanged();
460QString QgsRasterFormatSaveOptionsWidget::settingsKey( QString profileName )
const
462 if ( !profileName.isEmpty() )
463 profileName =
"/profile_" + profileName;
465 profileName =
"/profile_default" + profileName;
466 return mProvider +
"/driverOptions/" + pseudoFormat().toLower() + profileName +
"/create";
469QString QgsRasterFormatSaveOptionsWidget::currentProfileKey()
const
471 return mProfileComboBox->currentData().toString();
476 return mOptionsMap.value( currentProfileKey() ).trimmed().split(
' ', Qt::SkipEmptyParts );
479QString QgsRasterFormatSaveOptionsWidget::creationOptions(
const QString &profileName )
const
482 return mySettings.
value( settingsKey( profileName ),
"" ).toString();
485void QgsRasterFormatSaveOptionsWidget::deleteCreationOptions(
const QString &profileName )
487 QgsSettings mySettings;
488 mySettings.
remove( settingsKey( profileName ) );
491void QgsRasterFormatSaveOptionsWidget::setCreationOptions()
493 QgsSettings mySettings;
494 QStringList myProfiles;
495 QMap<QString, QString>::const_iterator i = mOptionsMap.constBegin();
496 while ( i != mOptionsMap.constEnd() )
498 setCreationOptions( i.key(), i.value() );
499 myProfiles << i.key();
502 mySettings.
setValue( mProvider +
"/driverOptions/" + pseudoFormat().toLower() +
"/profiles", myProfiles );
503 mySettings.
setValue( mProvider +
"/driverOptions/" + pseudoFormat().toLower() +
"/defaultProfile", currentProfileKey().trimmed() );
506void QgsRasterFormatSaveOptionsWidget::setCreationOptions(
const QString &profileName,
const QString &options )
508 QgsSettings mySettings;
512void QgsRasterFormatSaveOptionsWidget::setCreationOptions(
const QString &profileName,
const QStringList &options )
514 setCreationOptions( profileName,
options.join(
' '_L1 ) );
517QStringList QgsRasterFormatSaveOptionsWidget::profiles()
const
519 const QgsSettings mySettings;
520 return mySettings.
value( mProvider +
"/driverOptions/" + pseudoFormat().toLower() +
"/profiles",
"" ).toStringList();
523void QgsRasterFormatSaveOptionsWidget::swapOptionsUI(
int newIndex )
528 bool lineEditMode = mOptionsLineEdit->isVisible();
529 mOptionsLineEdit->setVisible( ( newIndex == -1 && !lineEditMode ) || newIndex == 1 );
530 mTableWidget->setVisible( ( newIndex == -1 && lineEditMode ) || newIndex == 0 );
534void QgsRasterFormatSaveOptionsWidget::updateControls()
536 const bool valid = mProvider ==
"gdal"_L1 && !mFormat.isEmpty();
537 mOptionsValidateButton->setEnabled( valid );
538 mOptionsHelpButton->setEnabled( valid );
542bool QgsRasterFormatSaveOptionsWidget::eventFilter( QObject *obj, QEvent *event )
544 if ( event->type() == QEvent::ContextMenu )
546 QContextMenuEvent *contextEvent =
static_cast<QContextMenuEvent *
>( event );
547 QMenu *menu =
nullptr;
548 menu = mOptionsLineEdit->createStandardContextMenu();
549 menu->addSeparator();
550 QAction *action =
new QAction( tr(
"Use Table Interface" ), menu );
551 menu->addAction( action );
552 connect( action, &QAction::triggered,
this, [
this] { swapOptionsUI( 0 ); } );
553 menu->exec( contextEvent->globalPos() );
558 return QObject::eventFilter( obj, event );
565 mOptionsTable->horizontalHeader()->resizeSection( 0, mOptionsTable->width() - 115 );
571 mBlockOptionUpdates++;
572 mOptionsTable->clearContents();
574 const QStringList optionsList =
options.trimmed().split(
' ', Qt::SkipEmptyParts );
575 for (
const QString &opt : optionsList )
577 const int rowCount = mOptionsTable->rowCount();
578 mOptionsTable->insertRow( rowCount );
580 const QStringList values = opt.split(
'=' );
581 if ( values.count() == 2 )
583 QTableWidgetItem *nameItem =
new QTableWidgetItem( values.at( 0 ) );
584 mOptionsTable->setItem( rowCount, 0, nameItem );
585 QTableWidgetItem *valueItem =
new QTableWidgetItem( values.at( 1 ) );
586 mOptionsTable->setItem( rowCount, 1, valueItem );
592 mProfileComboBox->setCurrentIndex( 0 );
594 mOptionsMap[currentProfileKey()] =
options.trimmed();
595 mOptionsLineEdit->setText(
options.trimmed() );
596 mOptionsLineEdit->setCursorPosition( 0 );
598 mBlockOptionUpdates--;
A generic dialog with layout and button box.
QVBoxLayout * layout()
Returns the central layout. Widgets added to it must have this dialog as parent.
static QString helpCreationOptionsFormat(const QString &format)
Gets creation options metadata for a given format.
static QString validateCreationOptionsFormat(const QStringList &creationOptions, const QString &format)
Validates creation options for a given format, regardless of layer.
virtual QString validateCreationOptions(const QStringList &createOptions, const QString &format)
Validates creation options for a specific dataset and destination format.
virtual QString validatePyramidsConfigOptions(Qgis::RasterPyramidFormat pyramidsFormat, const QStringList &configOptions, const QString &fileFormat)
Validates pyramid creation options for a specific dataset and destination format.
Represents a raster layer.
int bandCount() const
Returns the number of bands in this layer.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
Stores settings for use within QGIS.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
void remove(const QString &key, QgsSettings::Section section=QgsSettings::NoSection)
Removes the setting key and any sub-settings of key in a section.
void setValue(const QString &key, const QVariant &value, QgsSettings::Section section=QgsSettings::NoSection)
Sets the value of setting key to value.
#define QgsDebugMsgLevel(str, level)
Setting options for loading raster layers.