QgsCheckboxWidgetFactory Class Reference

#include <qgscheckboxwidgetfactory.h>

Inheritance diagram for QgsCheckboxWidgetFactory:

Public Member Functions
	QgsCheckboxWidgetFactory (const QString &name)
QgsEditorWidgetWrapper *	create (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const
	Override this in your implementation.
QgsEditorConfigWidget *	configWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const
	Override this in your implementation.
QgsEditorWidgetConfig	readConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
	Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.
void	writeConfig (const QgsEditorWidgetConfig &config, QDomElement &configElement, QDomDocument &doc, const QgsVectorLayer *layer, int fieldIdx)
	Serialize your configuration and save it in a xml doc.
Public Member Functions inherited from QgsEditorWidgetFactory
	QgsEditorWidgetFactory (const QString &name)
	Constructor.
virtual	~QgsEditorWidgetFactory ()
QString	name ()
	Return The human readable identifier name of this widget type.
QgsEditorWidgetConfig	readEditorConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
	Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.
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.

Constructor & Destructor Documentation

QgsCheckboxWidgetFactory::QgsCheckboxWidgetFactory ( const QString &  name )

explicit

Member Function Documentation

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

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

Implements QgsEditorWidgetFactory.

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

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

Implements QgsEditorWidgetFactory.

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

virtual

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.

void QgsCheckboxWidgetFactory::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 from QgsEditorWidgetFactory.

---

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

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