#include <qgsrelationreferencefactory.h>

Inheritance diagram for QgsRelationReferenceFactory:

Public Member Functions
	QgsRelationReferenceFactory (const QString &name, QgsMapCanvas canvas, QgsMessageBar messageBar)

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.

unsigned int	fieldScore (const QgsVectorLayer *vl, int fieldIdx) const override
	This method allows disabling this editor widget type for a certain field.

QHash< const char *, int >	supportedWidgetTypes () override
	Returns a list of widget types which this editor widget supports.

Public Member Functions inherited from QgsEditorWidgetFactory
	QgsEditorWidgetFactory (const QString &name)
	Constructor.

virtual	~QgsEditorWidgetFactory ()=default

QString	name () const
	Returns The human readable identifier name of this widget type.

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 34 of file qgsrelationreferencefactory.h.

Constructor & Destructor Documentation

◆ QgsRelationReferenceFactory()

QgsRelationReferenceFactory::QgsRelationReferenceFactory	(	const QString &	name,
		QgsMapCanvas *	canvas,
		QgsMessageBar *	messageBar
	)

Definition at line 25 of file qgsrelationreferencefactory.cpp.

Member Function Documentation

◆ configWidget()

QgsEditorConfigWidget * QgsRelationReferenceFactory::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 qgsrelationreferencefactory.cpp.

◆ create()

QgsEditorWidgetWrapper * QgsRelationReferenceFactory::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 qgsrelationreferencefactory.cpp.

◆ createSearchWidget()

QgsSearchWidgetWrapper * QgsRelationReferenceFactory::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 qgsrelationreferencefactory.cpp.

◆ fieldScore()

unsigned int QgsRelationReferenceFactory::fieldScore	(	const QgsVectorLayer *	vl,
		int	fieldIdx
	)		const

overridevirtual

This method allows disabling this editor widget type for a certain field.

By default, it returns 5 for every fields. Reimplement this if you only support certain fields.

Typical return values are:

0: not supported
5: maybe support (for example, Datetime support strings depending on their content)
10: basic support (this is what returns TextEdit for example, since it supports everything in a crude way)
20: specialized support

Parameters

vl
fieldIdx

Returns: 0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be taken by default). The default implementation returns 5..

See also: supportsField()

Reimplemented from QgsEditorWidgetFactory.

Definition at line 54 of file qgsrelationreferencefactory.cpp.

◆ supportedWidgetTypes()

QHash< const char *, int > QgsRelationReferenceFactory::supportedWidgetTypes ( )

overridevirtual

Returns a list of widget types which this editor widget supports.

Each widget type can have a priority value attached, the factory with the highest one will be used.

Returns: A map of widget type names and weight values

Note: not available in Python bindings

Reimplemented from QgsEditorWidgetFactory.

Definition at line 47 of file qgsrelationreferencefactory.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/editorwidgets/qgsrelationreferencefactory.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/editorwidgets/qgsrelationreferencefactory.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsRelationReferenceFactory()

Member Function Documentation

◆ configWidget()

◆ create()

◆ createSearchWidget()

◆ fieldScore()

◆ supportedWidgetTypes()