QgsAttributeEditorRelation Class Reference

This element will load a relation editor onto the form. More...

#include <qgsattributeeditorelement.h>

Inheritance diagram for QgsAttributeEditorRelation:

Public Member Functions
	QgsAttributeEditorRelation (const QString &name, const QString &relationId, QgsAttributeEditorElement *parent)
	Creates a new element which embeds a relation. More...
	QgsAttributeEditorRelation (const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent)
	Creates a new element which embeds a relation. More...
QgsAttributeEditorElement *	clone (QgsAttributeEditorElement *parent) const override
	Returns a clone of this element. More...
bool	init (QgsRelationManager *relManager)
	Initializes the relation from the id. More...
const QgsRelation &	relation () const
	Get the id of the relation which shall be embedded. 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	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 QgsAttributeEditorElement
	QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr)
	Constructor. More...
virtual	~QgsAttributeEditorElement ()=default
QString	name () const
	Return the name of this element. More...
QgsAttributeEditorElement *	parent () const
	Get the parent of this element. More...
void	setShowLabel (bool showLabel)
	Controls if this element should be labeled with a title (field, relation or groupname). More...
bool	showLabel () const
	Controls if this element should be labeled with a title (field, relation or groupname). More...
QDomElement	toDomElement (QDomDocument &doc) const
	Get the XML Dom element to save this element. More...
AttributeEditorType	type () const
	The type of this element. More...

Additional Inherited Members
Public Types inherited from QgsAttributeEditorElement
enum	AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid }
Protected Attributes inherited from QgsAttributeEditorElement
QString	mName
QgsAttributeEditorElement *	mParent = nullptr
bool	mShowLabel
AttributeEditorType	mType

Detailed Description

This element will load a relation editor onto the form.

Definition at line 315 of file qgsattributeeditorelement.h.

Constructor & Destructor Documentation

QgsAttributeEditorRelation() [1/2]

QgsAttributeEditorRelation::QgsAttributeEditorRelation ( const QString &  name, const QString &  relationId, QgsAttributeEditorElement *  parent  )

inline

Creates a new element which embeds a relation.

Parameters

name	The name of this element
relationId	The id of the relation to embed
parent	The parent (used as container)

Definition at line 326 of file qgsattributeeditorelement.h.

QgsAttributeEditorRelation() [2/2]

QgsAttributeEditorRelation::QgsAttributeEditorRelation ( const QString &  name, const QgsRelation &  relation, QgsAttributeEditorElement *  parent  )

inline

Creates a new element which embeds a relation.

Parameters

name	The name of this element
relation	The relation to embed
parent	The parent (used as container)

Definition at line 340 of file qgsattributeeditorelement.h.

Member Function Documentation

clone()

QgsAttributeEditorElement * QgsAttributeEditorRelation::clone ( QgsAttributeEditorElement *  parent ) const

overridevirtual

Returns a clone of this element.

To be implemented by subclasses.

Since

QGIS 3.0

Implements QgsAttributeEditorElement.

Definition at line 83 of file qgsattributeeditorelement.cpp.

init()

bool QgsAttributeEditorRelation::init

(

QgsRelationManager *

relManager

)

Initializes the relation from the id.

Parameters

relManager

The relation manager to use for the initialization

Returns

true if the relation was found in the relationmanager

Definition at line 77 of file qgsattributeeditorelement.cpp.

relation()

const QgsRelation& QgsAttributeEditorRelation::relation ( ) const

inline

Get the id of the relation which shall be embedded.

Returns

the id

Definition at line 353 of file qgsattributeeditorelement.h.

setShowLinkButton()

void QgsAttributeEditorRelation::setShowLinkButton

(

bool

showLinkButton

)

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

Since

QGIS 2.18

Definition at line 139 of file qgsattributeeditorelement.cpp.

setShowUnlinkButton()

void QgsAttributeEditorRelation::setShowUnlinkButton

(

bool

showUnlinkButton

)

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

Since

QGIS 2.18

Definition at line 149 of file qgsattributeeditorelement.cpp.

showLinkButton()

bool QgsAttributeEditorRelation::showLinkButton

(

)

const

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

Since

QGIS 2.18

Definition at line 134 of file qgsattributeeditorelement.cpp.

showUnlinkButton()

bool QgsAttributeEditorRelation::showUnlinkButton

(

)

const

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

Since

QGIS 2.18

Definition at line 144 of file qgsattributeeditorelement.cpp.

---

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

• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsattributeeditorelement.h
• /tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsattributeeditorelement.cpp