QgsValueRelationWidgetFactory Class Reference

#include <qgsvaluerelationwidgetfactory.h>

Inheritance diagram for QgsValueRelationWidgetFactory:

Public Member Functions
	QgsValueRelationWidgetFactory (const QString &name)
	Constructor for QgsValueRelationWidgetFactory, where name is a human-readable name for the factory.
QgsEditorConfigWidget *	configWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
	Override this in your implementation.
QgsEditorWidgetWrapper *	create (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override
	Override this in your implementation.
QgsSearchWidgetWrapper *	createSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
	By default a simple QgsFilterLineEdit is returned as search widget.
Public Member Functions inherited from QgsEditorWidgetFactory
	QgsEditorWidgetFactory (const QString &name)
	Constructor.
virtual	~QgsEditorWidgetFactory ()=default
virtual unsigned int	fieldScore (const QgsVectorLayer *vl, int fieldIdx) const
	This method allows disabling this editor widget type for a certain field.
QString	name () const
	Returns The human readable identifier name of this widget type.
virtual QHash< const char *, int >	supportedWidgetTypes ()
	Returns a list of widget types which this editor widget supports.
bool	supportsField (const QgsVectorLayer *vl, int fieldIdx) const
	Check if this editor widget type supports a certain field.

Detailed Description

Note

not available in Python bindings

Definition at line 32 of file qgsvaluerelationwidgetfactory.h.

Constructor & Destructor Documentation

QgsValueRelationWidgetFactory()

QgsValueRelationWidgetFactory::QgsValueRelationWidgetFactory ( const QString &  name )

explicit

Constructor for QgsValueRelationWidgetFactory, where name is a human-readable name for the factory.

Definition at line 27 of file qgsvaluerelationwidgetfactory.cpp.

Member Function Documentation

configWidget()

QgsEditorConfigWidget * QgsValueRelationWidgetFactory::configWidget ( QgsVectorLayer *  vl, int  fieldIdx, QWidget *  parent  ) const

overridevirtual

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters

vl	The layer for which the widget will be created
fieldIdx	The field index for which the widget will be created
parent	The parent widget of the created config widget

Returns

A configuration widget

Implements QgsEditorWidgetFactory.

Definition at line 42 of file qgsvaluerelationwidgetfactory.cpp.

create()

QgsEditorWidgetWrapper * QgsValueRelationWidgetFactory::create ( QgsVectorLayer *  vl, int  fieldIdx, QWidget *  editor, QWidget *  parent  ) const

overridevirtual

Override this in your implementation.

Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() instead of calling this method directly.

Parameters

vl	The vector layer on which this widget will act
fieldIdx	The field index on which this widget will act
editor	An editor widget if already existent. If nullptr is provided, a new widget will be created.
parent	The parent for the wrapper class and any created widget.

Returns

A new widget wrapper

Implements QgsEditorWidgetFactory.

Definition at line 32 of file qgsvaluerelationwidgetfactory.cpp.

createSearchWidget()

QgsSearchWidgetWrapper * QgsValueRelationWidgetFactory::createSearchWidget ( QgsVectorLayer *  vl, int  fieldIdx, QWidget *  parent  ) const

overridevirtual

By default a simple QgsFilterLineEdit is returned as search widget.

Override in own factory to get something different than the default.

Reimplemented from QgsEditorWidgetFactory.

Definition at line 37 of file qgsvaluerelationwidgetfactory.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.cpp