#include <qgsvaluerelationwidgetfactory.h>

Inheritance diagram for QgsValueRelationWidgetFactory:

Public Member Functions
	QgsValueRelationWidgetFactory (const QString &name)

Qt::AlignmentFlag	alignmentFlag (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config) const override
	Return the alignment for a particular field. More...

QgsEditorConfigWidget *	configWidget (QgsVectorLayer vl, int fieldIdx, QWidget parent) const override
	Override this in your implementation. More...

QgsEditorWidgetWrapper *	create (QgsVectorLayer vl, int fieldIdx, QWidget editor, QWidget *parent) const override
	Override this in your implementation. More...

QVariant	createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config) override
	Create a cache for a given field. More...

QgsSearchWidgetWrapper *	createSearchWidget (QgsVectorLayer vl, int fieldIdx, QWidget parent) const override
	By default a simple QgsFilterLineEdit is returned as search widget. More...

QgsEditorWidgetConfig	readConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx) override
	Read the config from an XML file and map it to a proper QgsEditorWidgetConfig. More...

QString	representValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const override
	Create a pretty String representation of the value. More...

QVariant	sortValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const override
	If the default sort order should be overwritten for this widget, you can transform the value in here. More...

void	writeConfig (const QgsEditorWidgetConfig &config, QDomElement &configElement, QDomDocument &doc, const QgsVectorLayer *layer, int fieldIdx) override
	Serialize your configuration and save it in a xml doc. More...

Public Member Functions inherited from QgsEditorWidgetFactory
	QgsEditorWidgetFactory (const QString &name)
	Constructor. More...

virtual	~QgsEditorWidgetFactory ()

QString	name ()
	Return The human readable identifier name of this widget type. More...

QgsEditorWidgetConfig	readEditorConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
	Read the config from an XML file and map it to a proper QgsEditorWidgetConfig. More...

virtual QMap< const char *, int >	supportedWidgetTypes ()
	Returns a list of widget types which this editor widget supports. More...

bool	supportsField (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 29 of file qgsvaluerelationwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsValueRelationWidgetFactory()

QgsValueRelationWidgetFactory::QgsValueRelationWidgetFactory ( const QString & name )

explicit

Definition at line 27 of file qgsvaluerelationwidgetfactory.cpp.

Member Function Documentation

◆ alignmentFlag()

Qt::AlignmentFlag QgsValueRelationWidgetFactory::alignmentFlag	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		const QgsEditorWidgetConfig &	config
	)		const

overridevirtual

Return the alignment for a particular field.

By default this will consider the field type but can be overwritten if mapped values are represented.

Parameters

vl	The vector layer.
fieldIdx	The index of the field.
config	The editor widget config.

Returns: The alignment flag, normally Qt::AlignRight or Qt::AlignLeft

Reimplemented from QgsEditorWidgetFactory.

Definition at line 138 of file qgsvaluerelationwidgetfactory.cpp.

◆ configWidget()

QgsEditorConfigWidget * QgsValueRelationWidgetFactory::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 42 of file qgsvaluerelationwidgetfactory.cpp.

◆ create()

QgsEditorWidgetWrapper * QgsValueRelationWidgetFactory::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 NULL 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 32 of file qgsvaluerelationwidgetfactory.cpp.

◆ createCache()

QVariant QgsValueRelationWidgetFactory::createCache	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		const QgsEditorWidgetConfig &	config
	)

overridevirtual

Create a cache for a given field.

Parameters

vl	The vector layer.
fieldIdx	The index of the field.
config	The editor widget config.

Returns: The default implementation returns an invalid QVariant

Reimplemented from QgsEditorWidgetFactory.

Definition at line 147 of file qgsvaluerelationwidgetfactory.cpp.

◆ createSearchWidget()

QgsSearchWidgetWrapper * QgsValueRelationWidgetFactory::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 qgsvaluerelationwidgetfactory.cpp.

◆ readConfig()

QgsEditorWidgetConfig QgsValueRelationWidgetFactory::readConfig	(	const QDomElement &	configElement,
		QgsVectorLayer *	layer,
		int	fieldIdx
	)

overridevirtual

Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.

Parameters

configElement	The configuration element from the project file
layer	The layer for which this configuration applies
fieldIdx	The field on the layer for which this configuration applies

Returns: A configuration object. This will be passed to your widget wrapper later on

Reimplemented from QgsEditorWidgetFactory.

Definition at line 47 of file qgsvaluerelationwidgetfactory.cpp.

◆ representValue()

QString QgsValueRelationWidgetFactory::representValue	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		const QgsEditorWidgetConfig &	config,
		const QVariant &	cache,
		const QVariant &	value
	)		const

overridevirtual

Create a pretty String representation of the value.

Parameters

vl	The vector layer.
fieldIdx	The index of the field.
config	The editor widget config.
cache	The editor widget cache.
value	The value to represent.

Returns: By default the string representation of the provided value as implied by the field definition is returned.

Reimplemented from QgsEditorWidgetFactory.

Definition at line 82 of file qgsvaluerelationwidgetfactory.cpp.

◆ sortValue()

QVariant QgsValueRelationWidgetFactory::sortValue	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		const QgsEditorWidgetConfig &	config,
		const QVariant &	cache,
		const QVariant &	value
	)		const

overridevirtual

If the default sort order should be overwritten for this widget, you can transform the value in here.

Parameters

vl	The vector layer.
fieldIdx	The index of the field.
config	The editor widget config.
cache	The editor widget cache.
value	The value to represent.

Returns: By default the value is returned unmodified.

Note: Added in 2.16

Reimplemented from QgsEditorWidgetFactory.

Definition at line 133 of file qgsvaluerelationwidgetfactory.cpp.

◆ writeConfig()

void QgsValueRelationWidgetFactory::writeConfig	(	const QgsEditorWidgetConfig &	config,
		QDomElement &	configElement,
		QDomDocument &	doc,
		const QgsVectorLayer *	layer,
		int	fieldIdx
	)

overridevirtual

Serialize your configuration and save it in a xml doc.

Parameters

config	The configuration to serialize
configElement	The element, where you can write your configuration into
doc	The document. You can use this to create new nodes
layer	The layer for which this configuration applies
fieldIdx	The field on the layer for which this configuration applies

Reimplemented from QgsEditorWidgetFactory.

Definition at line 66 of file qgsvaluerelationwidgetfactory.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsValueRelationWidgetFactory()

Member Function Documentation

◆ alignmentFlag()

◆ configWidget()

◆ create()

◆ createCache()

◆ createSearchWidget()

◆ readConfig()

◆ representValue()

◆ sortValue()

◆ writeConfig()