Wraps a relation reference widget. More...

#include <qgsrelationreferencewidgetwrapper.h>

Inheritance diagram for QgsRelationReferenceWidgetWrapper:

Public Slots
virtual void	setEnabled (bool enabled) override
virtual void	setValue (const QVariant &value) override
Public Slots inherited from QgsEditorWidgetWrapper
void	setFeature (const QgsFeature &feature) override
	Will be called when the feature changes.
virtual void	setValue (const QVariant &value)=0
	Is called, when the value of the widget needs to be changed.
Public Slots inherited from QgsWidgetWrapper
virtual void	setFeature (const QgsFeature &feature)=0
	Is called, when the value of the widget needs to be changed.

Public Member Functions
	QgsRelationReferenceWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor, QgsMapCanvas canvas, QgsMessageBar messageBar, QWidget *parent=0)
virtual QWidget *	createWidget (QWidget *parent) override
	This method should create a new widget with the provided parent.
virtual void	initWidget (QWidget *editor) override
	This method should initialize the editor widget with runtime data.
virtual QVariant	value () override
	Will be used to access the widget's value.
Public Member Functions inherited from QgsEditorWidgetWrapper
	QgsEditorWidgetWrapper (QgsVectorLayer vl, int fieldIdx, QWidget editor=0, QWidget *parent=0)
	Create a new widget wrapper.
QgsField	field ()
	Access the field.
int	fieldIdx ()
	Access the field index.
void	setEnabled (bool enabled) override
	Is used to enable or disable the edit functionality of the managed widget.
Public Member Functions inherited from QgsWidgetWrapper
	QgsWidgetWrapper (QgsVectorLayer vl, QWidget editor=0, QWidget *parent=0)
	Create a new widget wrapper.
QVariant	config (QString key, QVariant defaultVal=QVariant())
	Use this inside your overriden classes to access the configuration.
const QgsEditorWidgetConfig	config ()
	Returns the whole config.
const QgsAttributeEditorContext &	context ()
	Returns information about the context in which this widget is shown.
QgsVectorLayer *	layer ()
	Access the QgsVectorLayer, you are working on.
void	setConfig (const QgsEditorWidgetConfig &config)
	Will set the config of this wrapper to the specified config.
void	setContext (const QgsAttributeEditorContext &context)
	Set the context in which this widget is shown.
QWidget *	widget ()
	Access the widget managed by this wrapper.
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*>();.

Additional Inherited Members
Signals inherited from QgsEditorWidgetWrapper
void	valueChanged (const QVariant &value)
	Emit this signal, whenever the value changed.
Static Public Member Functions inherited from QgsEditorWidgetWrapper
static QgsEditorWidgetWrapper *	fromWidget (QWidget *widget)
	Will return a wrapper for a given widget.
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.
void	valueChanged (int value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (double value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (bool value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged (qlonglong value)
	If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.
void	valueChanged ()
	Will call the value() method to determine the emitted value.

Detailed Description

Wraps a relation reference widget.

Options:

ShowForm If True, an embedded form with the referenced feature will be shown.
MapIdentification Will offer a map tool to pick a referenced feature on the map canvas. Only use for layers with geometry.
ReadOnly If True, will represent the referenced widget in a read-only line edit. Can speed up loading.
AllowNULL Will offer NULL as a value.
Relation The ID of the relation that will be used to define this widget. ReadOnly

Definition at line 38 of file qgsrelationreferencewidgetwrapper.h.

Constructor & Destructor Documentation

QgsRelationReferenceWidgetWrapper::QgsRelationReferenceWidgetWrapper	(	QgsVectorLayer *	vl,
		int	fieldIdx,
		QWidget *	editor,
		QgsMapCanvas *	canvas,
		QgsMessageBar *	messageBar,
		QWidget *	parent = `0`
	)

explicit

Definition at line 22 of file qgsrelationreferencewidgetwrapper.cpp.

Member Function Documentation

QWidget * QgsRelationReferenceWidgetWrapper::createWidget ( QWidget * parent )

overridevirtual

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

parent You should set this parent on the created widget.

Returns: A new widget

Implements QgsWidgetWrapper.

Definition at line 30 of file qgsrelationreferencewidgetwrapper.cpp.

void QgsRelationReferenceWidgetWrapper::initWidget ( QWidget * editor )

overridevirtual

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 37 of file qgsrelationreferencewidgetwrapper.cpp.

void QgsRelationReferenceWidgetWrapper::setEnabled ( bool enabled )

overridevirtualslot

Definition at line 105 of file qgsrelationreferencewidgetwrapper.cpp.

void QgsRelationReferenceWidgetWrapper::setValue ( const QVariant & value )

overridevirtualslot

Definition at line 97 of file qgsrelationreferencewidgetwrapper.cpp.

QVariant QgsRelationReferenceWidgetWrapper::value ( )

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 80 of file qgsrelationreferencewidgetwrapper.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.cpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation