QgsEditorWidgetFactory Class Reference

Every attribute editor widget needs a factory, which inherits this class. More...

#include <qgseditorwidgetfactory.h>

Inheritance diagram for QgsEditorWidgetFactory:

Public Member Functions
	QgsEditorWidgetFactory (const QString &name)
	Constructor.
virtual	~QgsEditorWidgetFactory ()
virtual QgsEditorWidgetWrapper *	create (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const =0
	Override this in your implementation.
QString	name ()
	Return The human readable identifier name of this widget type.
virtual QgsEditorConfigWidget *	configWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const =0
	Override this in your implementation.
QgsEditorWidgetConfig	readEditorConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
	Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.
virtual void	writeConfig (const QgsEditorWidgetConfig &config, QDomElement &configElement, QDomDocument &doc, const QgsVectorLayer *layer, int fieldIdx)
	Serialize your configuration and save it in a xml doc.
bool	supportsField (QgsVectorLayer *vl, int fieldIdx)
	Check if this editor widget type supports a certain field.
virtual QString	representValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const
	Create a pretty String representation of the value.
virtual QVariant	createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config)
	Create a cache for a given field.

Detailed Description

Every attribute editor widget needs a factory, which inherits this class.

It provides metadata for the widgets such as the name (human readable), it serializes the configuration to an xml structure and loads the configuration from there.

It also has factory methods to create a widget wrapper for the attribute editor itself and another factory method to create a configuration dialog.

Constructor & Destructor Documentation

QgsEditorWidgetFactory::QgsEditorWidgetFactory

(

const QString &

name

)

Constructor.

Parameters

name	A human readable name for this widget type

QgsEditorWidgetFactory::~QgsEditorWidgetFactory ( )

virtual

Member Function Documentation

virtual QgsEditorConfigWidget* QgsEditorWidgetFactory::configWidget ( QgsVectorLayer *  vl, int  fieldIdx, QWidget *  parent  ) const

pure virtual

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

Implemented in QgsRelationReferenceFactory, QgsDateTimeEditFactory, QgsValueRelationWidgetFactory, QgsPhotoWidgetFactory, QgsCheckboxWidgetFactory, QgsClassificationWidgetWrapperFactory, QgsColorWidgetFactory, QgsEnumerationWidgetFactory, QgsFileNameWidgetFactory, QgsHiddenWidgetFactory, QgsRangeWidgetFactory, QgsTextEditWidgetFactory, QgsUniqueValueWidgetFactory, QgsUuidWidgetFactory, QgsValueMapWidgetFactory, and QgsWebViewWidgetFactory.

virtual QgsEditorWidgetWrapper* QgsEditorWidgetFactory::create ( QgsVectorLayer *  vl, int  fieldIdx, QWidget *  editor, QWidget *  parent  ) const

pure virtual

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

Implemented in QgsRelationReferenceFactory, QgsDateTimeEditFactory, QgsValueRelationWidgetFactory, QgsPhotoWidgetFactory, QgsCheckboxWidgetFactory, QgsClassificationWidgetWrapperFactory, QgsColorWidgetFactory, QgsEnumerationWidgetFactory, QgsFileNameWidgetFactory, QgsHiddenWidgetFactory, QgsRangeWidgetFactory, QgsTextEditWidgetFactory, QgsUniqueValueWidgetFactory, QgsUuidWidgetFactory, QgsValueMapWidgetFactory, and QgsWebViewWidgetFactory.

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

virtual

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 in QgsValueRelationWidgetFactory.

QString QgsEditorWidgetFactory::name

(

)

Return The human readable identifier name of this widget type.

Returns

a name

QgsEditorWidgetConfig QgsEditorWidgetFactory::readEditorConfig	(	const QDomElement &	configElement,
		QgsVectorLayer *	layer,
		int	fieldIdx
	)

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

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

virtual

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 in QgsDateTimeEditFactory, QgsValueRelationWidgetFactory, and QgsValueMapWidgetFactory.

bool QgsEditorWidgetFactory::supportsField ( QgsVectorLayer *  vl, int  fieldIdx  )

inline

Check if this editor widget type supports a certain field.

Parameters

vl	The layer
fieldIdx	The field index

Returns

True if the type is supported for this field

See Also

isFieldSupported( QgsVectorLayer* vl, ind fieldIdx )

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

virtual

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 in QgsRelationReferenceFactory, QgsDateTimeEditFactory, QgsValueRelationWidgetFactory, QgsTextEditWidgetFactory, QgsPhotoWidgetFactory, QgsCheckboxWidgetFactory, QgsRangeWidgetFactory, QgsUniqueValueWidgetFactory, QgsValueMapWidgetFactory, and QgsWebViewWidgetFactory.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/editorwidgets/core/qgseditorwidgetfactory.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/editorwidgets/core/qgseditorwidgetfactory.cpp