QGIS API Documentation  2.99.0-Master (6a61179)
Public Member Functions | List of all members
QgsAttributeEditorRelation Class Reference

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

#include <qgsattributeeditorelement.h>

Inheritance diagram for QgsAttributeEditorRelation:
Inheritance graph
[legend]

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...
 
virtual ~QgsAttributeEditorRelation ()
 Destructor. More...
 
virtual QgsAttributeEditorElementclone (QgsAttributeEditorElement *parent) const override
 Returns a clone of this element. More...
 
bool init (QgsRelationManager *relManager)
 Initializes the relation from the id. More...
 
const QgsRelationrelation () 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 ()
 Destructor. More...
 
QString name () const
 Return the name of this element. More...
 
QgsAttributeEditorElementparent () 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
 
QgsAttributeEditorElementmParent
 
bool mShowLabel
 
AttributeEditorType mType
 

Detailed Description

This element will load a relation editor onto the form.

Definition at line 292 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
nameThe name of this element
relationIdThe id of the relation to embed
parentThe parent (used as container)

Definition at line 303 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
nameThe name of this element
relationThe relation to embed
parentThe parent (used as container)

Definition at line 317 of file qgsattributeeditorelement.h.

§ ~QgsAttributeEditorRelation()

virtual QgsAttributeEditorRelation::~QgsAttributeEditorRelation ( )
inlinevirtual

Destructor.

Definition at line 326 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.

Note
Added in 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
relManagerThe 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 333 of file qgsattributeeditorelement.h.

§ setShowLinkButton()

void QgsAttributeEditorRelation::setShowLinkButton ( bool  showLinkButton)

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

Note
Added in 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.

Note
Added in 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.

Note
Added in 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.

Note
Added in QGIS 2.18

Definition at line 144 of file qgsattributeeditorelement.cpp.


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