QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsRelationReferenceFactory Class Reference

#include <qgsrelationreferencefactory.h>

Inheritance diagram for QgsRelationReferenceFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsRelationReferenceFactory (QString name, QgsMapCanvas *canvas, QgsMessageBar *messageBar)
virtual QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 Override this in your implementation.
virtual QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override
 Override this in your implementation.
virtual QgsEditorWidgetConfig readConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx) override
 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) override
 Serialize your configuration and save it in a xml doc.
- Public Member Functions inherited from QgsEditorWidgetFactory
 QgsEditorWidgetFactory (const QString &name)
 Constructor.
virtual ~QgsEditorWidgetFactory ()
virtual QVariant createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config)
 Create a cache for a given field.
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.
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.
bool supportsField (QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field.

Detailed Description

Definition at line 25 of file qgsrelationreferencefactory.h.

Constructor & Destructor Documentation

QgsRelationReferenceFactory::QgsRelationReferenceFactory ( QString  name,
QgsMapCanvas canvas,
QgsMessageBar messageBar 
)

Definition at line 21 of file qgsrelationreferencefactory.cpp.

Member Function Documentation

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

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

Implements QgsEditorWidgetFactory.

Definition at line 33 of file qgsrelationreferencefactory.cpp.

QgsEditorWidgetWrapper * QgsRelationReferenceFactory::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
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

Implements QgsEditorWidgetFactory.

Definition at line 28 of file qgsrelationreferencefactory.cpp.

QgsEditorWidgetConfig QgsRelationReferenceFactory::readConfig ( const QDomElement &  configElement,
QgsVectorLayer layer,
int  fieldIdx 
)
overridevirtual

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

Reimplemented from QgsEditorWidgetFactory.

Definition at line 38 of file qgsrelationreferencefactory.cpp.

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

Definition at line 54 of file qgsrelationreferencefactory.cpp.


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