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())
	Constructor.
	~QgsField ()
	Destructor.
const QString &	comment () const
	Returns the field comment.
bool	convertCompatible (QVariant &v) const
	Converts the provided variant to a compatible format.
QString	displayString (const QVariant &v) const
	Formats string for display.
int	length () const
	Gets the length of the field.
const QString &	name () const
	Gets the name of the field.
bool	operator!= (const QgsField &other) const
bool	operator== (const QgsField &other) const
int	precision () const
	Gets the precision of the field.
void	setComment (const QString &comment)
	Set the field comment.
void	setLength (int len)
	Set the field length.
void	setName (const QString &nam)
	Set the field name.
void	setPrecision (int prec)
	Set the field precision.
void	setType (QVariant::Type type)
	Set variant type.
void	setTypeName (const QString &typ)
	Set the field type.
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.

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 33 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()
	)

Constructor.

Constructs a new QgsField object.

Parameters

name	Field name
type	Field variant type, currently supported: String / Int / Double
typeName	Field 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.
len	Field length
prec	Field precision. Usually decimal places but may also be used in conjunction with other fields types (eg. variable character fields)
comment	Comment for the field

Definition at line 36 of file qgsfield.cpp.

QgsField::~QgsField

(

)

Destructor.

Definition at line 43 of file qgsfield.cpp.

Member Function Documentation

const QString & QgsField::comment

(

)

const

Returns the field comment.

Definition at line 84 of file qgsfield.cpp.

bool QgsField::convertCompatible

(

QVariant &

v

)

const

Converts the provided variant to a compatible format.

Parameters

v	The value to convert

Returns

True if the conversion was successful

Definition at line 132 of file qgsfield.cpp.

QString QgsField::displayString

(

const QVariant &

v

)

const

Formats string for display.

Definition at line 118 of file qgsfield.cpp.

int QgsField::length

(

)

const

Gets the length of the field.

Returns

int containing the length of the field

Definition at line 74 of file qgsfield.cpp.

const QString & QgsField::name

(

)

const

Gets the name of the field.

Definition at line 59 of file qgsfield.cpp.

bool QgsField::operator!=

(

const QgsField &

other

)

const

Definition at line 53 of file qgsfield.cpp.

bool QgsField::operator==

(

const QgsField &

other

)

const

Definition at line 47 of file qgsfield.cpp.

int QgsField::precision

(

)

const

Gets the precision of the field.

Not all field types have a related precision.

Returns

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

Definition at line 79 of file qgsfield.cpp.

void QgsField::setComment

(

const QString &

comment

)

Set the field comment.

Definition at line 113 of file qgsfield.cpp.

void QgsField::setLength

(

int

len

)

Set the field length.

Parameters

len	Length of the field

Definition at line 104 of file qgsfield.cpp.

void QgsField::setName

(

const QString &

nam

)

Set the field name.

Parameters

nam	Name of the field

Definition at line 89 of file qgsfield.cpp.

void QgsField::setPrecision

(

int

prec

)

Set the field precision.

Parameters

prec	Precision of the field

Definition at line 108 of file qgsfield.cpp.

void QgsField::setType

(

QVariant::Type

type

)

Set variant type.

Definition at line 94 of file qgsfield.cpp.

void QgsField::setTypeName

(

const QString &

typ

)

Set the field type.

Parameters

typ	Field type

Definition at line 99 of file qgsfield.cpp.

QVariant::Type QgsField::type

(

)

const

Gets variant type of the field as it will be retrieved from data source.

Definition at line 64 of file qgsfield.cpp.

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 attempt to standardize the value.

Returns

QString containing the field type

Definition at line 69 of file qgsfield.cpp.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsfield.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsfield.cpp