qgsfield.h

Go to the documentation of this file.

/***************************************************************************
               qgsfield.h - Describes a field in a layer or table
                     --------------------------------------
               Date                 : 01-Jan-2004
               Copyright            : (C) 2004 by Gary E.Sherman
               email                : sherman at mrcc.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_H
#define QGSFIELD_H

#include <QString>
#include <QVariant>
#include <QVector>
#include <QSharedDataPointer>
#include "qgis_core.h"
#include "qgis_sip.h"

typedef QList<int> QgsAttributeList SIP_SKIP;

/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in testqgsfield.cpp.
 * See details in QEP #17
 ****************************************************************************/

#include "qgseditorwidgetsetup.h"
#include "qgsfieldconstraints.h"
#include "qgsdefaultvalue.h"

class QgsFieldPrivate;

class CORE_EXPORT QgsField
{
    Q_GADGET

    Q_PROPERTY( bool isNumeric READ isNumeric )
    Q_PROPERTY( bool isDateOrTime READ isDateOrTime )
    Q_PROPERTY( int length READ length WRITE setLength )
    Q_PROPERTY( int precision READ precision WRITE setPrecision )
    Q_PROPERTY( QVariant::Type type READ type WRITE setType )
    Q_PROPERTY( QString comment READ comment WRITE setComment )
    Q_PROPERTY( QString name READ name WRITE setName )
    Q_PROPERTY( QString alias READ alias WRITE setAlias )
    Q_PROPERTY( QgsDefaultValue defaultValueDefinition READ defaultValueDefinition WRITE setDefaultValueDefinition )
    Q_PROPERTY( QgsFieldConstraints constraints READ constraints WRITE setConstraints )
    Q_PROPERTY( ConfigurationFlags configurationFlags READ configurationFlags WRITE setConfigurationFlags )
    Q_PROPERTY( bool isReadOnly READ isReadOnly WRITE setReadOnly )


  public:

#ifndef SIP_RUN

#if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
    enum ConfigurationFlag
#else
    enum class ConfigurationFlag : int
#endif
    {
      None = 0, 
      NotSearchable = 1 << 1, 
      HideFromWms = 1 << 2, 
      HideFromWfs = 1 << 3, 
    };
    Q_ENUM( ConfigurationFlag )
    Q_DECLARE_FLAGS( ConfigurationFlags, ConfigurationFlag )
#if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
    // https://bugreports.qt.io/browse/QTBUG-47652
    Q_ENUM( ConfigurationFlags )
#else
    Q_FLAG( ConfigurationFlags )
#endif
#endif

    QgsField( const QString &name = QString(),
              QVariant::Type type = QVariant::Invalid,
              const QString &typeName = QString(),
              int len = 0,
              int prec = 0,
              const QString &comment = QString(),
              QVariant::Type subType = QVariant::Invalid );

    QgsField( const QgsField &other );

    QgsField &operator =( const QgsField &other ) SIP_SKIP;

    virtual ~QgsField();

    bool operator==( const QgsField &other ) const;
    bool operator!=( const QgsField &other ) const;

    QString name() const;

    QString displayName() const;

    QString displayNameWithAlias() const;


    QString displayType( bool showConstraints = false ) const;

    QVariant::Type type() const;

    QVariant::Type subType() const;

    QString typeName() const;

    int length() const;

    int precision() const;

    QString comment() const;

    bool isNumeric() const;

    bool isDateOrTime() const;

    void setName( const QString &name );

    void setType( QVariant::Type type );

    void setSubType( QVariant::Type subType );

    void setTypeName( const QString &typeName );

    void setLength( int len );

    void setPrecision( int precision );

    void setComment( const QString &comment );

    QgsDefaultValue defaultValueDefinition() const;

    void setDefaultValueDefinition( const QgsDefaultValue &defaultValueDefinition );

    const QgsFieldConstraints &constraints() const;

    void setConstraints( const QgsFieldConstraints &constraints );

    QString alias() const;

    void setAlias( const QString &alias );

    QgsField::ConfigurationFlags configurationFlags() const SIP_SKIP;

    void setConfigurationFlags( QgsField::ConfigurationFlags configurationFlags ) SIP_SKIP;

    QString displayString( const QVariant &v ) const;

    static QString readableConfigurationFlag( QgsField::ConfigurationFlag flag ) SIP_SKIP;

#ifndef SIP_RUN

    bool convertCompatible( QVariant &v, QString *errorMessage = nullptr ) const;
#else

    bool convertCompatible( QVariant &v ) const;
    % MethodCode
    PyObject *sipParseErr = NULL;

    {
      QVariant *a0;
      int a0State = 0;
      const QgsField *sipCpp;

      if ( sipParseArgs( &sipParseErr, sipArgs, "BJ1", &sipSelf, sipType_QgsField, &sipCpp, sipType_QVariant, &a0, &a0State ) )
      {
        bool sipRes;
        QString errorMessage;

        Py_BEGIN_ALLOW_THREADS
        try
        {
          sipRes = sipCpp->convertCompatible( *a0, &errorMessage );
        }
        catch ( ... )
        {
          Py_BLOCK_THREADS

          sipReleaseType( a0, sipType_QVariant, a0State );
          sipRaiseUnknownException();
          return NULL;
        }

        Py_END_ALLOW_THREADS

        if ( !sipRes )
        {
          PyErr_SetString( PyExc_ValueError,
                           QString( "Value could not be converted to field type %1: %2" ).arg( QMetaType::typeName( sipCpp->type() ), errorMessage ).toUtf8().constData() );
          sipIsErr = 1;
        }
        else
        {
          PyObject *res = sipConvertFromType( a0, sipType_QVariant, NULL );
          sipReleaseType( a0, sipType_QVariant, a0State );
          return res;
        }
      }
      else
      {
        // Raise an exception if the arguments couldn't be parsed.
        sipNoMethod( sipParseErr, sipName_QgsField, sipName_convertCompatible, doc_QgsField_convertCompatible );

        return nullptr;
      }
    }

    % End
#endif

    operator QVariant() const
    {
      return QVariant::fromValue( *this );
    }

    void setEditorWidgetSetup( const QgsEditorWidgetSetup &v );

    QgsEditorWidgetSetup editorWidgetSetup() const;

    void setReadOnly( bool readOnly );

    bool isReadOnly() const;

#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = QStringLiteral( "<QgsField: %1 (%2)>" ).arg( sipCpp->name() ).arg( sipCpp->typeName() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif

  private:

    QSharedDataPointer<QgsFieldPrivate> d;


}; // class QgsField

Q_DECLARE_METATYPE( QgsField )

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsField::ConfigurationFlags ) SIP_SKIP

CORE_EXPORT QDataStream &operator<<( QDataStream &out, const QgsField &field );
CORE_EXPORT QDataStream &operator>>( QDataStream &in, QgsField &field );


#endif