mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
82971f40a1
(identifing copied code...) git-svn-id: http://svn.osgeo.org/qgis/trunk@8791 c8812cc2-4d05-0410-92ff-de0c093fc19c
112 lines
2.7 KiB
Plaintext
112 lines
2.7 KiB
Plaintext
|
|
/**
|
|
\class QgsField
|
|
\brief Class to 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.
|
|
*/
|
|
|
|
class QgsField
|
|
{
|
|
|
|
%TypeHeaderCode
|
|
#include <qgsfield.h>
|
|
%End
|
|
|
|
public:
|
|
/** Constructor. Constructs a new QgsField object.
|
|
* @param nam Field name
|
|
* @param type Field variant type, currently supported: String / Int / Double
|
|
* @param 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.
|
|
* @param len Field length
|
|
* @param prec Field precision. Usually decimal places but may also be
|
|
* used in conjunction with other fields types (eg. variable character fields)
|
|
* @param comment Comment for the field
|
|
*/
|
|
|
|
QgsField(QString name = QString(),
|
|
QVariant::Type type = QVariant::Invalid,
|
|
QString typeName = QString(),
|
|
int len = 0,
|
|
int prec = 0,
|
|
QString comment = QString());
|
|
|
|
//! Destructor
|
|
~QgsField();
|
|
|
|
bool operator==(const QgsField& other) const;
|
|
|
|
//! Gets the name of the field
|
|
const QString & name() const;
|
|
|
|
//! Gets variant type of the field as it will be retrieved from data source
|
|
QVariant::Type type() 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.
|
|
@return QString containing the field type
|
|
*/
|
|
const QString & typeName() const;
|
|
|
|
|
|
/**
|
|
Gets the length of the field.
|
|
@return int containing the length of the field
|
|
*/
|
|
int length() const;
|
|
|
|
|
|
/**
|
|
Gets the precision of the field. Not all field types have a related precision.
|
|
@return int containing the precision or zero if not applicable to the field type.
|
|
*/
|
|
int precision() const;
|
|
|
|
/**
|
|
Returns the field comment
|
|
*/
|
|
const QString & comment() const;
|
|
|
|
/**
|
|
Set the field name.
|
|
@param nam Name of the field
|
|
*/
|
|
void setName(const QString & nam);
|
|
|
|
/**
|
|
Set variant type.
|
|
*/
|
|
void setType(QVariant::Type type);
|
|
|
|
/**
|
|
Set the field type.
|
|
@param typ Field type
|
|
*/
|
|
void setTypeName(const QString & typ);
|
|
|
|
/**
|
|
Set the field length.
|
|
@param len Length of the field
|
|
*/
|
|
void setLength(int len);
|
|
|
|
/**
|
|
Set the field precision.
|
|
@param prec Precision of the field
|
|
*/
|
|
void setPrecision(int prec);
|
|
|
|
|
|
/**
|
|
Set the field comment
|
|
*/
|
|
void setComment(const QString & comment);
|
|
|
|
}; // class QgsField
|
|
|