QGIS API Documentation  2.12.0-Lyon
Public Types | Public Slots | Public Member Functions | Protected Member Functions | Friends | List of all members
QgsValueRelationSearchWidgetWrapper Class Reference

Wraps a value relation widget. More...

#include <qgsvaluerelationsearchwidgetwrapper.h>

Inheritance diagram for QgsValueRelationSearchWidgetWrapper:
Inheritance graph
[legend]

Public Types

typedef QVector< ValueRelationItemValueRelationCache
 
typedef QPair< QVariant, QStringValueRelationItem
 

Public Slots

void valueChanged ()
 
- 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...
 

Public Member Functions

 QgsValueRelationSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 
bool applyDirectly () override
 If this is true, then this search widget should take effect directly when its expression changes. More...
 
QVariant value ()
 
- Public Member Functions inherited from QgsDefaultSearchWidgetWrapper
 QgsDefaultSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 
QString expression () override
 Will be used to access the widget's value. More...
 
- Public Member Functions inherited from QgsSearchWidgetWrapper
 QgsSearchWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=0)
 Create a new widget wrapper. 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 QgsAttributeEditorContextcontext ()
 Returns information about the context in which this widget is shown. More...
 
QgsVectorLayerlayer ()
 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...
 
QWidgetwidget ()
 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)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Protected Member Functions

QWidgetcreateWidget (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...
 
- Protected Member Functions inherited from QgsDefaultSearchWidgetWrapper
bool valid () override
 Return true if the widget has been properly initialized. 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Friends

class QgsValueRelationWidgetFactory
 

Additional Inherited Members

- Signals inherited from QgsSearchWidgetWrapper
void expressionChanged (QString exp)
 Emitted whenever the expression changes. More...
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (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 QgsDefaultSearchWidgetWrapper
void setExpression (QString exp) override
 
- Protected Slots inherited from QgsSearchWidgetWrapper
virtual void setExpression (QString value)=0
 
void setFeature (const QgsFeature &feature) override
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from QgsSearchWidgetWrapper
QString mExpression
 
int mFieldIdx
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Wraps a value relation widget.

This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). This is useful for having value lists on a separate layer containing codes and their translation to human readable names.

Options:

Definition at line 48 of file qgsvaluerelationsearchwidgetwrapper.h.

Member Typedef Documentation

Definition at line 54 of file qgsvaluerelationsearchwidgetwrapper.h.

Definition at line 53 of file qgsvaluerelationsearchwidgetwrapper.h.

Constructor & Destructor Documentation

QgsValueRelationSearchWidgetWrapper::QgsValueRelationSearchWidgetWrapper ( QgsVectorLayer vl,
int  fieldIdx,
QWidget parent = 0 
)
explicit

Definition at line 27 of file qgsvaluerelationsearchwidgetwrapper.cpp.

Member Function Documentation

bool QgsValueRelationSearchWidgetWrapper::applyDirectly ( )
overridevirtual

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

Reimplemented from QgsDefaultSearchWidgetWrapper.

Definition at line 36 of file qgsvaluerelationsearchwidgetwrapper.cpp.

QWidget * QgsValueRelationSearchWidgetWrapper::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 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
parentYou should set this parent on the created widget.
Returns
A new widget

Reimplemented from QgsDefaultSearchWidgetWrapper.

Definition at line 91 of file qgsvaluerelationsearchwidgetwrapper.cpp.

void QgsValueRelationSearchWidgetWrapper::initWidget ( QWidget editor)
overrideprotectedvirtual

This method should initialize the editor widget with runtime data.

Fill your comboboxes here.

Parameters
editorThe widget which will represent this attribute editor in a form.

Reimplemented from QgsDefaultSearchWidgetWrapper.

Definition at line 106 of file qgsvaluerelationsearchwidgetwrapper.cpp.

QVariant QgsValueRelationSearchWidgetWrapper::value ( )

Definition at line 45 of file qgsvaluerelationsearchwidgetwrapper.cpp.

void QgsValueRelationSearchWidgetWrapper::valueChanged ( )
slot

Definition at line 86 of file qgsvaluerelationsearchwidgetwrapper.cpp.

Friends And Related Function Documentation

friend class QgsValueRelationWidgetFactory
friend

Definition at line 77 of file qgsvaluerelationsearchwidgetwrapper.h.


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