QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | List of all members
QgsValueMapWidgetFactory Class Reference

#include <qgsvaluemapwidgetfactory.h>

Inheritance diagram for QgsValueMapWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsValueMapWidgetFactory (const QString &name)
 
Qt::AlignmentFlag alignmentFlag (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config) const override
 Return the alignment for a particular field. More...
 
QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 Override this in your implementation. More...
 
QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override
 Override this in your implementation. More...
 
QgsSearchWidgetWrappercreateSearchWidget (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...
 
virtual QMap< const char *, int > supportedWidgetTypes () override
 Returns a list of widget types which this editor widget supports. 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 ()
 
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...
 
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 26 of file qgsvaluemapwidgetfactory.h.

Constructor & Destructor Documentation

QgsValueMapWidgetFactory::QgsValueMapWidgetFactory ( const QString name)

Definition at line 23 of file qgsvaluemapwidgetfactory.cpp.

Member Function Documentation

Qt::AlignmentFlag QgsValueMapWidgetFactory::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
vlThe vector layer.
fieldIdxThe index of the field.
configThe editor widget config.
Returns
The alignment flag, normally Qt::AlignRight or Qt::AlignLeft

Reimplemented from QgsEditorWidgetFactory.

Definition at line 97 of file qgsvaluemapwidgetfactory.cpp.

QgsEditorConfigWidget * QgsValueMapWidgetFactory::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 40 of file qgsvaluemapwidgetfactory.cpp.

QgsEditorWidgetWrapper * QgsValueMapWidgetFactory::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 29 of file qgsvaluemapwidgetfactory.cpp.

QgsSearchWidgetWrapper * QgsValueMapWidgetFactory::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 35 of file qgsvaluemapwidgetfactory.cpp.

QgsEditorWidgetConfig QgsValueMapWidgetFactory::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 45 of file qgsvaluemapwidgetfactory.cpp.

QString QgsValueMapWidgetFactory::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
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 from QgsEditorWidgetFactory.

Definition at line 83 of file qgsvaluemapwidgetfactory.cpp.

QVariant QgsValueMapWidgetFactory::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
vlThe vector layer.
fieldIdxThe index of the field.
configThe editor widget config.
cacheThe editor widget cache.
valueThe value to represent.
Returns
By default the value is returned unmodified.
Note
Added in 2.16

Reimplemented from QgsEditorWidgetFactory.

Definition at line 92 of file qgsvaluemapwidgetfactory.cpp.

QMap< const char *, int > QgsValueMapWidgetFactory::supportedWidgetTypes ( )
overridevirtual

Returns a list of widget types which this editor widget supports.

Each widget type can have a priority value attached, the factory with the highest one will be used.

Returns
A map of widget type names and weight values
Note
not available in Python bindings

Reimplemented from QgsEditorWidgetFactory.

Definition at line 106 of file qgsvaluemapwidgetfactory.cpp.

void QgsValueMapWidgetFactory::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 63 of file qgsvaluemapwidgetfactory.cpp.


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