QgsRelationEditorWidgetFactory Class Reference

Factory class for creating a relation editor widget and the respective config widget. More...

#include <qgsrelationeditorwidget.h>

Inheritance diagram for QgsRelationEditorWidgetFactory:

Public Member Functions
	QgsRelationEditorWidgetFactory ()
QgsAbstractRelationEditorConfigWidget *	configWidget (const QgsRelation &relation, QWidget *parent) const override
	Override this in your implementation. More...
QgsAbstractRelationEditorWidget *	create (const QVariantMap &config, QWidget *parent=nullptr) const override
	Override this in your implementation. More...
QString	name () const override
	Returns the human readable identifier name of this widget type. More...
QString	type () const override
	Returns the machine readable identifier name of this widget type. More...
Public Member Functions inherited from QgsAbstractRelationEditorWidgetFactory
	QgsAbstractRelationEditorWidgetFactory ()
	Creates a new relation widget factory with given name. More...
virtual	~QgsAbstractRelationEditorWidgetFactory ()=default
virtual QgsAbstractRelationEditorConfigWidget *	configWidget (const QgsRelation &relation, QWidget *parent) const =0
	Override this in your implementation. More...
virtual QgsAbstractRelationEditorWidget *	create (const QVariantMap &config, QWidget *parent=nullptr) const =0
	Override this in your implementation. More...
virtual QString	name () const =0
	Returns the human readable identifier name of this widget type. More...
virtual QString	type () const =0
	Returns the machine readable identifier name of this widget type. More...

Detailed Description

Factory class for creating a relation editor widget and the respective config widget.

Note

not available in Python bindings

Since

QGIS 3.18

Definition at line 318 of file qgsrelationeditorwidget.h.

Constructor & Destructor Documentation

QgsRelationEditorWidgetFactory()

QgsRelationEditorWidgetFactory::QgsRelationEditorWidgetFactory

(

)

Definition at line 977 of file qgsrelationeditorwidget.cpp.

Member Function Documentation

configWidget()

QgsAbstractRelationEditorConfigWidget * QgsRelationEditorWidgetFactory::configWidget ( const QgsRelation &  relation, QWidget *  parent  ) const

overridevirtual

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters

relation	The relation for which the widget will be created
parent	The parent widget of the created config widget

Returns

A configuration widget

Implements QgsAbstractRelationEditorWidgetFactory.

Definition at line 997 of file qgsrelationeditorwidget.cpp.

create()

QgsAbstractRelationEditorWidget * QgsRelationEditorWidgetFactory::create ( const QVariantMap &  config, QWidget *  parent = nullptr  ) const

overridevirtual

Override this in your implementation.

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

Parameters

config	The widget configuration to build the widget with
parent	The parent for the wrapper class and any created widget.

Returns

A new widget wrapper

Implements QgsAbstractRelationEditorWidgetFactory.

Definition at line 992 of file qgsrelationeditorwidget.cpp.

name()

QString QgsRelationEditorWidgetFactory::name ( ) const

overridevirtual

Returns the human readable identifier name of this widget type.

Implements QgsAbstractRelationEditorWidgetFactory.

Definition at line 987 of file qgsrelationeditorwidget.cpp.

type()

QString QgsRelationEditorWidgetFactory::type ( ) const

overridevirtual

Returns the machine readable identifier name of this widget type.

Implements QgsAbstractRelationEditorWidgetFactory.

Definition at line 982 of file qgsrelationeditorwidget.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/gui/qgsrelationeditorwidget.h
• /build/qgis-3.28.0+99sid/src/gui/qgsrelationeditorwidget.cpp