qgseditorwidgetautoconf.cpp

Go to the documentation of this file.

/***************************************************************************
    qgseditorwidgetautoconf.cpp
    ---------------------
    begin                : July 2016
    copyright            : (C) 2016 by Patrick Valsecchi
    email                : patrick.valsecchi at camptocamp.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 "qgseditorwidgetautoconf.h"
 
#include "qgseditorwidgetregistry.h"
#include "qgsgui.h"
#include "qgsvectordataprovider.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class FromFactoriesPlugin : public QgsEditorWidgetAutoConfPlugin
{
  public:
    QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName, int &score ) const override
    {
      int bestScore = 0;
      QString bestType;
      const QMap<QString, QgsEditorWidgetFactory *> factories = QgsGui::editorWidgetRegistry()->factories();
      for ( QMap<QString, QgsEditorWidgetFactory *>::const_iterator i = factories.begin(); i != factories.end(); ++i )
      {
        const int index = vl->fields().lookupField( fieldName );
        if ( index >= 0 )
        {
          const int score = i.value()->fieldScore( vl, index );
          if ( score > bestScore )
          {
            bestType = i.key();
            bestScore = score;
          }
        }
      }
      if ( bestScore > 0 )
      {
        score = 10;
        return QgsEditorWidgetSetup( bestType, QVariantMap() );
      }
      return QgsEditorWidgetSetup();
    }
};
 

class FromDbTablePlugin : public QgsEditorWidgetAutoConfPlugin
{
  public:
    QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName, int &score ) const override
    {
      const QgsField field = vl->fields().field( fieldName );
      if ( !field.editorWidgetSetup().isNull() )
      {
        score = 20;
        return field.editorWidgetSetup();
      }
      else
      {
        return QgsEditorWidgetSetup();
      }
    }
};

QgsEditorWidgetAutoConf::QgsEditorWidgetAutoConf()
{
  registerPlugin( new FromFactoriesPlugin() );
  registerPlugin( new FromDbTablePlugin() );
}
 
QgsEditorWidgetSetup QgsEditorWidgetAutoConf::editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName ) const
{
  QgsEditorWidgetSetup result( u"TextEdit"_s, QVariantMap() );
 
  const int fieldIndex = vl->fields().indexFromName( fieldName );
  if ( fieldIndex >= 0 )
  {
    if ( vl->fields().fieldOrigin( fieldIndex ) == Qgis::FieldOrigin::Provider )
    {
      // important check - for provider fields, we CANNOT use auto configured widgets if the field
      // uses a default value clause - otherwise the widget will obliterate the default value clause
      // (e.g., by trying to convert it to a number/date/etc). Instead we have to use a text edit
      // widget so that the clause remains intact
      const int providerOrigin = vl->fields().fieldOriginIndex( fieldIndex );
      if ( !vl->dataProvider()->defaultValueClause( providerOrigin ).isEmpty() )
        return result;
    }
 
    int bestScore = 0;
    for ( const std::shared_ptr<QgsEditorWidgetAutoConfPlugin> &cur : mPlugins )
    {
      int score = 0;
      const QgsEditorWidgetSetup curResult = cur->editorWidgetSetup( vl, fieldName, score );
      if ( score > bestScore )
      {
        result = curResult;
        bestScore = score;
      }
    }
  }
 
  return result;
}
 
void QgsEditorWidgetAutoConf::registerPlugin( QgsEditorWidgetAutoConfPlugin *plugin )
{
  mPlugins.append( std::shared_ptr<QgsEditorWidgetAutoConfPlugin>( plugin ) );
}