qgsfield_p.h

Go to the documentation of this file.

/***************************************************************************
               qgsfield_p.h
               ------------
               Date                 : May 2015
               Copyright            : (C) 2015 by Nyall Dawson
               email                : nyall dot dawson at gmail 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSFIELD_PRIVATE_H
#define QGSFIELD_PRIVATE_H

 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
 
 
#include "qgis.h"
#include "qgsdefaultvalue.h"
#include "qgseditorwidgetsetup.h"
#include "qgsfield.h"
#include "qgsfieldconstraints.h"
 
#include <QSharedData>
#include <QString>
#include <QVariant>
 
#define SIP_NO_FILE
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in testqgsfield.cpp.
 * See details in QEP #17
 ****************************************************************************/
 
class QgsFieldPrivate : public QSharedData
{
  public:
    QgsFieldPrivate(
      const QString &name = QString(),
      QMetaType::Type type = QMetaType::Type::UnknownType,
      QMetaType::Type subType = QMetaType::Type::UnknownType,
      const QString &typeName = QString(),
      int len = 0,
      int prec = 0,
      const QString &comment = QString(),
      const QMap< int, QVariant > &metadata = QMap< int, QVariant >()
    )
      : name( name )
      , type( type )
      , subType( subType )
      , typeName( typeName )
      , length( len )
      , precision( prec )
      , comment( comment )
      , metadata( metadata )
    {}
 
    QgsFieldPrivate( const QgsFieldPrivate &other )
      : QSharedData( other )
      , name( other.name )
      , type( other.type )
      , subType( other.subType )
      , typeName( other.typeName )
      , length( other.length )
      , precision( other.precision )
      , comment( other.comment )
      , metadata( other.metadata )
      , alias( other.alias )
      , flags( other.flags )
      , defaultValueDefinition( other.defaultValueDefinition )
      , constraints( other.constraints )
      , editorWidgetSetup( other.editorWidgetSetup )
      , splitPolicy( other.splitPolicy )
      , duplicatePolicy( other.duplicatePolicy )
      , mergePolicy( other.mergePolicy )
      , isReadOnly( other.isReadOnly )
    {}
 
    ~QgsFieldPrivate() = default;
 
    // TODO c++20 - replace with = default
    bool operator==( const QgsFieldPrivate &other ) const
    {
      return (
        ( name == other.name )
        && ( type == other.type )
        && ( subType == other.subType )
        && ( length == other.length )
        && ( precision == other.precision )
        && ( metadata == other.metadata )
        && ( alias == other.alias )
        && ( defaultValueDefinition == other.defaultValueDefinition )
        && ( constraints == other.constraints )
        && ( flags == other.flags )
        && ( splitPolicy == other.splitPolicy )
        && ( duplicatePolicy == other.duplicatePolicy )
        && ( mergePolicy == other.mergePolicy )
        && ( isReadOnly == other.isReadOnly )
        && ( editorWidgetSetup == other.editorWidgetSetup )
      );
    }

    QString name;

    QMetaType::Type type;

    QMetaType::Type subType;

    QString typeName;

    int length;

    int precision;

    QString comment;

    QMap< int, QVariant > metadata;

    QString alias;

    Qgis::FieldConfigurationFlags flags = Qgis::FieldConfigurationFlag::NoFlag;

    QgsDefaultValue defaultValueDefinition;

    QgsFieldConstraints constraints;
 
    QgsEditorWidgetSetup editorWidgetSetup;

    Qgis::FieldDomainSplitPolicy splitPolicy = Qgis::FieldDomainSplitPolicy::Duplicate;

    Qgis::FieldDuplicatePolicy duplicatePolicy = Qgis::FieldDuplicatePolicy::Duplicate;

    Qgis::FieldDomainMergePolicy mergePolicy = Qgis::FieldDomainMergePolicy::UnsetField;

    bool isReadOnly = false;
 
  private:
    QgsFieldPrivate &operator=( const QgsFieldPrivate & ) = delete;
};

 
#endif