Manages an editor widget Widget and wrapper share the same parent. More...

#include <qgseditorwidgetwrapper.h>

Inheritance diagram for QgsEditorWidgetWrapper:

[legend]

Public Types
enum	ConstraintResult { ConstraintResultPass = 0 , ConstraintResultFailHard , ConstraintResultFailSoft }
	Result of constraint checks. More...

Public Types inherited from QgsWidgetWrapper
enum class	Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl }
	Data defined properties for different editor widgets. More...

Public Slots
void	emitValueChanged ()
	Will call the value() method to determine the emitted value.

virtual void	parentFormValueChanged (const QString &attribute, const QVariant &value)
	Is called in embedded form widgets when an attribute value in the parent form has changed.

void	setFeature (const QgsFeature &feature) override
	Will be called when the feature changes.

virtual void	setValue (const QVariant &value)
	Is called when the value of the widget needs to be changed.

void	setValues (const QVariant &value, const QVariantList &additionalValues)
	Is called when the value of the widget or additional field values needs to be changed.

Public Slots inherited from QgsWidgetWrapper
virtual void	setFeature (const QgsFeature &feature)=0
	Is called when the value of the widget needs to be changed.

Signals
void	constraintResultVisibleChanged (bool visible)
	Emit this signal when the constraint result visibility changed.

void	constraintStatusChanged (const QString &constraint, const QString &desc, const QString &err, QgsEditorWidgetWrapper::ConstraintResult status)
	Emit this signal when the constraint status changed.

Q_DECL_DEPRECATED void	valueChanged (const QVariant &value)
	Emit this signal, whenever the value changed.

void	valuesChanged (const QVariant &value, const QVariantList &additionalFieldValues=QVariantList())
	Emit this signal, whenever the value changed.

Signals inherited from QgsWidgetWrapper
void	contextChanged ()
	Signal when QgsAttributeEditorContext mContext changed.

Public Member Functions
	QgsEditorWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor=nullptr, QWidget *parent=nullptr)
	Create a new widget wrapper.

virtual QStringList	additionalFields () const
	Returns the list of additional fields which the editor handles.

virtual QVariantList	additionalFieldValues () const
	Will be used to access the widget's values for potential additional fields handled by the widget.

QString	constraintFailureReason () const
	Returns the reason why a constraint check has failed (or an empty string if constraint check was successful).

ConstraintResult	constraintResult () const
	Returns the constraint result, which is the current result of the constraint on the widget influencing its visualization.

bool	constraintResultVisible () const
	Returns whether the constraint result is visible.

QVariant	defaultValue () const
	Access the default value of the field.

QgsField	field () const
	Access the field.

int	fieldIdx () const
	Access the field index.

bool	isBlockingCommit () const
	Returns `true` if the widget is preventing the feature from being committed.

bool	isValidConstraint () const
	Gets the current constraint status.

void	setConstraintResultVisible (bool constraintResultVisible)
	Sets whether the constraint result is visible.

void	setEnabled (bool enabled) override
	Is used to enable or disable the edit functionality of the managed widget.

virtual void	setHint (const QString &hintText)
	Add a hint text on the widget.

virtual void	showIndeterminateState ()
	Sets the widget to display in an indeterminate "mixed value" state.

void	updateConstraint (const QgsFeature &featureContext, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet)
	Update constraint.

void	updateConstraint (const QgsVectorLayer *layer, int index, const QgsFeature &feature, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet)
	Update constraint on a feature coming from a specific layer.

void	updateConstraint (QgsEditorWidgetWrapper::ConstraintResult constraintResult, const QString &constraintFailureReason)
	Update constraint manually by providing the constraint result value and failure reason(s).

virtual QVariant	value () const =0
	Will be used to access the widget's value.

Public Member Functions inherited from QgsWidgetWrapper
	QgsWidgetWrapper (QgsVectorLayer vl, QWidget editor=nullptr, QWidget *parent=nullptr)
	Create a new widget wrapper.

QVariantMap	config () const
	Returns the whole config.

QVariant	config (const QString &key, const QVariant &defaultVal=QVariant()) const
	Use this inside your overridden classes to access the configuration.

const QgsAttributeEditorContext &	context () const
	Returns information about the context in which this widget is shown.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the editor widget's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the editor widget's property collection, used for data defined overrides.

QgsVectorLayer *	layer () const
	Returns the vector layer associated with the widget.

void	notifyAboutToSave ()
	Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost.

void	setConfig (const QVariantMap &config)
	Will set the config of this wrapper to the specified config.

void	setContext (const QgsAttributeEditorContext &context)
	Set the context in which this widget is shown.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the editor widget's property collection, used for data defined overrides.

virtual bool	valid () const =0
	Returns `true` if the widget has been properly initialized.

QWidget *	widget ()
	Access the widget managed by this wrapper.

template<class T >
T *	widget ()
	Access the widget managed by this wrapper and cast it to a given type.

Static Public Member Functions
static QgsEditorWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.

static bool	isInTable (const QWidget *parent)
	Check if the given widget or one of its parent is a QTableView.

Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.

static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the editor widget property definitions.

Protected Member Functions
QgsFeature	formFeature () const
	The feature currently being edited, in its current state.

void	setFormFeature (const QgsFeature &feature)
	Set the feature currently being edited to feature.

bool	setFormFeatureAttribute (const QString &attributeName, const QVariant &attributeValue)
	Update the feature currently being edited by changing its attribute attributeName to attributeValue.

virtual void	updateConstraintWidgetStatus ()
	This should update the widget with a visual cue if a constraint status changed.

Protected Member Functions inherited from QgsWidgetWrapper
virtual QWidget *	createWidget (QWidget *parent)=0
	This method should create a new widget with the provided parent.

virtual void	initWidget (QWidget *editor)
	This method should initialize the editor widget with runtime data.

Properties
ConstraintResult	constraintResult

bool	constraintResultVisible

Additional Inherited Members
Protected Attributes inherited from QgsWidgetWrapper
QgsPropertyCollection	mPropertyCollection
	Data defined property collection.

Detailed Description

Manages an editor widget Widget and wrapper share the same parent.

A wrapper controls one attribute editor widget and is able to create a default widget or use a pre-existent widget. It is able to set the widget to the value implied by a field of a vector layer, or return the value it currently holds. Every time it is changed it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the changed status of the widget will be saved.

It can also handle additional fields of a vector layer and would set the widget for their corresponding values and emit valuesChanged signal.

Definition at line 47 of file qgseditorwidgetwrapper.h.

Member Enumeration Documentation

◆ ConstraintResult

enum QgsEditorWidgetWrapper::ConstraintResult

Result of constraint checks.

Enumerator
ConstraintResultPass	Widget passed constraints successfully.
ConstraintResultFailHard	Widget failed at least one hard (enforced) constraint.
ConstraintResultFailSoft	Widget failed at least one soft (non-enforced) constraint.

Definition at line 59 of file qgseditorwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsEditorWidgetWrapper()

QgsEditorWidgetWrapper::QgsEditorWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	editor = `nullptr`,
		QWidget *	parent = `nullptr`
	)

explicit

Create a new widget wrapper.

Parameters

vl	The layer on which the field is
fieldIdx	The field which will be controlled
editor	An editor widget. Can be `nullptr` if one should be autogenerated.
parent	A parent widget for this widget wrapper and the created widget.

Definition at line 27 of file qgseditorwidgetwrapper.cpp.

Member Function Documentation

◆ additionalFields()

virtual QStringList QgsEditorWidgetWrapper::additionalFields ( ) const

inlinevirtual

Returns the list of additional fields which the editor handles.

Since: QGIS 3.10

Reimplemented in QgsRelationReferenceWidgetWrapper.

Definition at line 91 of file qgseditorwidgetwrapper.h.

◆ additionalFieldValues()

virtual QVariantList QgsEditorWidgetWrapper::additionalFieldValues ( ) const

inlinevirtual

Will be used to access the widget's values for potential additional fields handled by the widget.

Returns: A map of additional field names with their corresponding values

See also: additionalFields

Since: QGIS 3.10

Reimplemented in QgsRelationReferenceWidgetWrapper.

Definition at line 99 of file qgseditorwidgetwrapper.h.

◆ constraintFailureReason()

QString QgsEditorWidgetWrapper::constraintFailureReason ( ) const

Returns the reason why a constraint check has failed (or an empty string if constraint check was successful).

See also: isValidConstraint()

Definition at line 290 of file qgseditorwidgetwrapper.cpp.

◆ constraintResult()

QgsEditorWidgetWrapper::ConstraintResult QgsEditorWidgetWrapper::constraintResult ( ) const

Returns the constraint result, which is the current result of the constraint on the widget influencing its visualization.

Definition at line 150 of file qgseditorwidgetwrapper.cpp.

◆ constraintResultVisible()

bool QgsEditorWidgetWrapper::constraintResultVisible ( ) const

Returns whether the constraint result is visible.

Returns true if the constraint result will be visualized on the widget (with color). This will be disabled when the form is not editable.

Definition at line 155 of file qgseditorwidgetwrapper.cpp.

◆ constraintResultVisibleChanged

void QgsEditorWidgetWrapper::constraintResultVisibleChanged ( bool visible )

signal

Emit this signal when the constraint result visibility changed.

◆ constraintStatusChanged

void QgsEditorWidgetWrapper::constraintStatusChanged	(	const QString &	constraint,
		const QString &	desc,
		const QString &	err,
		QgsEditorWidgetWrapper::ConstraintResult	status
	)

signal

Emit this signal when the constraint status changed.

constraintStatusChanged

Parameters

constraint	represented as a string
desc	is the constraint description
err	the error represented as a string. Empty if none.
status

◆ defaultValue()

QVariant QgsEditorWidgetWrapper::defaultValue ( ) const

Access the default value of the field.

Returns: the default value of the field

See also: layer()

Definition at line 49 of file qgseditorwidgetwrapper.cpp.

◆ emitValueChanged

void QgsEditorWidgetWrapper::emitValueChanged ( )

slot

Will call the value() method to determine the emitted value.

Definition at line 95 of file qgseditorwidgetwrapper.cpp.

◆ field()

QgsField QgsEditorWidgetWrapper::field ( ) const

Access the field.

Returns: The field you are working on

See also: layer()

Definition at line 40 of file qgseditorwidgetwrapper.cpp.

◆ fieldIdx()

int QgsEditorWidgetWrapper::fieldIdx ( ) const

Access the field index.

Returns: The index of the field you are working on

See also: layer()

Definition at line 35 of file qgseditorwidgetwrapper.cpp.

◆ formFeature()

QgsFeature QgsEditorWidgetWrapper::formFeature ( ) const

inlineprotected

The feature currently being edited, in its current state.

Returns: the feature currently being edited, in its current state

Since: QGIS 3.2

Definition at line 342 of file qgseditorwidgetwrapper.h.

◆ fromWidget()

QgsEditorWidgetWrapper * QgsEditorWidgetWrapper::fromWidget ( QWidget * widget )

static

Will return a wrapper for a given widget.

Parameters

widget The widget which was created by a wrapper

Returns: The wrapper for the widget or nullptr

Definition at line 56 of file qgseditorwidgetwrapper.cpp.

◆ isBlockingCommit()

bool QgsEditorWidgetWrapper::isBlockingCommit ( ) const

Returns true if the widget is preventing the feature from being committed.

This may be TRUE as a result of attribute values failing enforced field constraints.

See also: isValidConstraint()

Definition at line 284 of file qgseditorwidgetwrapper.cpp.

◆ isInTable()

bool QgsEditorWidgetWrapper::isInTable ( const QWidget * parent )

static

Check if the given widget or one of its parent is a QTableView.

Parameters

parent the widget to check

Returns: true if yes

Definition at line 295 of file qgseditorwidgetwrapper.cpp.

◆ isValidConstraint()

bool QgsEditorWidgetWrapper::isValidConstraint ( ) const

Gets the current constraint status.

Returns: true if the constraint is valid or if there's no constraint, false otherwise

See also: constraintFailureReason(); isBlockingCommit()

Definition at line 279 of file qgseditorwidgetwrapper.cpp.

◆ parentFormValueChanged

void QgsEditorWidgetWrapper::parentFormValueChanged	(	const QString &	attribute,
		const QVariant &	value
	)

virtualslot

Is called in embedded form widgets when an attribute value in the parent form has changed.

The default implementations does nothing. Subclasses should reimplement this method to notify the form widgets that something has changed in case they have filter expressions that depend on the parent form scope.

Since: QGIS 3.14

Definition at line 103 of file qgseditorwidgetwrapper.cpp.

◆ setConstraintResultVisible()

void QgsEditorWidgetWrapper::setConstraintResultVisible ( bool constraintResultVisible )

Sets whether the constraint result is visible.

Controls if the constraint result should be visualized on the widget (with color). This will be disabled when the form is not editable.

Parameters

constraintResultVisible if constraintResult should be displayed (mostly editable status)

Definition at line 160 of file qgseditorwidgetwrapper.cpp.

◆ setEnabled()

void QgsEditorWidgetWrapper::setEnabled ( bool enabled )

overridevirtual

Is used to enable or disable the edit functionality of the managed widget.

By default this will enable or disable the whole widget

Parameters

enabled Enable or Disable?

Reimplemented from QgsWidgetWrapper.

Reimplemented in QgsGeometryWidgetWrapper, and QgsValueRelationWidgetWrapper.

Definition at line 64 of file qgseditorwidgetwrapper.cpp.

◆ setFeature

void QgsEditorWidgetWrapper::setFeature ( const QgsFeature & feature )

overrideslot

Will be called when the feature changes.

Is forwarded to the slot setValues()

Parameters

feature The new feature

Definition at line 73 of file qgseditorwidgetwrapper.cpp.

◆ setFormFeature()

void QgsEditorWidgetWrapper::setFormFeature ( const QgsFeature & feature )

inlineprotected

Set the feature currently being edited to feature.

Since: QGIS 3.2

Definition at line 349 of file qgseditorwidgetwrapper.h.

◆ setFormFeatureAttribute()

bool QgsEditorWidgetWrapper::setFormFeatureAttribute	(	const QString &	attributeName,
		const QVariant &	attributeValue
	)

protected

Update the feature currently being edited by changing its attribute attributeName to attributeValue.

Returns: bool true on success

Since: QGIS 3.2

Definition at line 134 of file qgseditorwidgetwrapper.cpp.

◆ setHint()

void QgsEditorWidgetWrapper::setHint ( const QString & hintText )

virtual

Add a hint text on the widget.

Parameters

hintText The hint text to display

Reimplemented in QgsTextEditWrapper.

Definition at line 302 of file qgseditorwidgetwrapper.cpp.

◆ setValue

void QgsEditorWidgetWrapper::setValue ( const QVariant & value )

virtualslot

Is called when the value of the widget needs to be changed.

Updates the widget representation to reflect the new value.

Parameters

value The new value of the attribute

Deprecated:: QGIS 3.10

Definition at line 83 of file qgseditorwidgetwrapper.cpp.

◆ setValues

void QgsEditorWidgetWrapper::setValues	(	const QVariant &	value,
		const QVariantList &	additionalValues
	)

slot

Is called when the value of the widget or additional field values needs to be changed.

Updates the widget representation to reflect the new values.

Since: QGIS 3.10

Definition at line 90 of file qgseditorwidgetwrapper.cpp.

◆ showIndeterminateState()

virtual void QgsEditorWidgetWrapper::showIndeterminateState ( )

inlinevirtual

Sets the widget to display in an indeterminate "mixed value" state.

Reimplemented in QgsBinaryWidgetWrapper, QgsCheckboxWidgetWrapper, QgsClassificationWidgetWrapper, QgsColorWidgetWrapper, QgsDateTimeEditWrapper, QgsEnumerationWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsJsonEditWrapper, QgsKeyValueWidgetWrapper, QgsListWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsTextEditWrapper, QgsUniqueValuesWidgetWrapper, QgsValueMapWidgetWrapper, and QgsValueRelationWidgetWrapper.

Definition at line 153 of file qgseditorwidgetwrapper.h.

◆ updateConstraint() [1/3]

void QgsEditorWidgetWrapper::updateConstraint	(	const QgsFeature &	featureContext,
		QgsFieldConstraints::ConstraintOrigin	constraintOrigin = `QgsFieldConstraints::ConstraintOriginNotSet`
	)

Update constraint.

Parameters

featureContext	the feature to use to evaluate the constraint
constraintOrigin	optional origin for constraints to check. This can be used to limit the constraints tested to only provider or layer based constraints.

Definition at line 172 of file qgseditorwidgetwrapper.cpp.

◆ updateConstraint() [2/3]

void QgsEditorWidgetWrapper::updateConstraint	(	const QgsVectorLayer *	layer,
		int	index,
		const QgsFeature &	feature,
		QgsFieldConstraints::ConstraintOrigin	constraintOrigin = `QgsFieldConstraints::ConstraintOriginNotSet`
	)

Update constraint on a feature coming from a specific layer.

Parameters

layer	The vector layer where the feature is defined
index	The index of the field to check
feature	The feature to use to evaluate the constraint
constraintOrigin	Optional origin for constraints to check. This can be used to limit the constraints tested to only provider or layer based constraints.

Definition at line 177 of file qgseditorwidgetwrapper.cpp.

◆ updateConstraint() [3/3]

void QgsEditorWidgetWrapper::updateConstraint	(	QgsEditorWidgetWrapper::ConstraintResult	constraintResult,
		const QString &	constraintFailureReason
	)

Update constraint manually by providing the constraint result value and failure reason(s).

Parameters

constraintResult	the constraint result value
constraintFailureReason	the constraint failure reason(s) (blank is the result passes)

Since: QGIS 3.36

Definition at line 270 of file qgseditorwidgetwrapper.cpp.

◆ updateConstraintWidgetStatus()

void QgsEditorWidgetWrapper::updateConstraintWidgetStatus ( )

protectedvirtual

This should update the widget with a visual cue if a constraint status changed.

By default a stylesheet will be applied on the widget that changes the background color to red.

This can be overwritten in subclasses to allow individual widgets to change the visual cue.

Reimplemented in QgsRelationReferenceWidgetWrapper.

Definition at line 109 of file qgseditorwidgetwrapper.cpp.

◆ value()

virtual QVariant QgsEditorWidgetWrapper::value ( ) const

pure virtual

Will be used to access the widget's value.

Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Returns: The current value the widget represents

Implemented in QgsBinaryWidgetWrapper, QgsCheckboxWidgetWrapper, QgsClassificationWidgetWrapper, QgsColorWidgetWrapper, QgsDateTimeEditWrapper, QgsEnumerationWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsGeometryWidgetWrapper, QgsHiddenWidgetWrapper, QgsJsonEditWrapper, QgsKeyValueWidgetWrapper, QgsListWidgetWrapper, QgsRangeWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsTextEditWrapper, QgsUniqueValuesWidgetWrapper, QgsUuidWidgetWrapper, QgsValueMapWidgetWrapper, and QgsValueRelationWidgetWrapper.

◆ valueChanged

Q_DECL_DEPRECATED void QgsEditorWidgetWrapper::valueChanged ( const QVariant & value )

signal

Emit this signal, whenever the value changed.

Parameters

value The new value

Deprecated:: QGIS 3.10. Use valuesChanged signal instead.

◆ valuesChanged

void QgsEditorWidgetWrapper::valuesChanged	(	const QVariant &	value,
		const QVariantList &	additionalFieldValues = `QVariantList()`
	)

signal

Emit this signal, whenever the value changed.

It will also return the values for the additional fields handled by the widget

Parameters

value	The new value
additionalFieldValues	A map of additional field names with their corresponding values

Since: QGIS 3.10

Property Documentation

◆ constraintResult

ConstraintResult QgsEditorWidgetWrapper::constraintResult

read

Definition at line 52 of file qgseditorwidgetwrapper.h.

◆ constraintResultVisible

bool QgsEditorWidgetWrapper::constraintResultVisible

readwrite

Definition at line 51 of file qgseditorwidgetwrapper.h.

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

/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
/build/qgis-3.41.0+git20241116+25ec5511245+99sid/src/gui/editorwidgets/core/qgseditorwidgetwrapper.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ConstraintResult

Constructor & Destructor Documentation

◆ QgsEditorWidgetWrapper()

Member Function Documentation

◆ additionalFields()

◆ additionalFieldValues()

◆ constraintFailureReason()

◆ constraintResult()

◆ constraintResultVisible()

◆ constraintResultVisibleChanged

◆ constraintStatusChanged

◆ defaultValue()

◆ emitValueChanged

◆ field()

◆ fieldIdx()

◆ formFeature()

◆ fromWidget()

◆ isBlockingCommit()

◆ isInTable()

◆ isValidConstraint()

◆ parentFormValueChanged

◆ setConstraintResultVisible()

◆ setEnabled()

◆ setFeature

◆ setFormFeature()

◆ setFormFeatureAttribute()

◆ setHint()

◆ setValue

◆ setValues

◆ showIndeterminateState()

◆ updateConstraint() [1/3]

◆ updateConstraint() [2/3]

◆ updateConstraint() [3/3]

◆ updateConstraintWidgetStatus()

◆ value()

◆ valueChanged

◆ valuesChanged

Property Documentation

◆ constraintResult

◆ constraintResultVisible