Keeps track of the registered relations widgets. More...

#include <qgsrelationwidgetregistry.h>

Public Member Functions
	QgsRelationWidgetRegistry ()
	Constructor. More...

	~QgsRelationWidgetRegistry ()

void	addRelationWidget (QgsAbstractRelationEditorWidgetFactory *widgetFactory)
	Adds a new registered relation widgetFactory. More...

QgsAbstractRelationEditorWidget *	create (const QString &widgetType, const QVariantMap &config, QWidget *parent=nullptr) const
	Create a relation widget of a given type for a given field. More...

QgsAbstractRelationEditorConfigWidget *	createConfigWidget (const QString &widgetType, const QgsRelation &relation, QWidget *parent=nullptr) const
	Creates a configuration widget. More...

QMap< QString, QgsAbstractRelationEditorWidgetFactory * >	factories () const
	Gets access to all registered factories. More...

QStringList	relationWidgetNames ()
	Returns a list of names of registered relation widgets. More...

void	removeRelationWidget (const QString &widgetType)
	Removes a registered relation widget with given widgetType. More...

Detailed Description

Keeps track of the registered relations widgets.

New widgets can be registered, old ones deleted. The default {

See also: QgsRelationEditorWidget} is protected from removing.

Since: QGIS 3.18

Definition at line 33 of file qgsrelationwidgetregistry.h.

Constructor & Destructor Documentation

◆ QgsRelationWidgetRegistry()

QgsRelationWidgetRegistry::QgsRelationWidgetRegistry ( )

Constructor.

Definition at line 21 of file qgsrelationwidgetregistry.cpp.

◆ ~QgsRelationWidgetRegistry()

QgsRelationWidgetRegistry::~QgsRelationWidgetRegistry ( )

Definition at line 26 of file qgsrelationwidgetregistry.cpp.

Member Function Documentation

◆ addRelationWidget()

void QgsRelationWidgetRegistry::addRelationWidget ( QgsAbstractRelationEditorWidgetFactory * widgetFactory )

Adds a new registered relation widgetFactory.

Definition at line 32 of file qgsrelationwidgetregistry.cpp.

◆ create()

QgsAbstractRelationEditorWidget * QgsRelationWidgetRegistry::create	(	const QString &	widgetType,
		const QVariantMap &	config,
		QWidget *	parent = `nullptr`
	)		const

Create a relation widget of a given type for a given field.

Parameters

widgetType	The widget type to create a relation editor for
config	The configuration of the widget
parent

Definition at line 62 of file qgsrelationwidgetregistry.cpp.

◆ createConfigWidget()

QgsAbstractRelationEditorConfigWidget * QgsRelationWidgetRegistry::createConfigWidget	(	const QString &	widgetType,
		const QgsRelation &	relation,
		QWidget *	parent = `nullptr`
	)		const

Creates a configuration widget.

Parameters

widgetType	The widget type to create a configuration widget for
relation	The relation for which this widget will be created
parent	The parent widget for the created widget

Definition at line 70 of file qgsrelationwidgetregistry.cpp.

◆ factories()

QMap< QString, QgsAbstractRelationEditorWidgetFactory * > QgsRelationWidgetRegistry::factories ( ) const

Gets access to all registered factories.

Definition at line 57 of file qgsrelationwidgetregistry.cpp.

◆ relationWidgetNames()

QStringList QgsRelationWidgetRegistry::relationWidgetNames ( )

Returns a list of names of registered relation widgets.

Definition at line 52 of file qgsrelationwidgetregistry.cpp.

◆ removeRelationWidget()

void QgsRelationWidgetRegistry::removeRelationWidget ( const QString & widgetType )

Removes a registered relation widget with given widgetType.

Definition at line 43 of file qgsrelationwidgetregistry.cpp.

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

/build/qgis-3.18.1+99unstable/src/gui/qgsrelationwidgetregistry.h
/build/qgis-3.18.1+99unstable/src/gui/qgsrelationwidgetregistry.cpp

Public Member Functions