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>

typedef QList<int> QgsAttributeList;

class QgsExpression;
class QgsFieldPrivate;
class QgsFieldsPrivate;

class CORE_EXPORT QgsField
{
  public:
    QgsField( QString name = QString(),
              QVariant::Type type = QVariant::Invalid,
              QString typeName = QString(),
              int len = 0,
              int prec = 0,
              QString comment = QString() );

    QgsField( const QgsField& other );

    QgsField& operator =( const QgsField &other );

    virtual ~QgsField();

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

    const QString& name() const;

    QVariant::Type type() const;

    const QString& typeName() const;

    int length() const;

    int precision() const;

    const QString& comment() const;

    void setName( const QString& name );

    void setType( QVariant::Type type );

    void setTypeName( const QString& typeName );

    void setLength( int len );

    void setPrecision( int precision );

    void setComment( const QString& comment );

    QString displayString( const QVariant& v ) const;

    bool convertCompatible( QVariant& v ) const;

  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 );

class CORE_EXPORT QgsFields
{
  public:

    enum FieldOrigin
    {
      OriginUnknown,   
      OriginProvider,  
      OriginJoin,      
      OriginEdit,      
      OriginExpression 
    };

    typedef struct Field
    {
      Field(): origin( OriginUnknown ), originIndex( -1 ) {}
      Field( const QgsField& f, FieldOrigin o, int oi ): field( f ), origin( o ), originIndex( oi ) {}

      bool operator==( const Field& other ) const { return field == other.field && origin == other.origin && originIndex == other.originIndex; }
      bool operator!=( const Field& other ) const { return !( *this == other ); }

      QgsField field;      
      FieldOrigin origin;  
      int originIndex;     
    } Field;

    QgsFields();

    QgsFields( const QgsFields& other );

    QgsFields& operator =( const QgsFields &other );

    virtual ~QgsFields();

    void clear();
    bool append( const QgsField& field, FieldOrigin origin = OriginProvider, int originIndex = -1 );
    bool appendExpressionField( const QgsField& field, int originIndex );
    void remove( int fieldIdx );
    void extend( const QgsFields& other );

    bool isEmpty() const;
    int count() const;
    int size() const;
    bool exists( int i ) const;

    const QgsField& operator[]( int i ) const;
    QgsField& operator[]( int i );
    const QgsField& at( int i ) const;
    const QgsField& field( int fieldIdx ) const;
    const QgsField& field( const QString& name ) const;

    FieldOrigin fieldOrigin( int fieldIdx ) const;
    int fieldOriginIndex( int fieldIdx ) const;

    int indexFromName( const QString& name ) const;

    int fieldNameIndex( const QString& fieldName ) const;

    QgsAttributeList allAttributesList() const;

    QList<QgsField> toList() const;

    bool operator==( const QgsFields& other ) const;
    bool operator!=( const QgsFields& other ) const { return !( *this == other ); }

  private:

    QSharedDataPointer<QgsFieldsPrivate> d;

};

Q_DECLARE_METATYPE( QgsFields );

CORE_EXPORT QDataStream& operator<<( QDataStream& out, const QgsFields& fields );
CORE_EXPORT QDataStream& operator>>( QDataStream& in, QgsFields& fields );

#endif