QgsKeyValueWidgetFactory Class Reference

Factory for widgets for editing a QVariantMap. More...

#include <qgskeyvaluewidgetfactory.h>

Inheritance diagram for QgsKeyValueWidgetFactory:

Public Member Functions
	QgsKeyValueWidgetFactory (const QString &name)
	Constructor for QgsKeyValueWidgetFactory, where name is a human-readable name for the factory.
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.
unsigned int	fieldScore (const QgsVectorLayer *vl, int fieldIdx) const override
	This method allows disabling this editor widget type for a certain field.
Public Member Functions inherited from QgsEditorWidgetFactory
	QgsEditorWidgetFactory (const QString &name)
	Constructor.
virtual	~QgsEditorWidgetFactory ()=default
virtual QgsSearchWidgetWrapper *	createSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const
	By default a simple QgsFilterLineEdit is returned as search widget.
QString	name () const
	Returns The human readable identifier name of this widget type.
virtual QHash< const char *, int >	supportedWidgetTypes ()
	Returns a list of widget types which this editor widget supports.
bool	supportsField (const QgsVectorLayer *vl, int fieldIdx) const
	Check if this editor widget type supports a certain field.

Detailed Description

Factory for widgets for editing a QVariantMap.

Note

not available in Python bindings

Definition at line 29 of file qgskeyvaluewidgetfactory.h.

Constructor & Destructor Documentation

QgsKeyValueWidgetFactory()

QgsKeyValueWidgetFactory::QgsKeyValueWidgetFactory

(

const QString &

name

)

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

Definition at line 25 of file qgskeyvaluewidgetfactory.cpp.

Member Function Documentation

configWidget()

QgsEditorConfigWidget * QgsKeyValueWidgetFactory::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 35 of file qgskeyvaluewidgetfactory.cpp.

create()

QgsEditorWidgetWrapper * QgsKeyValueWidgetFactory::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 30 of file qgskeyvaluewidgetfactory.cpp.

fieldScore()

unsigned int QgsKeyValueWidgetFactory::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 43 of file qgskeyvaluewidgetfactory.cpp.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/editorwidgets/qgskeyvaluewidgetfactory.cpp