QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
QgsEditorWidgetFactory Class Referenceabstract

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

#include <qgseditorwidgetfactory.h>

Inheritance diagram for QgsEditorWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsEditorWidgetFactory (const QString &name)
 Constructor. More...
 
virtual ~QgsEditorWidgetFactory ()
 
virtual QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const =0
 Override this in your implementation. More...
 
virtual QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const =0
 Override this in your implementation. More...
 
virtual QVariant createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config)
 Create a cache for a given field. More...
 
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 QString representValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const
 Create a pretty String representation of the value. More...
 
bool supportsField (QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field. More...
 
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. More...
 

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.

Definition at line 37 of file qgseditorwidgetfactory.h.

Constructor & Destructor Documentation

QgsEditorWidgetFactory::QgsEditorWidgetFactory ( const QString &  name)

Constructor.

Parameters
nameA human readable name for this widget type

Definition at line 20 of file qgseditorwidgetfactory.cpp.

QgsEditorWidgetFactory::~QgsEditorWidgetFactory ( )
virtual

Definition at line 25 of file qgseditorwidgetfactory.cpp.

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
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

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
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 NULL is provided, a new widget will be created.
parentThe 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
vlThe vector layer.
fieldIdxThe index of the field.
configThe editor widget config.
Returns
The default implementation returns an invalid QVariant

Reimplemented in QgsValueRelationWidgetFactory.

Definition at line 60 of file qgseditorwidgetfactory.cpp.

QString QgsEditorWidgetFactory::name ( )

Return The human readable identifier name of this widget type.

Returns
a name

Definition at line 29 of file qgseditorwidgetfactory.cpp.

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
configElementThe configuration element from the project file
layerThe layer for which this configuration applies
fieldIdxThe field on the layer for which this configuration applies
Returns
A configuration object. This will be passed to your widget wrapper later on

Definition at line 34 of file qgseditorwidgetfactory.cpp.

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
vlThe vector layer.
fieldIdxThe index of the field.
configThe editor widget config.
cacheThe editor widget cache.
valueThe 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.

Definition at line 48 of file qgseditorwidgetfactory.cpp.

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

Check if this editor widget type supports a certain field.

Parameters
vlThe layer
fieldIdxThe field index
Returns
True if the type is supported for this field
See also
isFieldSupported( QgsVectorLayer* vl, ind fieldIdx )

Definition at line 113 of file qgseditorwidgetfactory.h.

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
configThe configuration to serialize
configElementThe element, where you can write your configuration into
docThe document. You can use this to create new nodes
layerThe layer for which this configuration applies
fieldIdxThe field on the layer for which this configuration applies

Reimplemented in QgsRelationReferenceFactory, QgsDateTimeEditFactory, QgsValueRelationWidgetFactory, QgsTextEditWidgetFactory, QgsPhotoWidgetFactory, QgsCheckboxWidgetFactory, QgsRangeWidgetFactory, QgsUniqueValueWidgetFactory, QgsValueMapWidgetFactory, and QgsWebViewWidgetFactory.

Definition at line 39 of file qgseditorwidgetfactory.cpp.


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