Wraps a unique value widget. More...

#include <qgsuniquevaluewidgetwrapper.h>

Inheritance diagram for QgsUniqueValuesWidgetWrapper:

Public Slots
void	setValue (const QVariant &value) override

Public Slots inherited from QgsEditorWidgetWrapper
void	setFeature (const QgsFeature &feature) override
	Will be called when the feature changes. More...

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

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

Public Member Functions
	QgsUniqueValuesWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor=nullptr, QWidget *parent=nullptr)

void	showIndeterminateState () override
	Sets the widget to display in an indeterminate "mixed value" state. More...

QVariant	value () const override
	Will be used to access the widget's value. More...

Public Member Functions inherited from QgsEditorWidgetWrapper
	QgsEditorWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor=nullptr, QWidget *parent=nullptr)
	Create a new widget wrapper. More...

QVariant	defaultValue () const
	Access the default value of the field. More...

QgsField	field () const
	Access the field. More...

int	fieldIdx () const
	Access the field index. More...

bool	isValidConstraint () const
	Get the current constraint status. More...

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

void	updateConstraint (const QgsFeature &featureContext)
	Update constraint. More...

Public Member Functions inherited from QgsWidgetWrapper
	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...

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

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

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

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

Protected Member Functions inherited from QgsEditorWidgetWrapper
virtual void	updateConstraintWidgetStatus (bool constraintValid)
	This should update the widget with a visual cue if a constraint status changed. 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
Signals inherited from QgsEditorWidgetWrapper
void	constraintStatusChanged (const QString &constraint, const QString &desc, const QString &err, bool status)
	Emit this signal when the constraint status changed. More...

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

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

Static Public Member Functions inherited from QgsWidgetWrapper
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 Slots inherited from QgsEditorWidgetWrapper
void	valueChanged (const QString &value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...

void	valueChanged (int value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...

void	valueChanged (double value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...

void	valueChanged (bool value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...

void	valueChanged (qlonglong value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...

void	valueChanged ()
	Will call the value() method to determine the emitted value. More...

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

Properties inherited from QObject
	objectName

Detailed Description

Wraps a unique value widget.

Will offer any value previously used for this field.

Options:

Editable If True the user can manually insert new (not yet used) values.

Note: not available in Python bindings

Definition at line 34 of file qgsuniquevaluewidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsUniqueValuesWidgetWrapper()

QgsUniqueValuesWidgetWrapper::QgsUniqueValuesWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	editor = `nullptr`,
		QWidget *	parent = `nullptr`
	)

explicit

Definition at line 24 of file qgsuniquevaluewidgetwrapper.cpp.

Member Function Documentation

◆ createWidget()

QWidget * QgsUniqueValuesWidgetWrapper::createWidget ( QWidget * parent )

overrideprotectedvirtual

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

Implements QgsWidgetWrapper.

Definition at line 49 of file qgsuniquevaluewidgetwrapper.cpp.

◆ initWidget()

void QgsUniqueValuesWidgetWrapper::initWidget ( QWidget * editor )

overrideprotectedvirtual

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 from QgsWidgetWrapper.

Definition at line 57 of file qgsuniquevaluewidgetwrapper.cpp.

◆ setValue

void QgsUniqueValuesWidgetWrapper::setValue ( const QVariant & value )

overrideslot

Definition at line 120 of file qgsuniquevaluewidgetwrapper.cpp.

◆ showIndeterminateState()

void QgsUniqueValuesWidgetWrapper::showIndeterminateState ( )

overridevirtual

Sets the widget to display in an indeterminate "mixed value" state.

Note: added in QGIS 2.16

Reimplemented from QgsEditorWidgetWrapper.

Definition at line 108 of file qgsuniquevaluewidgetwrapper.cpp.

◆ valid()

bool QgsUniqueValuesWidgetWrapper::valid ( ) const

overrideprotectedvirtual

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

Implements QgsWidgetWrapper.

Definition at line 103 of file qgsuniquevaluewidgetwrapper.cpp.

◆ value()

QVariant QgsUniqueValuesWidgetWrapper::value ( ) const

overridevirtual

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

Implements QgsEditorWidgetWrapper.

Definition at line 31 of file qgsuniquevaluewidgetwrapper.cpp.

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

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

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsUniqueValuesWidgetWrapper()

Member Function Documentation

◆ createWidget()

◆ initWidget()

◆ setValue

◆ showIndeterminateState()

◆ valid()

◆ value()