56 Q_PROPERTY(
bool isNumeric READ isNumeric )
57 Q_PROPERTY(
bool isDateOrTime READ isDateOrTime )
58 Q_PROPERTY(
int length READ length WRITE setLength )
60 Q_PROPERTY( QVariant::Type type READ type WRITE setType )
61 Q_PROPERTY( QString comment READ comment WRITE setComment )
62 Q_PROPERTY( QString name READ name WRITE setName )
63 Q_PROPERTY( QString alias READ alias WRITE setAlias )
64 Q_PROPERTY(
QgsDefaultValue defaultValueDefinition READ defaultValueDefinition WRITE setDefaultValueDefinition )
66 Q_PROPERTY( ConfigurationFlags configurationFlags READ configurationFlags WRITE setConfigurationFlags )
67 Q_PROPERTY(
bool isReadOnly READ isReadOnly WRITE setReadOnly )
82 NotSearchable = 1 << 1,
86 Q_ENUM( ConfigurationFlag )
87 Q_DECLARE_FLAGS( ConfigurationFlags, ConfigurationFlag )
88 Q_FLAG( ConfigurationFlags )
105 QgsField(
const QString &name = QString(),
106 QVariant::Type type = QVariant::Invalid,
107 const QString &
typeName = QString(),
110 const QString &comment = QString(),
111 QVariant::Type subType = QVariant::Invalid );
133 QString name()
const;
142 QString displayName()
const;
155 QString displayNameWithAlias()
const;
167 QString displayType(
bool showConstraints =
false )
const;
179 QString friendlyTypeString()
const;
182 QVariant::Type type()
const;
190 QVariant::Type subType()
const;
215 QString comment()
const;
225 QMap< int, QVariant > metadata()
const;
241 QVariant metadata(
int property )
const;
251 void setMetadata(
const QMap< int, QVariant > metadata );
267 void setMetadata(
int property,
const QVariant &value );
275 bool isNumeric()
const;
282 bool isDateOrTime()
const;
288 void setName(
const QString &name );
293 void setType( QVariant::Type type );
301 void setSubType( QVariant::Type subType );
307 void setTypeName(
const QString &
typeName );
313 void setLength(
int len );
324 void setComment(
const QString &comment );
342 void setDefaultValueDefinition(
const QgsDefaultValue &defaultValueDefinition );
364 QString alias()
const;
372 void setAlias(
const QString &alias );
378 QgsField::ConfigurationFlags configurationFlags()
const;
384 void setConfigurationFlags( QgsField::ConfigurationFlags configurationFlags );
387 QString displayString(
const QVariant &v )
const;
405 bool convertCompatible( QVariant &v, QString *errorMessage =
nullptr )
const;
415 bool convertCompatible( QVariant &v )
const;
417 PyObject *sipParseErr = NULL;
424 if ( sipParseArgs( &sipParseErr, sipArgs,
"BJ1", &sipSelf, sipType_QgsField, &sipCpp, sipType_QVariant, &a0, &a0State ) )
427 QString errorMessage;
429 Py_BEGIN_ALLOW_THREADS
438 sipReleaseType( a0, sipType_QVariant, a0State );
439 sipRaiseUnknownException();
447 PyErr_SetString( PyExc_ValueError,
448 QString(
"Value could not be converted to field type %1: %2" ).arg( QMetaType::typeName( sipCpp->
type() ), errorMessage ).toUtf8().constData() );
453 PyObject *res = sipConvertFromType( a0, sipType_QVariant, NULL );
454 sipReleaseType( a0, sipType_QVariant, a0State );
461 sipNoMethod( sipParseErr, sipName_QgsField, sipName_convertCompatible, doc_QgsField_convertCompatible );
471 operator QVariant()
const
473 return QVariant::fromValue( *
this );
498 void setReadOnly(
bool readOnly );
505 bool isReadOnly()
const;
528 SIP_PYOBJECT __repr__();
530 QString
str = QStringLiteral(
"<QgsField: %1 (%2)>" ).arg( sipCpp->
name() ).arg( sipCpp->
typeName() );
531 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
536 static constexpr int MAX_WKT_LENGTH = 999;
541 QSharedDataPointer<QgsFieldPrivate> d;
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)