QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
Base class to build new relation widgets. More...
#include <qgsabstractrelationeditorwidget.h>
Public Slots | |
virtual void | parentFormValueChanged (const QString &attribute, const QVariant &newValue)=0 |
Called when an attribute value in the parent widget has changed to newValue. More... | |
Signals | |
void | relatedFeaturesChanged () |
Emit this signal, whenever the related features changed. More... | |
Public Member Functions | |
QgsAbstractRelationEditorWidget (const QVariantMap &config, QWidget *parent=nullptr) | |
Constructor. More... | |
virtual QVariantMap | config () const =0 |
Returns the widget configuration. More... | |
QgsAttributeEditorContext | editorContext () const |
Returns the attribute editor context. More... | |
QgsFeature | feature () const |
Returns the widget's current feature. More... | |
bool | forceSuppressFormPopup () const |
Determines the force suppress form popup status that is configured for this widget. More... | |
Q_DECL_DEPRECATED QString | label () const |
Determines the label of this element. More... | |
QgsRelation | nmRelation () const |
Returns the nm relation. More... | |
QVariant | nmRelationId () const |
Determines the relation id of the second relation involved in an N:M relation. More... | |
QgsRelation | relation () const |
Returns the relation. More... | |
virtual void | setConfig (const QVariantMap &config)=0 |
Defines the widget configuration. More... | |
virtual void | setEditorContext (const QgsAttributeEditorContext &context) |
Sets the editor context. More... | |
void | setFeature (const QgsFeature &feature, bool update=true) |
Sets the feature being edited and updates the UI unless update is set to false . More... | |
void | setForceSuppressFormPopup (bool forceSuppressFormPopup) |
Sets force suppress form popup status with forceSuppressFormPopup configured for this widget. More... | |
void | setLabel (const QString &label=QString()) |
Sets label for this element If it's empty it takes the relation id as label. More... | |
void | setNmRelationId (const QVariant &nmRelationId=QVariant()) |
Sets nmRelationId for the relation id of the second relation involved in an N:M relation. More... | |
void | setRelationFeature (const QgsRelation &relation, const QgsFeature &feature) |
Sets the relation and the feature. More... | |
void | setRelations (const QgsRelation &relation, const QgsRelation &nmrelation) |
Sets the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required. More... | |
Q_DECL_DEPRECATED void | setShowLabel (bool showLabel) |
Defines if a title label should be shown for this widget. More... | |
Q_DECL_DEPRECATED bool | showLabel () const |
Defines if a title label should be shown for this widget. More... | |
Protected Slots | |
void | addFeature (const QgsGeometry &geometry=QgsGeometry()) |
Adds a new feature with given geometry. More... | |
void | deleteFeature (QgsFeatureId fid=QgsFeatureId()) |
Delete a feature with given fid. More... | |
void | duplicateFeature (const QgsFeatureId &fid) |
Duplicates a feature. More... | |
void | duplicateFeatures (const QgsFeatureIds &fids) |
Duplicates features. More... | |
void | linkFeature () |
Links a new feature to the relation. More... | |
void | onLinkFeatureDlgAccepted () |
Called when the link feature dialog is confirmed by the user. More... | |
void | saveEdits () |
Saves the current modifications in the relation. More... | |
void | toggleEditing (bool state) |
Toggles editing state of the widget. More... | |
void | unlinkFeature (QgsFeatureId fid=QgsFeatureId()) |
Unlinks a feature with given fid. More... | |
Protected Member Functions | |
virtual void | afterSetRelationFeature () |
A hook called right after setRelationFeature() is executed, but before updateUi() is called. More... | |
virtual void | afterSetRelations () |
A hook called right after setRelations() is executed, but before updateUi() is called. More... | |
virtual void | beforeSetRelationFeature (const QgsRelation &newRelation, const QgsFeature &newFeature) |
A hook called right before setRelationFeature() is executed. More... | |
virtual void | beforeSetRelations (const QgsRelation &newRelation, const QgsRelation &newNmRelation) |
A hook called right before setRelations() is executed. More... | |
void | deleteFeatures (const QgsFeatureIds &fids) |
Deletes the features with fids. More... | |
virtual Q_DECL_DEPRECATED void | setTitle (const QString &title) |
Sets the title of the widget, if it is wrapped within a QgsCollapsibleGroupBox. More... | |
void | showEvent (QShowEvent *) |
Refresh the UI when the widget becomes visible. More... | |
void | unlinkFeatures (const QgsFeatureIds &fids) |
Unlinks the features with fids. More... | |
Q_DECL_DEPRECATED void | updateTitle () |
Updates the title contents to reflect the current state of the widget. More... | |
virtual void | updateUi () |
A hook called every time the state of the relation editor widget has changed via calling its set* methods or slots, e.g. More... | |
Protected Attributes | |
QgsAttributeEditorContext | mEditorContext |
QgsFeature | mFeature |
bool | mForceSuppressFormPopup = false |
bool | mLayerInSameTransactionGroup = false |
QgsRelation | mNmRelation |
QgsRelation | mRelation |
Base class to build new relation widgets.
Definition at line 45 of file qgsabstractrelationeditorwidget.h.
QgsAbstractRelationEditorWidget::QgsAbstractRelationEditorWidget | ( | const QVariantMap & | config, |
QWidget * | parent = nullptr |
||
) |
Constructor.
Definition at line 35 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Adds a new feature with given geometry.
Definition at line 190 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
A hook called right after setRelationFeature() is executed, but before updateUi() is called.
Used to update the UI once setting the relation feature is done. Check QgsRealationEditorWidget as an example.
Reimplemented in QgsRelationEditorWidget.
Definition at line 609 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
A hook called right after setRelations() is executed, but before updateUi() is called.
Used to update the UI once setting the relations is done. Check QgsRealationEditorWidget as an example.
Reimplemented in QgsRelationEditorWidget.
Definition at line 618 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
A hook called right before setRelationFeature() is executed.
Used to update the UI once setting the relation feature is done. Check QgsRealationEditorWidget as an example.
Reimplemented in QgsRelationEditorWidget.
Definition at line 603 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
A hook called right before setRelations() is executed.
Used to manipulate UI once setting the relations is done. Check QgsRealationEditorWidget as an example.
Reimplemented in QgsRelationEditorWidget.
Definition at line 612 of file qgsabstractrelationeditorwidget.cpp.
|
pure virtual |
Returns the widget configuration.
Implemented in QgsRelationEditorWidget.
|
protectedslot |
Delete a feature with given fid.
Definition at line 255 of file qgsabstractrelationeditorwidget.cpp.
|
protected |
Deletes the features with fids.
Definition at line 262 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Duplicates a feature.
Definition at line 621 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Duplicates features.
Definition at line 628 of file qgsabstractrelationeditorwidget.cpp.
QgsAttributeEditorContext QgsAbstractRelationEditorWidget::editorContext | ( | ) | const |
Returns the attribute editor context.
Definition at line 99 of file qgsabstractrelationeditorwidget.cpp.
QgsFeature QgsAbstractRelationEditorWidget::feature | ( | ) | const |
Returns the widget's current feature.
Definition at line 162 of file qgsabstractrelationeditorwidget.cpp.
bool QgsAbstractRelationEditorWidget::forceSuppressFormPopup | ( | ) | const |
Determines the force suppress form popup status that is configured for this widget.
Definition at line 153 of file qgsabstractrelationeditorwidget.cpp.
QString QgsAbstractRelationEditorWidget::label | ( | ) | const |
Determines the label of this element.
Definition at line 128 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Links a new feature to the relation.
Definition at line 381 of file qgsabstractrelationeditorwidget.cpp.
|
inline |
Returns the nm relation.
Definition at line 93 of file qgsabstractrelationeditorwidget.h.
QVariant QgsAbstractRelationEditorWidget::nmRelationId | ( | ) | const |
Determines the relation id of the second relation involved in an N:M relation.
Definition at line 123 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Called when the link feature dialog is confirmed by the user.
Definition at line 405 of file qgsabstractrelationeditorwidget.cpp.
|
pure virtualslot |
Called when an attribute value in the parent widget has changed to newValue.
|
signal |
Emit this signal, whenever the related features changed.
This happens for example when related features are added, removed, linked or unlinked.
|
inline |
Returns the relation.
Definition at line 87 of file qgsabstractrelationeditorwidget.h.
|
protectedslot |
Saves the current modifications in the relation.
Definition at line 183 of file qgsabstractrelationeditorwidget.cpp.
|
pure virtual |
Defines the widget configuration.
Implemented in QgsRelationEditorWidget.
|
virtual |
Sets the editor context.
Reimplemented in QgsRelationEditorWidget.
Definition at line 94 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setFeature | ( | const QgsFeature & | feature, |
bool | update = true |
||
) |
Sets the feature being edited and updates the UI unless update is set to false
.
Definition at line 104 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setForceSuppressFormPopup | ( | bool | forceSuppressFormPopup | ) |
Sets force suppress form popup status with forceSuppressFormPopup configured for this widget.
Definition at line 148 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setLabel | ( | const QString & | label = QString() | ) |
Sets label for this element If it's empty it takes the relation id as label.
Definition at line 133 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setNmRelationId | ( | const QVariant & | nmRelationId = QVariant() | ) |
Sets nmRelationId for the relation id of the second relation involved in an N:M relation.
If it's empty, then it's considered as a 1:M relationship.
Definition at line 114 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setRelationFeature | ( | const QgsRelation & | relation, |
const QgsFeature & | feature | ||
) |
Sets the relation and the feature.
Definition at line 41 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setRelations | ( | const QgsRelation & | relation, |
const QgsRelation & | nmrelation | ||
) |
Sets the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required.
relation | Relation referencing the edited table |
nmrelation | Optional reference from the referencing table to a 3rd N:M table |
Definition at line 54 of file qgsabstractrelationeditorwidget.cpp.
void QgsAbstractRelationEditorWidget::setShowLabel | ( | bool | showLabel | ) |
Defines if a title label should be shown for this widget.
Definition at line 143 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
Sets the title of the widget, if it is wrapped within a QgsCollapsibleGroupBox.
Definition at line 598 of file qgsabstractrelationeditorwidget.cpp.
|
protected |
Refresh the UI when the widget becomes visible.
Definition at line 643 of file qgsabstractrelationeditorwidget.cpp.
bool QgsAbstractRelationEditorWidget::showLabel | ( | ) | const |
Defines if a title label should be shown for this widget.
Definition at line 138 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Toggles editing state of the widget.
Definition at line 167 of file qgsabstractrelationeditorwidget.cpp.
|
protectedslot |
Unlinks a feature with given fid.
Definition at line 506 of file qgsabstractrelationeditorwidget.cpp.
|
protected |
Unlinks the features with fids.
Definition at line 511 of file qgsabstractrelationeditorwidget.cpp.
|
protected |
Updates the title contents to reflect the current state of the widget.
Definition at line 158 of file qgsabstractrelationeditorwidget.cpp.
|
protectedvirtual |
A hook called every time the state of the relation editor widget has changed via calling its set*
methods or slots, e.g.
changed relation, added feature, etc. Should be used to refresh the UI regarding the new data. Check QgsRealationEditorWidget as an example.
Reimplemented in QgsRelationEditorWidget.
Definition at line 595 of file qgsabstractrelationeditorwidget.cpp.
|
protected |
Definition at line 240 of file qgsabstractrelationeditorwidget.h.
|
protected |
Definition at line 243 of file qgsabstractrelationeditorwidget.h.
|
protected |
Definition at line 247 of file qgsabstractrelationeditorwidget.h.
|
protected |
Definition at line 245 of file qgsabstractrelationeditorwidget.h.
|
protected |
Definition at line 242 of file qgsabstractrelationeditorwidget.h.
|
protected |
Definition at line 241 of file qgsabstractrelationeditorwidget.h.