QGIS API Documentation 3.27.0-Master (95e00c50d2)
Public Member Functions | List of all members
QgsGlobFieldDomain Class Reference

Definition of a field domain for field content validated by a glob. More...

#include <qgsfielddomain.h>

Inheritance diagram for QgsGlobFieldDomain:
Inheritance graph
[legend]

Public Member Functions

 QgsGlobFieldDomain (const QgsGlobFieldDomain &)=delete
 QgsGlobFieldDomain cannot be copied - use clone() instead. More...
 
 QgsGlobFieldDomain (const QString &name, const QString &description, QVariant::Type fieldType, const QString &glob)
 Constructor for QgsGlobFieldDomain, with the specified name, description and fieldType. More...
 
QgsGlobFieldDomainclone () const override
 Clones the field domain. More...
 
QString glob () const
 Returns the glob expression. More...
 
QgsGlobFieldDomainoperator= (const QgsGlobFieldDomain &)=delete
 QgsGlobFieldDomain cannot be copied - use clone() instead. More...
 
void setGlob (const QString &glob)
 Sets the glob expression. More...
 
Qgis::FieldDomainType type () const override
 Returns the type of field domain. More...
 
QString typeName () const override
 Returns a translated name of the field domain type. More...
 
- Public Member Functions inherited from QgsFieldDomain
 QgsFieldDomain (const QString &name, const QString &description, QVariant::Type fieldType)
 Constructor for QgsFieldDomain, with the specified name, description and fieldType. More...
 
virtual ~QgsFieldDomain ()
 
virtual QgsFieldDomainclone () const =0
 Clones the field domain. More...
 
QString description () const
 Returns the description of the field domain. More...
 
QVariant::Type fieldType () const
 Returns the associated field type. More...
 
Qgis::FieldDomainMergePolicy mergePolicy () const
 Returns the merge policy. More...
 
QString name () const
 Returns the name of the field domain. More...
 
void setDescription (const QString &description)
 Sets the description of the field domain. More...
 
void setFieldType (QVariant::Type type)
 Sets the associated field type. More...
 
void setMergePolicy (Qgis::FieldDomainMergePolicy policy)
 Sets the merge policy. More...
 
void setName (const QString &name)
 Sets the name of the field domain. More...
 
void setSplitPolicy (Qgis::FieldDomainSplitPolicy policy)
 Sets the split policy. More...
 
Qgis::FieldDomainSplitPolicy splitPolicy () const
 Returns the split policy. More...
 
virtual Qgis::FieldDomainType type () const =0
 Returns the type of field domain. More...
 
virtual QString typeName () const =0
 Returns a translated name of the field domain type. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsFieldDomain
QString mDescription
 
QVariant::Type mFieldType = QVariant::Type::String
 
Qgis::FieldDomainMergePolicy mMergePolicy = Qgis::FieldDomainMergePolicy::DefaultValue
 
QString mName
 
Qgis::FieldDomainSplitPolicy mSplitPolicy = Qgis::FieldDomainSplitPolicy::DefaultValue
 

Detailed Description

Definition of a field domain for field content validated by a glob.

Globs are matching expression like "*[a-z][0-1]?"

Since
QGIS 3.26

Definition at line 422 of file qgsfielddomain.h.

Constructor & Destructor Documentation

◆ QgsGlobFieldDomain() [1/2]

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

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

The glob argument specifies the content validation glob, e.g. "*[a-z][0-1]?".

Definition at line 112 of file qgsfielddomain.cpp.

◆ QgsGlobFieldDomain() [2/2]

QgsGlobFieldDomain::QgsGlobFieldDomain ( const QgsGlobFieldDomain )
delete

QgsGlobFieldDomain cannot be copied - use clone() instead.

Member Function Documentation

◆ clone()

QgsGlobFieldDomain * QgsGlobFieldDomain::clone ( ) const
overridevirtual

Clones the field domain.

Implements QgsFieldDomain.

Definition at line 129 of file qgsfielddomain.cpp.

◆ glob()

QString QgsGlobFieldDomain::glob ( ) const
inline

Returns the glob expression.

Globs are matching expression like "*[a-z][0-1]?"

See also
setGlob()

Definition at line 455 of file qgsfielddomain.h.

◆ operator=()

QgsGlobFieldDomain & QgsGlobFieldDomain::operator= ( const QgsGlobFieldDomain )
delete

QgsGlobFieldDomain cannot be copied - use clone() instead.

◆ setGlob()

void QgsGlobFieldDomain::setGlob ( const QString &  glob)
inline

Sets the glob expression.

Globs are matching expression like "*[a-z][0-1]?"

See also
glob()

Definition at line 464 of file qgsfielddomain.h.

◆ type()

Qgis::FieldDomainType QgsGlobFieldDomain::type ( ) const
overridevirtual

Returns the type of field domain.

Implements QgsFieldDomain.

Definition at line 119 of file qgsfielddomain.cpp.

◆ typeName()

QString QgsGlobFieldDomain::typeName ( ) const
overridevirtual

Returns a translated name of the field domain type.

Implements QgsFieldDomain.

Definition at line 124 of file qgsfielddomain.cpp.


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