QGIS API Documentation  3.17.0-Master (df2c9ff931)
Public Member Functions | List of all members
QgsValueMapWidgetFactory Class Reference

#include <qgsvaluemapwidgetfactory.h>

Inheritance diagram for QgsValueMapWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsValueMapWidgetFactory (const QString &name)
 Constructor for QgsValueMapWidgetFactory, where name is a human-readable name for the factory. More...
 
QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 Override this in your implementation. More...
 
QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override
 Override this in your implementation. More...
 
QgsSearchWidgetWrappercreateSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 By default a simple QgsFilterLineEdit is returned as search widget. More...
 
QHash< const char *, int > supportedWidgetTypes () override
 Returns a list of widget types which this editor widget supports. More...
 
- Public Member Functions inherited from QgsEditorWidgetFactory
 QgsEditorWidgetFactory (const QString &name)
 Constructor. More...
 
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. More...
 
QString name ()
 Returns The human readable identifier name of this widget type. More...
 
bool supportsField (const QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field. More...
 

Detailed Description

Note
not available in Python bindings

Definition at line 30 of file qgsvaluemapwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsValueMapWidgetFactory()

QgsValueMapWidgetFactory::QgsValueMapWidgetFactory ( const QString &  name)

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

Definition at line 25 of file qgsvaluemapwidgetfactory.cpp.

Member Function Documentation

◆ configWidget()

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

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters
vlThe layer for which the widget will be created
fieldIdxThe field index for which the widget will be created
parentThe parent widget of the created config widget
Returns
A configuration widget

Implements QgsEditorWidgetFactory.

Definition at line 42 of file qgsvaluemapwidgetfactory.cpp.

◆ create()

QgsEditorWidgetWrapper * QgsValueMapWidgetFactory::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
vlThe vector layer on which this widget will act
fieldIdxThe field index on which this widget will act
editorAn editor widget if already existent. If nullptr is provided, a new widget will be created.
parentThe parent for the wrapper class and any created widget.
Returns
A new widget wrapper

Implements QgsEditorWidgetFactory.

Definition at line 31 of file qgsvaluemapwidgetfactory.cpp.

◆ createSearchWidget()

QgsSearchWidgetWrapper * QgsValueMapWidgetFactory::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 qgsvaluemapwidgetfactory.cpp.

◆ supportedWidgetTypes()

QHash< const char *, int > QgsValueMapWidgetFactory::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 qgsvaluemapwidgetfactory.cpp.


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