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

#include <qgssearchwidgetwrapper.h>

Inheritance diagram for QgsSearchWidgetWrapper:

Signals
void	expressionChanged (QString exp)
	Emitted whenever the expression changes. More...

Public Member Functions
	QgsSearchWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget parent=0)
	Create a new widget wrapper. More...

virtual bool	applyDirectly ()=0
	If this is true, then this search widget should take effect directly when its expression changes. More...

virtual QString	expression ()=0
	Will be used to access the widget's value. More...

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

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

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

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

QgsVectorLayer *	layer ()
	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 ()=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

Protected Slots
virtual void	setExpression (QString value)=0

void	setFeature (const QgsFeature &feature) override

Protected Attributes
QString	mExpression

int	mFieldIdx

Additional Inherited Members
Public Slots inherited from QgsWidgetWrapper
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...

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

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 41 of file qgssearchwidgetwrapper.h.

Constructor & Destructor Documentation

QgsSearchWidgetWrapper::QgsSearchWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		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
parent	A parent widget for this widget wrapper and the created widget.

Definition at line 23 of file qgssearchwidgetwrapper.cpp.

Member Function Documentation

virtual bool QgsSearchWidgetWrapper::applyDirectly ( )

pure virtual

If this is true, then this search widget should take effect directly when its expression changes.

Implemented in QgsValueRelationSearchWidgetWrapper, QgsDefaultSearchWidgetWrapper, and QgsValueMapSearchWidgetWrapper.

virtual QString QgsSearchWidgetWrapper::expression ( )

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 QgsDefaultSearchWidgetWrapper.

void QgsSearchWidgetWrapper::expressionChanged ( QString exp )

signal

Emitted whenever the expression changes.

Parameters

exp	The new search expression

virtual void QgsSearchWidgetWrapper::setExpression ( QString value )

protectedpure virtualslot

void QgsSearchWidgetWrapper::setFeature ( const QgsFeature & feature )

overrideprotectedslot

Definition at line 31 of file qgssearchwidgetwrapper.cpp.

Member Data Documentation

QString QgsSearchWidgetWrapper::mExpression

protected

Definition at line 84 of file qgssearchwidgetwrapper.h.

int QgsSearchWidgetWrapper::mFieldIdx

protected

Definition at line 85 of file qgssearchwidgetwrapper.h.

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

/tmp/buildd/qgis-2.12.0+99unstable/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h
/tmp/buildd/qgis-2.12.0+99unstable/src/gui/editorwidgets/core/qgssearchwidgetwrapper.cpp

Signals

Public Member Functions

Protected Slots

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation