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 "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QSharedDataPointer>
#include <QString>
#include <QVariant>
#include <QVector>
 
using namespace Qt::StringLiterals;
 
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"
#include "qgis.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( QMetaType::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( Qgis::FieldConfigurationFlags configurationFlags READ configurationFlags WRITE setConfigurationFlags )
    Q_PROPERTY( bool isReadOnly READ isReadOnly WRITE setReadOnly )
    Q_PROPERTY( QString customComment READ customComment WRITE setCustomComment )
 
  public:
    // clang-format off
    QgsField( const QString &name = QString(), QMetaType::Type type = QMetaType::Type::UnknownType, const QString &typeName = QString(), int len = 0, int prec = 0, const QString &comment = QString(), QMetaType::Type subType = QMetaType::Type::UnknownType ) SIP_HOLDGIL;
    // clang-format on
 

    Q_DECL_DEPRECATED QgsField( const QString &name,
                                QVariant::Type type,
                                const QString &typeName = QString(),
                                int len = 0,
                                int prec = 0,
                                const QString &comment = QString(),
                                QVariant::Type subType = QVariant::Invalid ) SIP_HOLDGIL SIP_DEPRECATED;
 
    QgsField( const QgsField &other ) SIP_HOLDGIL;
    QgsField &operator =( const QgsField &other ) SIP_SKIP;
 
    virtual ~QgsField();
 
    bool operator==( const QgsField &other ) const SIP_HOLDGIL;
    bool operator!=( const QgsField &other ) const SIP_HOLDGIL;

    QString name() const SIP_HOLDGIL;

    QString displayName() const SIP_HOLDGIL;

    QString displayNameWithAlias() const SIP_HOLDGIL;

    QString displayType( bool showConstraints = false ) const SIP_HOLDGIL;

    QString friendlyTypeString() const SIP_HOLDGIL;

    QMetaType::Type type() const SIP_HOLDGIL;

    QMetaType::Type subType() const SIP_HOLDGIL;

    QString typeName() const SIP_HOLDGIL;

    int length() const SIP_HOLDGIL;

    int precision() const SIP_HOLDGIL;

    QString comment() const SIP_HOLDGIL;

    QMap< int, QVariant > metadata() const SIP_HOLDGIL;

    QVariant metadata( Qgis::FieldMetadataProperty property ) const SIP_SKIP;

    QVariant metadata( int property ) const SIP_HOLDGIL;

    void setMetadata( const QMap< int, QVariant > metadata ) SIP_HOLDGIL;

    void setMetadata( Qgis::FieldMetadataProperty property, const QVariant &value ) SIP_SKIP;

    void setMetadata( int property, const QVariant &value ) SIP_HOLDGIL;

    bool isNumeric() const SIP_HOLDGIL;

    bool isDateOrTime() const SIP_HOLDGIL;

    void setName( const QString &name ) SIP_HOLDGIL;

    void setType( QMetaType::Type type ) SIP_HOLDGIL;

    Q_DECL_DEPRECATED void setType( QVariant::Type type ) SIP_HOLDGIL SIP_DEPRECATED;

    void setSubType( QMetaType::Type subType ) SIP_HOLDGIL;

    Q_DECL_DEPRECATED void setSubType( QVariant::Type subType ) SIP_HOLDGIL  SIP_DEPRECATED;

    void setTypeName( const QString &typeName ) SIP_HOLDGIL;

    void setLength( int len ) SIP_HOLDGIL;

    void setPrecision( int precision ) SIP_HOLDGIL;

    void setComment( const QString &comment ) SIP_HOLDGIL;

    QgsDefaultValue defaultValueDefinition() const SIP_HOLDGIL;

    void setDefaultValueDefinition( const QgsDefaultValue &defaultValueDefinition ) SIP_HOLDGIL;

    const QgsFieldConstraints &constraints() const SIP_HOLDGIL;

    void setConstraints( const QgsFieldConstraints &constraints ) SIP_HOLDGIL;

    QString alias() const SIP_HOLDGIL;

    void setAlias( const QString &alias ) SIP_HOLDGIL;

    QString customComment() const SIP_HOLDGIL;

    void setCustomComment( const QString &customComment ) SIP_HOLDGIL;

    Qgis::FieldConfigurationFlags configurationFlags() const SIP_HOLDGIL;

    void setConfigurationFlags( Qgis::FieldConfigurationFlags flags ) SIP_HOLDGIL;

    QString displayString( const QVariant &v ) const;

    static QString readableConfigurationFlag( Qgis::FieldConfigurationFlag flag ) SIP_HOLDGIL;
 
#ifndef SIP_RUN

    bool convertCompatible( QVariant &v, QString *errorMessage = nullptr ) const;
#else
// clang-format off

    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
// clang-format on
#endif

    operator QVariant() const;

    void setEditorWidgetSetup( const QgsEditorWidgetSetup &v ) SIP_HOLDGIL;

    QgsEditorWidgetSetup editorWidgetSetup() const SIP_HOLDGIL;

    void setReadOnly( bool readOnly ) SIP_HOLDGIL;

    bool isReadOnly() const SIP_HOLDGIL;

    Qgis::FieldDomainSplitPolicy splitPolicy() const SIP_HOLDGIL;

    void setSplitPolicy( Qgis::FieldDomainSplitPolicy policy ) SIP_HOLDGIL;

    Qgis::FieldDuplicatePolicy duplicatePolicy() const SIP_HOLDGIL;

    void setDuplicatePolicy( Qgis::FieldDuplicatePolicy policy ) SIP_HOLDGIL;

    Qgis::FieldDomainMergePolicy mergePolicy() const SIP_HOLDGIL;

    void setMergePolicy( Qgis::FieldDomainMergePolicy policy ) SIP_HOLDGIL;
 
#ifdef SIP_RUN
// clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsField: %1 (%2)>"_s.arg( sipCpp->name() ).arg( sipCpp->typeName() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN
    static constexpr int MAX_WKT_LENGTH = 999;
#endif
 
  private:
 
    QSharedDataPointer<QgsFieldPrivate> d;
 
 
}; // class QgsField
 
Q_DECLARE_METATYPE( QgsField )
 

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