QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsattributeeditorelement.h>
Public Member Functions | |
QgsAttributeEditorRelation (const QgsRelation &relation, QgsAttributeEditorElement *parent) | |
Creates a new element which embeds a relation. More... | |
Q_DECL_DEPRECATED | QgsAttributeEditorRelation (const QString &name, const QgsRelation &relation, QgsAttributeEditorElement *parent) |
Q_DECL_DEPRECATED | QgsAttributeEditorRelation (const QString &name, const QString &relationId, QgsAttributeEditorElement *parent) |
QgsAttributeEditorRelation (const QString &relationId, 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 |
Gets 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 | setShowSaveChildEditsButton (bool showSaveChildEditsButton) |
Determines if the "save child layer edits" 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 | showSaveChildEditsButton () const |
Returns true if the "save child layer edits" button should be shown. More... | |
bool | showUnlinkButton () const |
Determines if the "unlink feature" button should be shown. More... | |
![]() | |
QgsAttributeEditorElement (AttributeEditorType type, const QString &name, QgsAttributeEditorElement *parent=nullptr) | |
Constructor. More... | |
virtual | ~QgsAttributeEditorElement ()=default |
QString | name () const |
Returns the name of this element. More... | |
QgsAttributeEditorElement * | parent () const |
Gets 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 |
Gets the XML Dom element to save this element. More... | |
AttributeEditorType | type () const |
The type of this element. More... | |
Additional Inherited Members | |
![]() | |
enum | AttributeEditorType { AeTypeContainer, AeTypeField, AeTypeRelation, AeTypeInvalid, AeTypeQmlElement, AeTypeHtmlElement } |
![]() | |
QString | mName |
QgsAttributeEditorElement * | mParent = nullptr |
bool | mShowLabel |
AttributeEditorType | mType |
This element will load a relation editor onto the form.
Definition at line 333 of file qgsattributeeditorelement.h.
|
inline |
The name parameter is not used for anything and overwritten by the relationId internally.
Definition at line 340 of file qgsattributeeditorelement.h.
|
inline |
The name parameter is not used for anything and overwritten by the relationId internally.
Definition at line 348 of file qgsattributeeditorelement.h.
|
inline |
Creates a new element which embeds a relation.
relationId | The id of the relation to embed |
parent | The parent (used as container) |
Definition at line 360 of file qgsattributeeditorelement.h.
|
inline |
Creates a new element which embeds a relation.
relation | The relation to embed |
parent | The parent (used as container) |
Definition at line 371 of file qgsattributeeditorelement.h.
|
overridevirtual |
Returns a clone of this element.
To be implemented by subclasses.
Implements QgsAttributeEditorElement.
Definition at line 95 of file qgsattributeeditorelement.cpp.
bool QgsAttributeEditorRelation::init | ( | QgsRelationManager * | relManager | ) |
Initializes the relation from the id.
relManager | The relation manager to use for the initialization |
true
if the relation was found in the relationmanager Definition at line 89 of file qgsattributeeditorelement.cpp.
|
inline |
Gets the id of the relation which shall be embedded.
Definition at line 383 of file qgsattributeeditorelement.h.
void QgsAttributeEditorRelation::setShowLinkButton | ( | bool | showLinkButton | ) |
Determines if the "link feature" button should be shown.
Definition at line 151 of file qgsattributeeditorelement.cpp.
void QgsAttributeEditorRelation::setShowSaveChildEditsButton | ( | bool | showSaveChildEditsButton | ) |
Determines if the "save child layer edits" button should be shown.
Definition at line 166 of file qgsattributeeditorelement.cpp.
void QgsAttributeEditorRelation::setShowUnlinkButton | ( | bool | showUnlinkButton | ) |
Determines if the "unlink feature" button should be shown.
Definition at line 161 of file qgsattributeeditorelement.cpp.
bool QgsAttributeEditorRelation::showLinkButton | ( | ) | const |
Determines if the "link feature" button should be shown.
Definition at line 146 of file qgsattributeeditorelement.cpp.
bool QgsAttributeEditorRelation::showSaveChildEditsButton | ( | ) | const |
Returns true
if the "save child layer edits" button should be shown.
Definition at line 171 of file qgsattributeeditorelement.cpp.
bool QgsAttributeEditorRelation::showUnlinkButton | ( | ) | const |
Determines if the "unlink feature" button should be shown.
Definition at line 156 of file qgsattributeeditorelement.cpp.