QGIS API Documentation 3.37.0-Master (49cede7946b)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QgsFieldDomain Class Referenceabstract

Base class for field domains. More...

#include <qgsfielddomain.h>

Inheritance diagram for QgsFieldDomain:
Inheritance graph
[legend]

Public Member Functions

 QgsFieldDomain (const QString &name, const QString &description, QMetaType::Type fieldType)
 Constructor for QgsFieldDomain, with the specified name, description and fieldType.
 
Q_DECL_DEPRECATED QgsFieldDomain (const QString &name, const QString &description, QVariant::Type fieldType)
 Constructor for QgsFieldDomain, with the specified name, description and fieldType.
 
virtual ~QgsFieldDomain ()
 
virtual QgsFieldDomainclone () const =0
 Clones the field domain.
 
QString description () const
 Returns the description of the field domain.
 
QMetaType::Type fieldType () const
 Returns the associated field type.
 
Qgis::FieldDomainMergePolicy mergePolicy () const
 Returns the merge policy.
 
QString name () const
 Returns the name of the field domain.
 
void setDescription (const QString &description)
 Sets the description of the field domain.
 
void setFieldType (QMetaType::Type type)
 Sets the associated field type.
 
Q_DECL_DEPRECATED void setFieldType (QVariant::Type type)
 Sets the associated field type.
 
void setMergePolicy (Qgis::FieldDomainMergePolicy policy)
 Sets the merge policy.
 
void setName (const QString &name)
 Sets the name of the field domain.
 
void setSplitPolicy (Qgis::FieldDomainSplitPolicy policy)
 Sets the split policy.
 
Qgis::FieldDomainSplitPolicy splitPolicy () const
 Returns the split policy.
 
virtual Qgis::FieldDomainType type () const =0
 Returns the type of field domain.
 
virtual QString typeName () const =0
 Returns a translated name of the field domain type.
 

Protected Attributes

QString mDescription
 
QMetaType::Type mFieldType = QMetaType::Type::QString
 
Qgis::FieldDomainMergePolicy mMergePolicy = Qgis::FieldDomainMergePolicy::DefaultValue
 
QString mName
 
Qgis::FieldDomainSplitPolicy mSplitPolicy = Qgis::FieldDomainSplitPolicy::DefaultValue
 

Detailed Description

Base class for field domains.

A field domain is a set of constraints that apply to one or several fields.

Since
QGIS 3.26

Definition at line 33 of file qgsfielddomain.h.

Constructor & Destructor Documentation

◆ QgsFieldDomain() [1/2]

QgsFieldDomain::QgsFieldDomain ( const QString &  name,
const QString &  description,
QMetaType::Type  fieldType 
)

Constructor for QgsFieldDomain, with the specified name, description and fieldType.

Definition at line 24 of file qgsfielddomain.cpp.

◆ QgsFieldDomain() [2/2]

QgsFieldDomain::QgsFieldDomain ( const QString &  name,
const QString &  description,
QVariant::Type  fieldType 
)

Constructor for QgsFieldDomain, with the specified name, description and fieldType.

Deprecated:
since QGIS 3.38, use the method with a QMetaType::Type argument instead

Definition at line 32 of file qgsfielddomain.cpp.

◆ ~QgsFieldDomain()

QgsFieldDomain::~QgsFieldDomain ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsFieldDomain * QgsFieldDomain::clone ( ) const
pure virtual

Clones the field domain.

Implemented in QgsCodedFieldDomain, QgsRangeFieldDomain, and QgsGlobFieldDomain.

◆ description()

QString QgsFieldDomain::description ( ) const
inline

Returns the description of the field domain.

See also
setDescription()

Definition at line 110 of file qgsfielddomain.h.

◆ fieldType()

QMetaType::Type QgsFieldDomain::fieldType ( ) const
inline

Returns the associated field type.

See also
setFieldType()

Definition at line 124 of file qgsfielddomain.h.

◆ mergePolicy()

Qgis::FieldDomainMergePolicy QgsFieldDomain::mergePolicy ( ) const
inline

Returns the merge policy.

See also
setMergePolicy()

Definition at line 160 of file qgsfielddomain.h.

◆ name()

QString QgsFieldDomain::name ( ) const
inline

Returns the name of the field domain.

See also
setName()

Definition at line 96 of file qgsfielddomain.h.

◆ setDescription()

void QgsFieldDomain::setDescription ( const QString &  description)
inline

Sets the description of the field domain.

See also
description()

Definition at line 117 of file qgsfielddomain.h.

◆ setFieldType() [1/2]

void QgsFieldDomain::setFieldType ( QMetaType::Type  type)
inline

Sets the associated field type.

See also
fieldType()

Definition at line 131 of file qgsfielddomain.h.

◆ setFieldType() [2/2]

void QgsFieldDomain::setFieldType ( QVariant::Type  type)

Sets the associated field type.

See also
fieldType()
Deprecated:
since QGIS 3.38, use the method with a QMetaType::Type argument instead

Definition at line 41 of file qgsfielddomain.cpp.

◆ setMergePolicy()

void QgsFieldDomain::setMergePolicy ( Qgis::FieldDomainMergePolicy  policy)
inline

Sets the merge policy.

See also
mergePolicy()

Definition at line 167 of file qgsfielddomain.h.

◆ setName()

void QgsFieldDomain::setName ( const QString &  name)
inline

Sets the name of the field domain.

See also
name()

Definition at line 103 of file qgsfielddomain.h.

◆ setSplitPolicy()

void QgsFieldDomain::setSplitPolicy ( Qgis::FieldDomainSplitPolicy  policy)
inline

Sets the split policy.

See also
splitPolicy()

Definition at line 153 of file qgsfielddomain.h.

◆ splitPolicy()

Qgis::FieldDomainSplitPolicy QgsFieldDomain::splitPolicy ( ) const
inline

Returns the split policy.

See also
setSplitPolicy()

Definition at line 146 of file qgsfielddomain.h.

◆ type()

virtual Qgis::FieldDomainType QgsFieldDomain::type ( ) const
pure virtual

Returns the type of field domain.

Implemented in QgsCodedFieldDomain, QgsRangeFieldDomain, and QgsGlobFieldDomain.

◆ typeName()

virtual QString QgsFieldDomain::typeName ( ) const
pure virtual

Returns a translated name of the field domain type.

Implemented in QgsCodedFieldDomain, QgsRangeFieldDomain, and QgsGlobFieldDomain.

Member Data Documentation

◆ mDescription

QString QgsFieldDomain::mDescription
protected

Definition at line 172 of file qgsfielddomain.h.

◆ mFieldType

QMetaType::Type QgsFieldDomain::mFieldType = QMetaType::Type::QString
protected

Definition at line 174 of file qgsfielddomain.h.

◆ mMergePolicy

Definition at line 176 of file qgsfielddomain.h.

◆ mName

QString QgsFieldDomain::mName
protected

Definition at line 171 of file qgsfielddomain.h.

◆ mSplitPolicy

Definition at line 175 of file qgsfielddomain.h.


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