QGIS API Documentation  2.0.1-Dufour
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
QgsField Class Reference

Encapsulate a field in an attribute table or data source. More...

#include <qgsfield.h>

Public Member Functions

 QgsField (QString name=QString(), QVariant::Type type=QVariant::Invalid, QString typeName=QString(), int len=0, int prec=0, QString comment=QString())
 ~QgsField ()
bool operator== (const QgsField &other) const
bool operator!= (const QgsField &other) const
const QString & name () const
 Gets the name of the field.
QVariant::Type type () const
 Gets variant type of the field as it will be retrieved from data source.
const QString & typeName () const
 Gets the field type.
int length () const
 Gets the length of the field.
int precision () const
 Gets the precision of the field.
const QString & comment () const
 Returns the field comment.
void setName (const QString &nam)
 Set the field name.
void setType (QVariant::Type type)
 Set variant type.
void setTypeName (const QString &typ)
 Set the field type.
void setLength (int len)
 Set the field length.
void setPrecision (int prec)
 Set the field precision.
void setComment (const QString &comment)
 Set the field comment.
QString displayString (const QVariant &v) const
 Formats string for display.

Private Attributes

QString mName
QVariant::Type mType
 Variant type.
QString mTypeName
 Type name from provider.
int mLength
int mPrecision
QString mComment

Detailed Description

Encapsulate a field in an attribute table or data source.

QgsField stores metadata about an attribute field, including name, type length, and if applicable, precision.

Definition at line 29 of file qgsfield.h.

Constructor & Destructor Documentation

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


Constructs a new QgsField object.

nameField name
typeField variant type, currently supported: String / Int / Double
typeNameField type (eg. char, varchar, text, int, serial, double). Field types are usually unique to the source and are stored exactly as returned from the data store.
lenField length
precField precision. Usually decimal places but may also be used in conjunction with other fields types (eg. variable character fields)
commentComment for the field

Definition at line 32 of file qgsfield.cpp.

QgsField::~QgsField ( )


Definition at line 39 of file qgsfield.cpp.

Member Function Documentation

const QString & QgsField::comment ( ) const

Returns the field comment.

Definition at line 80 of file qgsfield.cpp.

References mComment.

Referenced by QgsOfflineEditing::committedAttributesAdded(), QgsVectorLayer::metadata(), and setComment().

QString QgsField::displayString ( const QVariant &  v) const

Formats string for display.

Definition at line 114 of file qgsfield.cpp.

References mPrecision, and mType.

Referenced by QgsAttributeTableModel::data(), and QgsAttributeEditor::setValue().

int QgsField::length ( ) const
const QString & QgsField::name ( ) const
bool QgsField::operator!= ( const QgsField other) const

Definition at line 49 of file qgsfield.cpp.

bool QgsField::operator== ( const QgsField other) const

Definition at line 43 of file qgsfield.cpp.

References mLength, mName, mPrecision, and mType.

int QgsField::precision ( ) const

Gets the precision of the field.

Not all field types have a related precision.

int containing the precision or zero if not applicable to the field type.

Definition at line 75 of file qgsfield.cpp.

References mPrecision.

Referenced by QgsOfflineEditing::committedAttributesAdded(), QgsVectorLayer::metadata(), QgsFieldValidator::QgsFieldValidator(), QgsVectorFileWriter::QgsVectorFileWriter(), and QgsVectorDataProvider::supportedType().

void QgsField::setComment ( const QString &  comment)

Set the field comment.

Definition at line 109 of file qgsfield.cpp.

References comment(), and mComment.

void QgsField::setLength ( int  len)

Set the field length.

lenLength of the field

Definition at line 100 of file qgsfield.cpp.

References mLength.

void QgsField::setName ( const QString &  nam)

Set the field name.

namName of the field

Definition at line 85 of file qgsfield.cpp.

References mName.

Referenced by QgsVectorLayerJoinBuffer::updateFields().

void QgsField::setPrecision ( int  prec)

Set the field precision.

precPrecision of the field

Definition at line 104 of file qgsfield.cpp.

References mPrecision.

void QgsField::setType ( QVariant::Type  type)

Set variant type.

Definition at line 90 of file qgsfield.cpp.

References mType, and type().

Referenced by QgsGmlSchema::endElement().

void QgsField::setTypeName ( const QString &  typ)

Set the field type.

typField type

Definition at line 95 of file qgsfield.cpp.

References mTypeName, and typeName().

Referenced by QgsOfflineEditing::applyAttributesAdded().

QVariant::Type QgsField::type ( ) const
const QString & QgsField::typeName ( ) const

Gets the field type.

Field types vary depending on the data source. Examples are char, int, double, blob, geometry, etc. The type is stored exactly as the data store reports it, with no attenpt to standardize the value.

QString containing the field type

Definition at line 65 of file qgsfield.cpp.

References mTypeName.

Referenced by QgsVectorLayer::metadata(), and setTypeName().

Member Data Documentation

QString QgsField::mComment


Definition at line 146 of file qgsfield.h.

Referenced by comment(), and setComment().

int QgsField::mLength


Definition at line 140 of file qgsfield.h.

Referenced by length(), operator==(), and setLength().

QString QgsField::mName


Definition at line 131 of file qgsfield.h.

Referenced by name(), operator==(), and setName().

int QgsField::mPrecision


Definition at line 143 of file qgsfield.h.

Referenced by displayString(), operator==(), precision(), and setPrecision().

QVariant::Type QgsField::mType

Variant type.

Definition at line 134 of file qgsfield.h.

Referenced by displayString(), operator==(), setType(), and type().

QString QgsField::mTypeName

Type name from provider.

Definition at line 137 of file qgsfield.h.

Referenced by setTypeName(), and typeName().

The documentation for this class was generated from the following files: