A widget for configuration of the properties of a QgsFieldDomain. More...

#include <qgsfielddomainwidget.h>

Inheritance diagram for QgsFieldDomainWidget:

[legend]

Signals
void	validityChanged (bool isValid)
	Emitted whenever the validity of the field domain configuration in the widget changes.

Public Member Functions
	QgsFieldDomainWidget (Qgis::FieldDomainType type, QWidget *parent=nullptr)
	Constructor for QgsFieldDomainWidget for the given domain type, with the specified parent widget.
QgsFieldDomain *	createFieldDomain () const
	Creates a new field domain using the properties from the widget.
bool	isValid () const
	Returns `true` if the widget currently represents a valid field domain configuration.
void	setFieldDomain (const QgsFieldDomain *domain)
	Sets the current field domain to show properties for in the widget.
void	setNameEditable (bool editable)
	Sets if name of the field domain is editable.

Detailed Description

A widget for configuration of the properties of a QgsFieldDomain.

Since: QGIS 3.26

Definition at line 212 of file qgsfielddomainwidget.h.

Constructor & Destructor Documentation

◆ QgsFieldDomainWidget()

QgsFieldDomainWidget::QgsFieldDomainWidget	(	Qgis::FieldDomainType	type,
		QWidget *	parent = nullptr )

Constructor for QgsFieldDomainWidget for the given domain type, with the specified parent widget.

Definition at line 354 of file qgsfielddomainwidget.cpp.

Member Function Documentation

◆ createFieldDomain()

QgsFieldDomain * QgsFieldDomainWidget::createFieldDomain ( ) const

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

Caller takes ownership of the returned object.

See also: setFieldDomain()

Definition at line 423 of file qgsfielddomainwidget.cpp.

◆ isValid()

bool QgsFieldDomainWidget::isValid ( ) const

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

See also: validityChanged()

Definition at line 435 of file qgsfielddomainwidget.cpp.

◆ setFieldDomain()

void QgsFieldDomainWidget::setFieldDomain ( const QgsFieldDomain * domain )

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

See also: createFieldDomain()

Definition at line 408 of file qgsfielddomainwidget.cpp.

◆ setNameEditable()

void QgsFieldDomainWidget::setNameEditable ( bool editable )

Sets if name of the field domain is editable.

Since: QGIS 4.0

Definition at line 83 of file qgsfielddomainwidget.cpp.

◆ validityChanged

void QgsFieldDomainWidget::validityChanged ( bool isValid )

signal

Emitted whenever the validity of the field domain configuration in the widget changes.

See also: isValid()

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/qgsfielddomainwidget.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/qgsfielddomainwidget.cpp

Signals

Public Member Functions