#include <qgsrelationwidgetwrapper.h>

Inheritance diagram for QgsRelationWidgetWrapper:

Public Slots
void	setFeature (const QgsFeature &feature) override

void	setVisible (bool visible)
	Sets the visibility of the wrapper's widget. More...

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
	QgsRelationWidgetWrapper (QgsVectorLayer vl, const QgsRelation &relation, QWidget editor=nullptr, QWidget *parent=nullptr)

void	setShowLabel (bool showLabel)
	Defines if a title lable should be shown for this widget. More...

void	setShowLinkButton (bool showLinkButton)
	Determines if the "link feature" button should be shown. More...

void	setShowUnlinkButton (bool showUnlinkButton)
	Determines if the "unlink feature" button should be shown. More...

bool	showLabel () const
	Defines if a title lable should be shown for this widget. More...

bool	showLinkButton () const
	Determines if the "link feature" button should be shown. More...

bool	showUnlinkButton () const
	Determines if the "unlink feature" button should be shown. 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 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
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)

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

Properties inherited from QObject
	objectName

Detailed Description

Note: not available in Python bindings

Definition at line 28 of file qgsrelationwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsRelationWidgetWrapper()

QgsRelationWidgetWrapper::QgsRelationWidgetWrapper	(	QgsVectorLayer *	vl,
		const QgsRelation &	relation,
		QWidget *	editor = `nullptr`,
		QWidget *	parent = `nullptr`
	)

explicit

Definition at line 24 of file qgsrelationwidgetwrapper.cpp.

Member Function Documentation

◆ createWidget()

QWidget * QgsRelationWidgetWrapper::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 31 of file qgsrelationwidgetwrapper.cpp.

◆ initWidget()

void QgsRelationWidgetWrapper::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 73 of file qgsrelationwidgetwrapper.cpp.

◆ setFeature

void QgsRelationWidgetWrapper::setFeature ( const QgsFeature & feature )

overrideslot

Definition at line 36 of file qgsrelationwidgetwrapper.cpp.

◆ setShowLabel()

void QgsRelationWidgetWrapper::setShowLabel ( bool showLabel )

Defines if a title lable should be shown for this widget.

Only has an effect after widget() has been called at least once.

Note: Added in QGIS 2.18

Definition at line 67 of file qgsrelationwidgetwrapper.cpp.

◆ setShowLinkButton()

void QgsRelationWidgetWrapper::setShowLinkButton ( bool showLinkButton )

Determines if the "link feature" button should be shown.

Note: Added in QGIS 2.18

Definition at line 125 of file qgsrelationwidgetwrapper.cpp.

◆ setShowUnlinkButton()

void QgsRelationWidgetWrapper::setShowUnlinkButton ( bool showUnlinkButton )

Determines if the "unlink feature" button should be shown.

Note: Added in QGIS 2.18

Definition at line 53 of file qgsrelationwidgetwrapper.cpp.

◆ setVisible

void QgsRelationWidgetWrapper::setVisible ( bool visible )

slot

Sets the visibility of the wrapper's widget.

Parameters

visible set to true to show widget, false to hide widget

Note: added in QGIS 2.16

Definition at line 42 of file qgsrelationwidgetwrapper.cpp.

◆ showLabel()

bool QgsRelationWidgetWrapper::showLabel ( ) const

Defines if a title lable should be shown for this widget.

Only has an effect after widget() has been called at least once.

Note: Added in QGIS 2.18

Definition at line 59 of file qgsrelationwidgetwrapper.cpp.

◆ showLinkButton()

bool QgsRelationWidgetWrapper::showLinkButton ( ) const

Determines if the "link feature" button should be shown.

Note: Added in QGIS 2.18

Definition at line 120 of file qgsrelationwidgetwrapper.cpp.

◆ showUnlinkButton()

bool QgsRelationWidgetWrapper::showUnlinkButton ( ) const

Determines if the "unlink feature" button should be shown.

Note: Added in QGIS 2.18

Definition at line 48 of file qgsrelationwidgetwrapper.cpp.

◆ valid()

bool QgsRelationWidgetWrapper::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 115 of file qgsrelationwidgetwrapper.cpp.

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

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

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRelationWidgetWrapper()

Member Function Documentation

◆ createWidget()

◆ initWidget()

◆ setFeature

◆ setShowLabel()

◆ setShowLinkButton()

◆ setShowUnlinkButton()

◆ setVisible

◆ showLabel()

◆ showLinkButton()

◆ showUnlinkButton()

◆ valid()