QGIS API Documentation  3.27.0-Master (aef1b1ec20)
Public Member Functions | List of all members
QgsAbstractRelationEditorWidgetFactory Class Referenceabstract

Factory class for creating relation widgets and their corresponding config widgets. More...

#include <qgsabstractrelationeditorwidget.h>

Inheritance diagram for QgsAbstractRelationEditorWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsAbstractRelationEditorWidgetFactory ()
 Creates a new relation widget factory with given name. More...
 
virtual ~QgsAbstractRelationEditorWidgetFactory ()=default
 
virtual QgsAbstractRelationEditorConfigWidgetconfigWidget (const QgsRelation &relation, QWidget *parent) const =0
 Override this in your implementation. More...
 
virtual QgsAbstractRelationEditorWidgetcreate (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 relation widgets and their corresponding config widgets.

Since
QGIS 3.18

Definition at line 424 of file qgsabstractrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsAbstractRelationEditorWidgetFactory()

QgsAbstractRelationEditorWidgetFactory::QgsAbstractRelationEditorWidgetFactory ( )

Creates a new relation widget factory with given name.

Definition at line 761 of file qgsabstractrelationeditorwidget.cpp.

◆ ~QgsAbstractRelationEditorWidgetFactory()

virtual QgsAbstractRelationEditorWidgetFactory::~QgsAbstractRelationEditorWidgetFactory ( )
virtualdefault

Member Function Documentation

◆ configWidget()

virtual QgsAbstractRelationEditorConfigWidget* QgsAbstractRelationEditorWidgetFactory::configWidget ( const QgsRelation relation,
QWidget *  parent 
) const
pure virtual

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters
relationThe relation for which the widget will be created
parentThe parent widget of the created config widget
Returns
A configuration widget

Implemented in QgsRelationEditorWidgetFactory.

◆ create()

virtual QgsAbstractRelationEditorWidget* QgsAbstractRelationEditorWidgetFactory::create ( const QVariantMap &  config,
QWidget *  parent = nullptr 
) const
pure virtual

Override this in your implementation.

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

Parameters
configThe widget configuration to build the widget with
parentThe parent for the wrapper class and any created widget.
Returns
A new widget wrapper

Implemented in QgsRelationEditorWidgetFactory.

◆ name()

virtual QString QgsAbstractRelationEditorWidgetFactory::name ( ) const
pure virtual

Returns the human readable identifier name of this widget type.

Implemented in QgsRelationEditorWidgetFactory.

◆ type()

virtual QString QgsAbstractRelationEditorWidgetFactory::type ( ) const
pure virtual

Returns the machine readable identifier name of this widget type.

Implemented in QgsRelationEditorWidgetFactory.


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