QGIS API Documentation  3.27.0-Master (11ef3e5184)
Signals | Public Member Functions | List of all members
QgsAbstractFieldDomainWidget Class Referenceabstract

Abstract base class for widgets which configure the extended properties of a QgsFieldDomain subclass. More...

#include <qgsfielddomainwidget.h>

Inheritance diagram for QgsAbstractFieldDomainWidget:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted whenever the field domain configuration in the widget changes. More...
 

Public Member Functions

 QgsAbstractFieldDomainWidget (QWidget *parent=nullptr)
 Constructor for QgsAbstractFieldDomainWidget, with the specified parent widget. More...
 
virtual ~QgsAbstractFieldDomainWidget ()
 
virtual QgsFieldDomaincreateFieldDomain (const QString &name, const QString &description, QVariant::Type fieldType) const =0
 Creates a new field domain using the properties from the widget. More...
 
virtual bool isValid () const =0
 Returns true if the widget currently represents a valid field domain configuration. More...
 
virtual void setFieldDomain (const QgsFieldDomain *domain)=0
 Sets the current field domain to show properties for in the widget. More...
 

Detailed Description

Abstract base class for widgets which configure the extended properties of a QgsFieldDomain subclass.

See also
QgsFieldDomainWidget
Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 42 of file qgsfielddomainwidget.h.

Constructor & Destructor Documentation

◆ QgsAbstractFieldDomainWidget()

QgsAbstractFieldDomainWidget::QgsAbstractFieldDomainWidget ( QWidget *  parent = nullptr)

Constructor for QgsAbstractFieldDomainWidget, with the specified parent widget.

Definition at line 27 of file qgsfielddomainwidget.cpp.

◆ ~QgsAbstractFieldDomainWidget()

QgsAbstractFieldDomainWidget::~QgsAbstractFieldDomainWidget ( )
virtualdefault

Member Function Documentation

◆ changed

void QgsAbstractFieldDomainWidget::changed ( )
signal

Emitted whenever the field domain configuration in the widget changes.

◆ createFieldDomain()

virtual QgsFieldDomain* QgsAbstractFieldDomainWidget::createFieldDomain ( const QString &  name,
const QString &  description,
QVariant::Type  fieldType 
) const
pure virtual

Creates a new field domain using the properties from the widget.

Caller takes ownership of the returned object.

See also
setFieldDomain()

Implemented in QgsCodedFieldDomainWidget, QgsGlobDomainWidget, and QgsRangeDomainWidget.

◆ isValid()

virtual bool QgsAbstractFieldDomainWidget::isValid ( ) const
pure virtual

Returns true if the widget currently represents a valid field domain configuration.

Implemented in QgsCodedFieldDomainWidget, QgsGlobDomainWidget, and QgsRangeDomainWidget.

◆ setFieldDomain()

virtual void QgsAbstractFieldDomainWidget::setFieldDomain ( const QgsFieldDomain domain)
pure virtual

Sets the current field domain to show properties for in the widget.

See also
createFieldDomain()

Implemented in QgsCodedFieldDomainWidget, QgsGlobDomainWidget, and QgsRangeDomainWidget.


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