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

#include <qgseditorwidgetwrapper.h>

Inheritance diagram for QgsEditorWidgetWrapper:

Public Slots
void	setFeature (const QgsFeature &feature)
	Will be called when the feature changes.
virtual void	setValue (const QVariant &value)=0
	Is called, when the value of the widget needs to be changed.
Public Slots inherited from QgsWidgetWrapper
virtual void	setFeature (const QgsFeature &feature)=0
	Is called, when the value of the widget needs to be changed.

Signals
void	valueChanged (const QVariant &value)
	Emit this signal, whenever the value changed.

Public Member Functions
	QgsEditorWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor=0, QWidget *parent=0)
	Create a new widget wrapper.
virtual QVariant	value ()=0
	Will be used to access the widget's value.
int	fieldIdx ()
	Access the field index.
QgsField	field ()
	Access the field.
void	setEnabled (bool enabled)
	Is used to enable or disable the edit functionality of the managed widget.
Public Member Functions inherited from QgsWidgetWrapper
	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 QgsEditorWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.

Protected Slots
void	valueChanged (const QString &value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (int value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (double value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (bool value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (qlonglong value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged ()
	Will call the value() method to determine the emitted value.

Additional Inherited Members
Protected Member Functions inherited from QgsWidgetWrapper
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

QgsEditorWidgetWrapper::QgsEditorWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	editor = `0`,
		QWidget *	parent = `0`
	)

explicit

Create a new widget wrapper.

Parameters

vl	The layer on which the field is
fieldIdx	The field which will be controlled
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

QgsField QgsEditorWidgetWrapper::field ( )

Access the field.

Returns: The field you are working on

See Also: layer()

int QgsEditorWidgetWrapper::fieldIdx ( )

Access the field index.

Returns: The index of the field you are working on

See Also: layer()

QgsEditorWidgetWrapper * QgsEditorWidgetWrapper::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 from QgsWidgetWrapper.

void QgsEditorWidgetWrapper::setEnabled ( bool enabled )

virtual

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

By default this will enable or disable the whole widget

Parameters

enabled Enable or Disable?

Reimplemented from QgsWidgetWrapper.

void QgsEditorWidgetWrapper::setFeature ( const QgsFeature & feature )

slot

Will be called when the feature changes.

Is forwarded to the slot setValue()

Parameters

feature The new feature

virtual void QgsEditorWidgetWrapper::setValue ( const QVariant & value )

pure virtualslot

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

Update the widget representation to reflect the new value.

Parameters

value The new value of the attribute

virtual QVariant QgsEditorWidgetWrapper::value ( )

pure virtual

Will be used to access the widget's value.

Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Returns: The current value the widget represents

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

void QgsEditorWidgetWrapper::valueChanged ( const QVariant & value )

signal

Emit this signal, whenever the value changed.

Parameters

value The new value

void QgsEditorWidgetWrapper::valueChanged ( const QString & value )

protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for string type widgets.

Parameters

value The value

void QgsEditorWidgetWrapper::valueChanged ( int value )

protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for int type widgets.

Parameters

value The value

Note: python name valueChangedInt

void QgsEditorWidgetWrapper::valueChanged ( double value )

protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for double type widgets.

Parameters

value The value

Note: python name valueChangedDouble

void QgsEditorWidgetWrapper::valueChanged ( bool value )

protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for bool type widgets.

Parameters

value The value

Note: python name valueChangedBool

void QgsEditorWidgetWrapper::valueChanged ( qlonglong value )

protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for longlong type widgets.

Parameters

value The value

void QgsEditorWidgetWrapper::valueChanged ( )

protectedslot

Will call the value() method to determine the emitted value.

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

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

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation