22 #include <QSharedDataPointer> 23 #include "qgis_core.h" 38 class QgsFieldPrivate;
53 Q_PROPERTY(
bool isNumeric READ isNumeric )
54 Q_PROPERTY(
bool isDateOrTime READ isDateOrTime )
55 Q_PROPERTY(
int length READ length WRITE setLength )
57 Q_PROPERTY( QVariant::Type type READ type WRITE setType )
58 Q_PROPERTY( QString comment READ comment WRITE setComment )
59 Q_PROPERTY( QString name READ name WRITE setName )
60 Q_PROPERTY( QString alias READ alias WRITE setAlias )
61 Q_PROPERTY(
QgsDefaultValue defaultValueDefinition READ defaultValueDefinition WRITE setDefaultValueDefinition )
81 QgsField( const QString &name = QString(),
82 QVariant::Type type = QVariant::Invalid,
86 const QString &comment = QString(),
87 QVariant::Type subType = QVariant::Invalid );
101 bool operator==( const QgsField &other ) const;
102 bool operator!=( const QgsField &other ) const;
109 QString name() const;
118 QString displayName() const;
131 QString displayNameWithAlias() const;
134 QVariant::Type type() const;
142 QVariant::Type subType() const;
167 QString comment() const;
175 bool isNumeric() const;
182 bool isDateOrTime() const;
188 void setName( const QString &name );
193 void setType( QVariant::Type type );
201 void setSubType( QVariant::Type subType );
207 void setTypeName( const QString &
typeName );
213 void setLength(
int len );
224 void setComment( const QString &comment );
242 void setDefaultValueDefinition( const
QgsDefaultValue &defaultValueDefinition );
264 QString alias() const;
272 void setAlias( const QString &alias );
275 QString displayString( const QVariant &v ) const;
284 bool convertCompatible( QVariant &v ) const;
287 PyObject *sipParseErr = NULL;
292 const QgsField *sipCpp;
294 if ( sipParseArgs( &sipParseErr, sipArgs,
"BJ1", &sipSelf, sipType_QgsField, &sipCpp, sipType_QVariant, &a0, &a0State ) )
298 Py_BEGIN_ALLOW_THREADS
307 sipReleaseType( a0, sipType_QVariant, a0State );
308 sipRaiseUnknownException();
314 PyObject *res = sipConvertFromType( a0, sipType_QVariant, NULL );
315 sipReleaseType( a0, sipType_QVariant, a0State );
319 PyErr_SetString( PyExc_ValueError,
320 QString(
"Value %1 (%2) could not be converted to field type %3." ).arg( a0->toString(), a0->typeName() ).arg( sipCpp->
type() ).toUtf8().constData() );
321 sipError = sipErrorFail;
329 sipNoMethod( sipParseErr, sipName_QgsField, sipName_convertCompatible, doc_QgsField_convertCompatible );
336 operator QVariant()
const 338 return QVariant::fromValue( *
this );
359 SIP_PYOBJECT __repr__();
361 QString str = QStringLiteral(
"<QgsField: %1 (%2)>" ).arg( sipCpp->name() ).arg( sipCpp->typeName() );
362 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
368 QSharedDataPointer<QgsFieldPrivate> d;
The QgsDefaultValue class provides a container for managing client side default values for fields...
bool convertCompatible(QVariant &v) const
Converts the provided variant to a compatible format.
Stores information about constraints which may be present on a field.
CORE_EXPORT QDataStream & operator<<(QDataStream &out, const QgsField &field)
Writes the field to stream out. QGIS version compatibility is not guaranteed.
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
Encapsulate a field in an attribute table or data source.
QList< int > QgsAttributeList
CORE_EXPORT QDataStream & operator>>(QDataStream &in, QgsField &field)
Reads a field from stream in into field. QGIS version compatibility is not guaranteed.