Manages an editor widget Widget and wrapper share the same parent. More...

#include <qgswidgetwrapper.h>

Inheritance diagram for QgsWidgetWrapper:

Public Slots
virtual void	setFeature (const QgsFeature &feature)=0
	Is called, when the value of the widget needs to be changed.
virtual void	setEnabled (bool enabled)
	Is used to enable or disable the edit functionality of the managed widget.

Public Member Functions
	QgsWidgetWrapper (QgsVectorLayer vl, QWidget editor=0, QWidget *parent=0)
	Create a new widget wrapper.
QWidget *	widget ()
	Access the widget managed by this wrapper.
template<class T >
T *	widget ()
	Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrapper->widget<QPushButton*>();.
void	setConfig (const QgsEditorWidgetConfig &config)
	Will set the config of this wrapper to the specified config.
void	setContext (const QgsAttributeEditorContext context)
	Set the context in which this widget is shown.
QVariant	config (QString key, QVariant defaultVal=QVariant())
	Use this inside your overriden classes to access the configuration.
const QgsEditorWidgetConfig	config ()
	Returns the whole config.
const QgsAttributeEditorContext &	context ()
	Returns information about the context in which this widget is shown.
QgsVectorLayer *	layer ()
	Access the QgsVectorLayer, you are working on.

Static Public Member Functions
static QgsWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.

Protected Member Functions
virtual QWidget *	createWidget (QWidget *parent)=0
	This method should create a new widget with the provided parent.
virtual void	initWidget (QWidget *editor)
	This method should initialize the editor widget with runtime data.

Detailed Description

Manages an editor widget Widget and wrapper share the same parent.

A wrapper controls one attribute editor widget and is able to create a default widget or use a pre-existent widget. It is able to set the widget to the value implied by a field of a vector layer, or return the value it currently holds. Every time it is changed it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the changed status of the widget will be saved.

Constructor & Destructor Documentation

QgsWidgetWrapper::QgsWidgetWrapper	(	QgsVectorLayer *	vl,
		QWidget *	editor = `0`,
		QWidget *	parent = `0`
	)

explicit

Create a new widget wrapper.

Parameters

vl	The layer on which the field is
editor	An editor widget. Can be NULL if one should be autogenerated.
parent	A parent widget for this widget wrapper and the created widget.

Member Function Documentation

QVariant QgsWidgetWrapper::config	(	QString	key,
		QVariant	defaultVal = `QVariant()`
	)

Use this inside your overriden classes to access the configuration.

Parameters

key	The configuration option you want to load
defaultVal	Default value

Returns: the value assigned to this configuration option

const QgsEditorWidgetConfig QgsWidgetWrapper::config ( )

Returns the whole config.

Returns: The configuration

const QgsAttributeEditorContext & QgsWidgetWrapper::context ( )

Returns information about the context in which this widget is shown.

Returns: context information

virtual QWidget* QgsWidgetWrapper::createWidget ( QWidget * parent )

protectedpure virtual

This method should create a new widget with the provided parent.

This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialisation stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget(QWidget*).

Parameters

parent You should set this parent on the created widget.

Returns: A new widget

Implemented in QgsValueRelationWidgetWrapper, QgsDateTimeEditWrapper, QgsRangeWidgetWrapper, QgsPhotoWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsCheckboxWidgetWrapper, QgsFileNameWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsUuidWidgetWrapper, QgsWebViewWidgetWrapper, QgsColorWidgetWrapper, QgsHiddenWidgetWrapper, QgsClassificationWidgetWrapper, QgsEnumerationWidgetWrapper, and QgsRelationWidgetWrapper.

QgsWidgetWrapper * QgsWidgetWrapper::fromWidget ( QWidget * widget )

static

Will return a wrapper for a given widget.

Parameters

widget The widget which was created by a wrapper

Returns: The wrapper for the widget or NULL

Reimplemented in QgsEditorWidgetWrapper.

void QgsWidgetWrapper::initWidget ( QWidget * editor )

protectedvirtual

This method should initialize the editor widget with runtime data.

Fill your comboboxes here.

Parameters

editor The widget which will represent this attribute editor in a form.

Reimplemented in QgsValueRelationWidgetWrapper, QgsDateTimeEditWrapper, QgsRangeWidgetWrapper, QgsPhotoWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsCheckboxWidgetWrapper, QgsFileNameWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsUuidWidgetWrapper, QgsWebViewWidgetWrapper, QgsColorWidgetWrapper, QgsHiddenWidgetWrapper, QgsClassificationWidgetWrapper, QgsEnumerationWidgetWrapper, and QgsRelationWidgetWrapper.

QgsVectorLayer * QgsWidgetWrapper::layer ( )

Access the QgsVectorLayer, you are working on.

Returns: The layer

See Also: field()

void QgsWidgetWrapper::setConfig ( const QgsEditorWidgetConfig & config )

Will set the config of this wrapper to the specified config.

Parameters

config The config for this wrapper

void QgsWidgetWrapper::setContext ( const QgsAttributeEditorContext context )

Set the context in which this widget is shown.

Parameters

context context information

void QgsWidgetWrapper::setEnabled ( bool enabled )

virtualslot

Is used to enable or disable the edit functionality of the managed widget.

By default this will not change the enabled state of the widget

Parameters

enabled Enable or Disable?

Reimplemented in QgsEditorWidgetWrapper.

virtual void QgsWidgetWrapper::setFeature ( const QgsFeature & feature )

pure virtualslot

Is called, when the value of the widget needs to be changed.

Update the widget representation to reflect the new value.

Parameters

feature The new feature

QWidget * QgsWidgetWrapper::widget ( )

Access the widget managed by this wrapper.

Returns: The widget

template<class T >

T* QgsWidgetWrapper::widget ( )

inline

Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrapper->widget<QPushButton*>();.

Returns: The widget as template type or NULL, if it cannot be cast to this type.

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/gui/editorwidgets/core/qgswidgetwrapper.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/gui/editorwidgets/core/qgswidgetwrapper.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation