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
QgsEnumerationWidgetFactory Class Reference

#include <qgsenumerationwidgetfactory.h>

Inheritance diagram for QgsEnumerationWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsEnumerationWidgetFactory (const QString &name)
 
QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const
 Override this in your implementation. More...
 
QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const
 Override this in your implementation. 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...
 
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

Definition at line 21 of file qgsenumerationwidgetfactory.h.

Constructor & Destructor Documentation

QgsEnumerationWidgetFactory::QgsEnumerationWidgetFactory ( const QString &  name)
explicit

Definition at line 23 of file qgsenumerationwidgetfactory.cpp.

Member Function Documentation

QgsEditorConfigWidget * QgsEnumerationWidgetFactory::configWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent 
) const
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

Implements QgsEditorWidgetFactory.

Definition at line 33 of file qgsenumerationwidgetfactory.cpp.

QgsEditorWidgetWrapper * QgsEnumerationWidgetFactory::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
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 qgsenumerationwidgetfactory.cpp.


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