QgsEditorConfigWidget Class Reference

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

#include <qgseditorconfigwidget.h>

Inheritance diagram for QgsEditorConfigWidget:

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

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}

Definition at line 33 of file qgseditorconfigwidget.h.

Constructor & Destructor Documentation

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

explicit

Create a new configuration widget.

Parameters

vl	The layer for which the configuration dialog will be created
fieldIdx	The index of the field on the layer for which this dialog will be created
parent	A parent widget

Definition at line 19 of file qgseditorconfigwidget.cpp.

virtual QgsEditorConfigWidget::~QgsEditorConfigWidget ( )

inlinevirtual

Destructor.

Definition at line 77 of file qgseditorconfigwidget.h.

Member Function Documentation

virtual QgsEditorWidgetConfig QgsEditorConfigWidget::config ( )

pure virtual

Create a configuration from the current GUI state.

Returns

A widget configuration

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

int QgsEditorConfigWidget::field

(

)

Returns the field for which this configuration widget applies.

Returns

The field index

Definition at line 27 of file qgseditorconfigwidget.cpp.

QgsVectorLayer * QgsEditorConfigWidget::layer

(

)

Returns the layer for which this configuration widget applies.

Returns

The layer

Definition at line 32 of file qgseditorconfigwidget.cpp.

virtual void QgsEditorConfigWidget::setConfig ( const QgsEditorWidgetConfig &  config )

pure virtual

Update the configuration widget to represent the given configuration.

Parameters

config

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/editorwidgets/core/qgseditorconfigwidget.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/editorwidgets/core/qgseditorconfigwidget.cpp