QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsAttributeEditorRelation Class Reference

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

#include <qgseditformconfig.h>

Inheritance diagram for QgsAttributeEditorRelation:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeEditorRelation (const QString &name, const QString &relationId, QObject *parent)
 Creates a new element which embeds a relation. More...
 
 QgsAttributeEditorRelation (const QString &name, const QgsRelation &relation, QObject *parent)
 Creates a new element which embeds a relation. More...
 
virtual ~QgsAttributeEditorRelation ()
 Destructor. 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, QObject *parent=nullptr)
 Constructor. More...
 
virtual ~QgsAttributeEditorElement ()
 Destructor. More...
 
QString name () const
 Return the name 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...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Additional Inherited Members

- Public Types inherited from QgsAttributeEditorElement
enum  AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid }
 
- 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)
 
- 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from QgsAttributeEditorElement
QString mName
 
bool mShowLabel
 
AttributeEditorType mType
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This element will load a relation editor onto the form.

Definition at line 264 of file qgseditformconfig.h.

Constructor & Destructor Documentation

◆ QgsAttributeEditorRelation() [1/2]

QgsAttributeEditorRelation::QgsAttributeEditorRelation ( const QString name,
const QString relationId,
QObject 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 276 of file qgseditformconfig.h.

◆ QgsAttributeEditorRelation() [2/2]

QgsAttributeEditorRelation::QgsAttributeEditorRelation ( const QString name,
const QgsRelation relation,
QObject 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 290 of file qgseditformconfig.h.

◆ ~QgsAttributeEditorRelation()

virtual QgsAttributeEditorRelation::~QgsAttributeEditorRelation ( )
inlinevirtual

Destructor.

Definition at line 299 of file qgseditformconfig.h.

Member Function Documentation

◆ 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 624 of file qgseditformconfig.cpp.

◆ relation()

const QgsRelation& QgsAttributeEditorRelation::relation ( ) const
inline

Get the id of the relation which shall be embedded.

Returns
the id

Definition at line 306 of file qgseditformconfig.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 635 of file qgseditformconfig.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 619 of file qgseditformconfig.cpp.

◆ showLinkButton()

bool QgsAttributeEditorRelation::showLinkButton ( ) const

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

Note
Added in QGIS 2.18

Definition at line 630 of file qgseditformconfig.cpp.

◆ showUnlinkButton()

bool QgsAttributeEditorRelation::showUnlinkButton ( ) const

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

Note
Added in QGIS 2.18

Definition at line 614 of file qgseditformconfig.cpp.


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