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

This class should be subclassed for every configurable editor widget type. More...

#include <qgseditorconfigwidget.h>

Inheritance diagram for QgsEditorConfigWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsEditorConfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent)
 Create a new configuration widget. More...
 
virtual QgsEditorWidgetConfig config ()=0
 Create a configuration from the current GUI state. More...
 
virtual void setConfig (const QgsEditorWidgetConfig &config)=0
 Update the configuration widget to represent the given configuration. More...
 
int field ()
 Returns the field for which this configuration widget applies. More...
 
QgsVectorLayerlayer ()
 Returns the layer for which this configuration widget applies. More...
 
virtual ~QgsEditorConfigWidget ()
 Destructor. More...
 

Detailed Description

This class should be subclassed for every configurable editor widget type.

It implements the GUI configuration widget and transforms this to/from a configuration.

It will only be instantiated by {

See also
QgsEditorWidgetFactory}

Constructor & Destructor Documentation

QgsEditorConfigWidget::QgsEditorConfigWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent 
)
explicit

Create a new configuration widget.

Parameters
vlThe layer for which the configuration dialog will be created
fieldIdxThe index of the field on the layer for which this dialog will be created
parentA parent widget
virtual QgsEditorConfigWidget::~QgsEditorConfigWidget ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual QgsEditorWidgetConfig QgsEditorConfigWidget::config ( )
pure virtual
int QgsEditorConfigWidget::field ( )

Returns the field for which this configuration widget applies.

Returns
The field index
QgsVectorLayer * QgsEditorConfigWidget::layer ( )

Returns the layer for which this configuration widget applies.

Returns
The layer
virtual void QgsEditorConfigWidget::setConfig ( const QgsEditorWidgetConfig config)
pure virtual

Update the configuration widget to represent the given configuration.

Parameters
configThe configuration which should be represented by this widget

Implemented in QgsDateTimeEditConfig, QgsValueRelationConfigDlg, QgsCheckBoxConfigDlg, QgsPhotoConfigDlg, QgsTextEditConfigDlg, QgsUniqueValuesConfigDlg, QgsWebViewWidgetConfigDlg, QgsDummyConfigDlg, QgsValueMapConfigDlg, QgsRangeConfigDlg, and QgsRelationReferenceConfigDlg.


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