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

#include <qgswidgetwrapper.h>

Inheritance diagram for QgsWidgetWrapper:

[legend]

Public Slots
virtual void	setEnabled (bool enabled)
	Is used to enable or disable the edit functionality of the managed widget. More...

virtual void	setFeature (const QgsFeature &feature)=0
	Is called, when the value of the widget needs to be changed. More...

Public Member Functions
	QgsWidgetWrapper (QgsVectorLayer vl, QWidget editor=nullptr, QWidget *parent=nullptr)
	Create a new widget wrapper. More...

QVariant	config (const QString &key, const QVariant &defaultVal=QVariant()) const
	Use this inside your overridden classes to access the configuration. More...

QgsEditorWidgetConfig	config () const
	Returns the whole config. More...

const QgsAttributeEditorContext &	context () const
	Returns information about the context in which this widget is shown. More...

QgsVectorLayer *	layer () const
	Access the QgsVectorLayer, you are working on. More...

void	setConfig (const QgsEditorWidgetConfig &config)
	Will set the config of this wrapper to the specified config. More...

void	setContext (const QgsAttributeEditorContext &context)
	Set the context in which this widget is shown. More...

virtual bool	valid () const =0
	Return true if the widget has been properly initialized. More...

QWidget *	widget ()
	Access the widget managed by this wrapper. More...

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*>();. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

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

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions
virtual QWidget *	createWidget (QWidget *parent)=0
	This method should create a new widget with the provided parent. More...

virtual void	initWidget (QWidget *editor)
	This method should initialize the editor widget with runtime data. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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.

Definition at line 39 of file qgswidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsWidgetWrapper()

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

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.

Definition at line 21 of file qgswidgetwrapper.cpp.

Member Function Documentation

◆ config() [1/2]

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

Use this inside your overridden 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

Definition at line 55 of file qgswidgetwrapper.cpp.

◆ config() [2/2]

QgsEditorWidgetConfig QgsWidgetWrapper::config ( ) const

Returns the whole config.

Returns: The configuration

Definition at line 64 of file qgswidgetwrapper.cpp.

◆ context()

const QgsAttributeEditorContext & QgsWidgetWrapper::context ( ) const

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

Returns: context information

Definition at line 69 of file qgswidgetwrapper.cpp.

◆ createWidget()

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 initialization 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 QgsRelationWidgetWrapper, QgsValueRelationWidgetWrapper, QgsCheckboxSearchWidgetWrapper, QgsRelationReferenceSearchWidgetWrapper, QgsDateTimeSearchWidgetWrapper, QgsValueRelationSearchWidgetWrapper, QgsDefaultSearchWidgetWrapper, QgsDateTimeEditWrapper, QgsPhotoWidgetWrapper, QgsRangeWidgetWrapper, QgsCheckboxWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsFileNameWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsValueMapSearchWidgetWrapper, QgsWebViewWidgetWrapper, QgsColorWidgetWrapper, QgsUuidWidgetWrapper, QgsClassificationWidgetWrapper, QgsEnumerationWidgetWrapper, and QgsHiddenWidgetWrapper.

◆ fromWidget()

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

Definition at line 79 of file qgswidgetwrapper.cpp.

◆ initWidget()

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 QgsRelationWidgetWrapper, QgsValueRelationWidgetWrapper, QgsCheckboxSearchWidgetWrapper, QgsRelationReferenceSearchWidgetWrapper, QgsDateTimeSearchWidgetWrapper, QgsValueRelationSearchWidgetWrapper, QgsDefaultSearchWidgetWrapper, QgsDateTimeEditWrapper, QgsPhotoWidgetWrapper, QgsRangeWidgetWrapper, QgsCheckboxWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsFileNameWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsValueMapSearchWidgetWrapper, QgsWebViewWidgetWrapper, QgsColorWidgetWrapper, QgsUuidWidgetWrapper, QgsClassificationWidgetWrapper, QgsEnumerationWidgetWrapper, and QgsHiddenWidgetWrapper.

Definition at line 84 of file qgswidgetwrapper.cpp.

◆ layer()

QgsVectorLayer * QgsWidgetWrapper::layer ( ) const

Access the QgsVectorLayer, you are working on.

Returns: The layer

See also: field()

Definition at line 74 of file qgswidgetwrapper.cpp.

◆ setConfig()

void QgsWidgetWrapper::setConfig ( const QgsEditorWidgetConfig & config )

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

Parameters

config The config for this wrapper

Definition at line 45 of file qgswidgetwrapper.cpp.

◆ setContext()

void QgsWidgetWrapper::setContext ( const QgsAttributeEditorContext & context )

Set the context in which this widget is shown.

Parameters

context context information

Definition at line 50 of file qgswidgetwrapper.cpp.

◆ setEnabled

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, and QgsValueRelationWidgetWrapper.

Definition at line 89 of file qgswidgetwrapper.cpp.

◆ setFeature

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

◆ valid()

virtual bool QgsWidgetWrapper::valid ( ) const

pure virtual

Return true if the widget has been properly initialized.

This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint tothe caller that he may try to find another suitable widget type instead.

Returns: Validity status of this widget.

Note: Added in 2.12

Implemented in QgsRelationWidgetWrapper, QgsValueRelationWidgetWrapper, QgsDefaultSearchWidgetWrapper, QgsDateTimeEditWrapper, QgsPhotoWidgetWrapper, QgsCheckboxSearchWidgetWrapper, QgsRelationReferenceSearchWidgetWrapper, QgsDateTimeSearchWidgetWrapper, QgsRangeWidgetWrapper, QgsRelationReferenceWidgetWrapper, QgsCheckboxWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsValueRelationSearchWidgetWrapper, QgsWebViewWidgetWrapper, QgsColorWidgetWrapper, QgsFileNameWidgetWrapper, QgsUuidWidgetWrapper, QgsClassificationWidgetWrapper, QgsEnumerationWidgetWrapper, QgsHiddenWidgetWrapper, and QgsValueMapSearchWidgetWrapper.

◆ widget() [1/2]

QWidget * QgsWidgetWrapper::widget ( )

Access the widget managed by this wrapper.

Returns: The widget

Definition at line 30 of file qgswidgetwrapper.cpp.

◆ widget() [2/2]

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.

Definition at line 66 of file qgswidgetwrapper.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/core/qgswidgetwrapper.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/editorwidgets/core/qgswidgetwrapper.cpp

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsWidgetWrapper()

Member Function Documentation

◆ config() [1/2]

◆ config() [2/2]

◆ context()

◆ createWidget()

◆ fromWidget()

◆ initWidget()

◆ layer()

◆ setConfig()

◆ setContext()

◆ setEnabled

◆ setFeature

◆ valid()

◆ widget() [1/2]

◆ widget() [2/2]