QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
QgsValueRelationWidgetWrapper Class Reference

Wraps a value relation widget. More...

#include <qgsvaluerelationwidgetwrapper.h>

Inheritance diagram for QgsValueRelationWidgetWrapper:
Inheritance graph
[legend]

Public Types

typedef QVector
< ValueRelationItem
ValueRelationCache
 
typedef QPair< QVariant, QString > ValueRelationItem
 

Public Slots

void setValue (const QVariant &value)
 
- Public Slots inherited from QgsEditorWidgetWrapper
void setFeature (const QgsFeature &feature)
 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

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

Protected Member Functions

QWidget * createWidget (QWidget *parent)
 This method should create a new widget with the provided parent. More...
 
void initWidget (QWidget *editor)
 This method should initialize the editor widget with runtime data. More...
 

Static Protected Member Functions

static ValueRelationCache createCache (const QgsEditorWidgetConfig &config)
 

Friends

class QgsValueRelationWidgetFactory
 

Additional Inherited Members

- Signals inherited from QgsEditorWidgetWrapper
void valueChanged (const QVariant &value)
 Emit this signal, whenever the value changed. More...
 
- Static Public Member Functions inherited from QgsEditorWidgetWrapper
static QgsEditorWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
- 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...
 

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 46 of file qgsvaluerelationwidgetwrapper.h.

Member Typedef Documentation

Definition at line 52 of file qgsvaluerelationwidgetwrapper.h.

typedef QPair< QVariant, QString > QgsValueRelationWidgetWrapper::ValueRelationItem

Definition at line 51 of file qgsvaluerelationwidgetwrapper.h.

Constructor & Destructor Documentation

QgsValueRelationWidgetWrapper::QgsValueRelationWidgetWrapper ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  editor = 0,
QWidget *  parent = 0 
)
explicit

Definition at line 48 of file qgsvaluerelationwidgetwrapper.cpp.

Member Function Documentation

QgsValueRelationWidgetWrapper::ValueRelationCache QgsValueRelationWidgetWrapper::createCache ( const QgsEditorWidgetConfig config)
staticprotected

Definition at line 156 of file qgsvaluerelationwidgetwrapper.cpp.

QWidget * QgsValueRelationWidgetWrapper::createWidget ( QWidget *  parent)
protectedvirtual

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

Implements QgsWidgetWrapper.

Definition at line 83 of file qgsvaluerelationwidgetwrapper.cpp.

void QgsValueRelationWidgetWrapper::initWidget ( QWidget *  editor)
protectedvirtual

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

Definition at line 95 of file qgsvaluerelationwidgetwrapper.cpp.

void QgsValueRelationWidgetWrapper::setValue ( const QVariant &  value)
slot

Definition at line 130 of file qgsvaluerelationwidgetwrapper.cpp.

QVariant QgsValueRelationWidgetWrapper::value ( )
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

Implements QgsEditorWidgetWrapper.

Definition at line 54 of file qgsvaluerelationwidgetwrapper.cpp.

Friends And Related Function Documentation

friend class QgsValueRelationWidgetFactory
friend

Definition at line 77 of file qgsvaluerelationwidgetwrapper.h.


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