qgsaddattrdialog.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsaddattrdialog.h  -  description
                             -------------------
    begin                : January 2005
    copyright            : (C) 2005 by Marco Hugentobler
    email                : [email protected]
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 "qgsaddattrdialog.h"
 
#include "qgsfields.h"
#include "qgslogger.h"
#include "qgsvectordataprovider.h"
#include "qgsvectorlayer.h"
 
#include <QMessageBox>
#include <QString>
 
#include "moc_qgsaddattrdialog.cpp"
 
using namespace Qt::StringLiterals;
 
QgsAddAttrDialog::QgsAddAttrDialog( QgsVectorLayer *vlayer, QWidget *parent, Qt::WindowFlags fl )
  : QDialog( parent, fl )
  , mIsShapeFile( vlayer && vlayer->providerType() == "ogr"_L1 && vlayer->storageType() == "ESRI Shapefile"_L1 )
{
  setupUi( this );
  connect( mTypeBox, static_cast<void ( QComboBox::* )( int )>( &QComboBox::currentIndexChanged ), this, &QgsAddAttrDialog::mTypeBox_currentIndexChanged );
  connect( mLength, &QSpinBox::editingFinished, this, &QgsAddAttrDialog::mLength_editingFinished );
 
  if ( !vlayer || !vlayer->dataProvider() )
    return;
 
  const Qgis::VectorDataProviderAttributeEditCapabilities attributeEditCapabilities = vlayer->dataProvider()->attributeEditCapabilities();
 
  //fill data types into the combo box
  const QList<QgsVectorDataProvider::NativeType> &typelist = vlayer->dataProvider()->nativeTypes();
  for ( int i = 0; i < typelist.size(); i++ )
  {
    QgsDebugMsgLevel(
      u"name:%1 type:%2 typeName:%3 length:%4-%5 prec:%6-%7"_s.arg( typelist[i].mTypeDesc )
        .arg( typelist[i].mType )
        .arg( typelist[i].mTypeName )
        .arg( typelist[i].mMinLen )
        .arg( typelist[i].mMaxLen )
        .arg( typelist[i].mMinPrec )
        .arg( typelist[i].mMaxPrec ),
      2
    );
 
    whileBlocking( mTypeBox )->addItem( QgsFields::iconForFieldType( typelist[i].mType, typelist[i].mSubType, typelist[i].mTypeName ), typelist[i].mTypeDesc );
    mTypeBox->setItemData( i, static_cast<int>( typelist[i].mType ), Qt::UserRole );
    mTypeBox->setItemData( i, typelist[i].mTypeName, Qt::UserRole + 1 );
    mTypeBox->setItemData( i, typelist[i].mMinLen, Qt::UserRole + 2 );
    mTypeBox->setItemData( i, typelist[i].mMaxLen, Qt::UserRole + 3 );
    mTypeBox->setItemData( i, typelist[i].mMinPrec, Qt::UserRole + 4 );
    mTypeBox->setItemData( i, typelist[i].mMaxPrec, Qt::UserRole + 5 );
  }
 
  //default values for field width and precision
  mLength->setValue( 10 );
  mLength->setClearValue( 10 );
  mPrec->setValue( 3 );
  mPrec->setClearValue( 3 );
  mTypeBox_currentIndexChanged( 0 );
 
  if ( mIsShapeFile )
    mNameEdit->setMaxLength( 10 );
 
  mNameEdit->setFocus();
 
  if ( !( attributeEditCapabilities & Qgis::VectorDataProviderAttributeEditCapability::EditAlias ) )
  {
    mLabelAlias->hide();
    mAliasEdit->hide();
  }
  if ( !( attributeEditCapabilities & Qgis::VectorDataProviderAttributeEditCapability::EditComment ) )
  {
    mLabelComment->hide();
    mCommentEdit->hide();
  }
}
 
void QgsAddAttrDialog::setIllegalFieldNames( const QSet<QString> &names )
{
  mIllegalFieldNames = names;
}
 
void QgsAddAttrDialog::mTypeBox_currentIndexChanged( int idx )
{
  mTypeName->setText( mTypeBox->itemData( idx, Qt::UserRole + 1 ).toString() );
 
  mLength->setMinimum( mTypeBox->itemData( idx, Qt::UserRole + 2 ).toInt() );
  mLength->setMaximum( mTypeBox->itemData( idx, Qt::UserRole + 3 ).toInt() );
  mLength->setVisible( mLength->minimum() < mLength->maximum() );
  mLengthLabel->setVisible( mLength->minimum() < mLength->maximum() );
  if ( mLength->value() < mLength->minimum() )
    mLength->setValue( mLength->minimum() );
  if ( mLength->value() > mLength->maximum() )
    mLength->setValue( mLength->maximum() );
  setPrecisionMinMax();
}
 
void QgsAddAttrDialog::mLength_editingFinished()
{
  setPrecisionMinMax();
}
 
void QgsAddAttrDialog::setPrecisionMinMax()
{
  const int idx = mTypeBox->currentIndex();
  const int minPrecType = mTypeBox->itemData( idx, Qt::UserRole + 4 ).toInt();
  const int maxPrecType = mTypeBox->itemData( idx, Qt::UserRole + 5 ).toInt();
  const bool precisionIsEnabled = minPrecType < maxPrecType;
  mPrec->setEnabled( precisionIsEnabled );
  mPrec->setVisible( precisionIsEnabled );
  mPrecLabel->setVisible( precisionIsEnabled );
 
  // Do not set min/max if it's disabled or we'll loose the default value,
  // see https://github.com/qgis/QGIS/issues/26880 - QGIS saves integer field when
  // I create a new real field through field calculator (Update field works as intended)
  if ( precisionIsEnabled )
  {
    mPrec->setMinimum( minPrecType );
    mPrec->setMaximum( std::max( minPrecType, std::min( maxPrecType, mLength->value() ) ) );
  }
}
 
void QgsAddAttrDialog::accept()
{
  const QString newName = mNameEdit->text().trimmed();
  if ( mIsShapeFile && newName.compare( "shape"_L1, Qt::CaseInsensitive ) == 0 )
  {
    QMessageBox::warning( this, tr( "Add Field" ), tr( "Invalid field name. This field name is reserved and cannot be used." ) );
    return;
  }
 
 
  for ( const QString &illegalName : std::as_const( mIllegalFieldNames ) )
  {
    if ( newName.compare( illegalName, Qt::CaseInsensitive ) == 0 )
    {
      QMessageBox::warning( this, tr( "Add Field" ), tr( "%1 is an illegal field name for this format and cannot be used." ).arg( newName ) );
      return;
    }
  }
 
  if ( mNameEdit->text().isEmpty() )
  {
    QMessageBox::warning( this, tr( "Add Field" ), tr( "No name specified. Please specify a name to create a new field." ) );
    return;
  }
 
  QDialog::accept();
}
 
QgsField QgsAddAttrDialog::field() const
{
  QgsDebugMsgLevel(
    u"idx:%1 name:%2 type:%3 typeName:%4 length:%5 prec:%6 comment:%7"_s.arg( mTypeBox->currentIndex() )
      .arg( mNameEdit->text() )
      .arg( mTypeBox->currentData( Qt::UserRole ).toInt() )
      .arg( mTypeBox->currentData( Qt::UserRole + 1 ).toString() )
      .arg( mLength->value() )
      .arg( mPrec->value() )
      .arg( mCommentEdit->text() ),
    2
  );
 
  QgsField res = QgsField(
    mNameEdit->text(),
    ( QMetaType::Type ) mTypeBox->currentData( Qt::UserRole ).toInt(),
    mTypeBox->currentData( Qt::UserRole + 1 ).toString(),
    mLength->value(),
    mPrec->isEnabled() ? mPrec->value() : 0,
    mCommentEdit->text(),
    static_cast<QMetaType::Type>( mTypeBox->currentData( Qt::UserRole ).toInt() ) == QMetaType::Type::QVariantMap ? QMetaType::Type::QString : QMetaType::Type::UnknownType
  );
 
  if ( !mAliasEdit->text().isEmpty() )
    res.setAlias( mAliasEdit->text() );
 
  return res;
}