QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
#include <qgsrelationwidgetwrapper.h>
Public Slots | |
void | setFeature (const QgsFeature &feature) override |
void | setMultiEditFeatureIds (const QgsFeatureIds &fids) |
Set multiple feature to edit simultaneously. | |
void | setVisible (bool visible) |
Sets the visibility of the wrapper's widget. | |
Public Slots inherited from QgsWidgetWrapper | |
virtual void | setEnabled (bool enabled) |
Is used to enable or disable the edit functionality of the managed widget. | |
virtual void | setFeature (const QgsFeature &feature)=0 |
Is called when the value of the widget needs to be changed. | |
Signals | |
void | relatedFeaturesChanged () |
Emit this signal, whenever the related features changed. | |
Signals inherited from QgsWidgetWrapper | |
void | contextChanged () |
Signal when QgsAttributeEditorContext mContext changed. | |
Public Member Functions | |
QgsRelationWidgetWrapper (const QString &relationEditorName, QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Constructor for QgsRelationWidgetWrapper. | |
QgsRelationWidgetWrapper (QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Constructor for QgsRelationWidgetWrapper. | |
bool | forceSuppressFormPopup () const |
Determines the force suppress form popup status that is configured for this widget. | |
Q_DECL_DEPRECATED QString | label () const |
Determines the label of this element. | |
QVariant | nmRelationId () const |
Determines the relation id of the second relation involved in an N:M relation. | |
QgsRelation | relation () const |
The relation for which this wrapper is created. | |
void | setForceSuppressFormPopup (bool forceSuppressFormPopup) |
Sets force suppress form popup status to forceSuppressFormPopup for this widget and for the vectorLayerTools (if true ). | |
Q_DECL_DEPRECATED void | setLabel (const QString &label=QString()) |
Sets label for this element If it's empty it takes the relation id as label. | |
void | setNmRelationId (const QVariant &nmRelationId=QVariant()) |
Sets nmRelationId for the relation id of the second relation involved in an N:M relation. | |
Q_DECL_DEPRECATED void | setShowLabel (bool showLabel) |
Defines if a title label should be shown for this widget. | |
Q_DECL_DEPRECATED void | setShowLinkButton (bool showLinkButton) |
Determines if the "link feature" button should be shown. | |
Q_DECL_DEPRECATED void | setShowSaveChildEditsButton (bool showChildEdits) |
Determines if the "Save child layer edits" button should be shown. | |
Q_DECL_DEPRECATED void | setShowUnlinkButton (bool showUnlinkButton) |
Determines if the "unlink feature" button should be shown. | |
Q_DECL_DEPRECATED void | setVisibleButtons (const QgsAttributeEditorRelation::Buttons &buttons) |
Defines the buttons which are shown. | |
void | setWidgetConfig (const QVariantMap &config) |
Will set the config of this widget wrapper to the specified config. | |
Q_DECL_DEPRECATED bool | showLabel () const |
Defines if a title label should be shown for this widget. | |
Q_DECL_DEPRECATED bool | showLinkButton () const |
Determines if the "link feature" button should be shown. | |
Q_DECL_DEPRECATED bool | showSaveChildEditsButton () const |
Determines if the "Save child layer edits" button should be shown. | |
Q_DECL_DEPRECATED bool | showUnlinkButton () const |
Determines if the "unlink feature" button should be shown. | |
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons | visibleButtons () const |
Returns the buttons which are shown. | |
QVariantMap | widgetConfig () const |
Returns the whole widget config. | |
void | widgetValueChanged (const QString &attribute, const QVariant &newValue, bool attributeChanged) |
Will be called when a value in the current edited form or table row changes. | |
Public Member Functions inherited from QgsWidgetWrapper | |
QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Create a new widget wrapper. | |
QVariantMap | config () const |
Returns the whole config. | |
QVariant | config (const QString &key, const QVariant &defaultVal=QVariant()) const |
Use this inside your overridden classes to access the configuration. | |
const QgsAttributeEditorContext & | context () const |
Returns information about the context in which this widget is shown. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the editor widget's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the editor widget's property collection, used for data defined overrides. | |
QgsVectorLayer * | layer () const |
Returns the vector layer associated with the widget. | |
void | notifyAboutToSave () |
Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost. | |
void | setConfig (const QVariantMap &config) |
Will set the config of this wrapper to the specified config. | |
void | setContext (const QgsAttributeEditorContext &context) |
Set the context in which this widget is shown. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the editor widget's property collection, used for data defined overrides. | |
QWidget * | widget () |
Access the widget managed by this wrapper. | |
template<class T > | |
T * | widget () |
Access the widget managed by this wrapper and cast it to a given type. | |
Protected Member Functions | |
QWidget * | createWidget (QWidget *parent) override |
This method should create a new widget with the provided parent. | |
void | initWidget (QWidget *editor) override |
This method should initialize the editor widget with runtime data. | |
bool | valid () const override |
Returns true if the widget has been properly initialized. | |
Additional Inherited Members | |
Public Types inherited from QgsWidgetWrapper | |
enum class | Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl } |
Data defined properties for different editor widgets. More... | |
Static Public Member Functions inherited from QgsWidgetWrapper | |
static QgsWidgetWrapper * | fromWidget (QWidget *widget) |
Will return a wrapper for a given widget. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the editor widget property definitions. | |
Protected Attributes inherited from QgsWidgetWrapper | |
QgsPropertyCollection | mPropertyCollection |
Data defined property collection. | |
Definition at line 32 of file qgsrelationwidgetwrapper.h.
QgsRelationWidgetWrapper::QgsRelationWidgetWrapper | ( | QgsVectorLayer * | vl, |
const QgsRelation & | relation, | ||
QWidget * | editor = nullptr , |
||
QWidget * | parent = nullptr |
||
) |
Constructor for QgsRelationWidgetWrapper.
Definition at line 27 of file qgsrelationwidgetwrapper.cpp.
QgsRelationWidgetWrapper::QgsRelationWidgetWrapper | ( | const QString & | relationEditorName, |
QgsVectorLayer * | vl, | ||
const QgsRelation & | relation, | ||
QWidget * | editor = nullptr , |
||
QWidget * | parent = nullptr |
||
) |
Constructor for QgsRelationWidgetWrapper.
Definition at line 32 of file qgsrelationwidgetwrapper.cpp.
|
overrideprotectedvirtual |
This method should create a new widget with the provided parent.
This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialization stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget().
parent | You should set this parent on the created widget. |
Implements QgsWidgetWrapper.
Definition at line 39 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::forceSuppressFormPopup | ( | ) | const |
Determines the force suppress form popup status that is configured for this widget.
Definition at line 263 of file qgsrelationwidgetwrapper.cpp.
|
overrideprotectedvirtual |
This method should initialize the editor widget with runtime data.
Fill your comboboxes here.
editor | The widget which will represent this attribute editor in a form. |
Reimplemented from QgsWidgetWrapper.
Definition at line 157 of file qgsrelationwidgetwrapper.cpp.
QString QgsRelationWidgetWrapper::label | ( | ) | const |
Determines the label of this element.
Definition at line 307 of file qgsrelationwidgetwrapper.cpp.
QVariant QgsRelationWidgetWrapper::nmRelationId | ( | ) | const |
Determines the relation id of the second relation involved in an N:M relation.
Definition at line 294 of file qgsrelationwidgetwrapper.cpp.
|
signal |
Emit this signal, whenever the related features changed.
This happens for example when related features are added, removed, linked or unlinked.
QgsRelation QgsRelationWidgetWrapper::relation | ( | ) | const |
The relation for which this wrapper is created.
Definition at line 104 of file qgsrelationwidgetwrapper.cpp.
|
overrideslot |
Definition at line 58 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setForceSuppressFormPopup | ( | bool | forceSuppressFormPopup | ) |
Sets force suppress form popup status to forceSuppressFormPopup for this widget and for the vectorLayerTools (if true
).
This flag will override the layer and general settings regarding the automatic opening of the attribute form dialog when digitizing is completed.
Definition at line 253 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setLabel | ( | const QString & | label = QString() | ) |
Sets label for this element If it's empty it takes the relation id as label.
Definition at line 302 of file qgsrelationwidgetwrapper.cpp.
|
slot |
Set multiple feature to edit simultaneously.
fids | Multiple Id of features to edit |
Definition at line 64 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::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 271 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowLabel | ( | bool | showLabel | ) |
Defines if a title label should be shown for this widget.
Only has an effect after widget() has been called at least once.
Definition at line 152 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowLinkButton | ( | bool | showLinkButton | ) |
Determines if the "link feature" button should be shown.
Definition at line 224 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowSaveChildEditsButton | ( | bool | showChildEdits | ) |
Determines if the "Save child layer edits" button should be shown.
Definition at line 140 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowUnlinkButton | ( | bool | showUnlinkButton | ) |
Determines if the "unlink feature" button should be shown.
Definition at line 133 of file qgsrelationwidgetwrapper.cpp.
|
slot |
Sets the visibility of the wrapper's widget.
visible | set to true to show widget, false to hide widget |
Definition at line 70 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setVisibleButtons | ( | const QgsAttributeEditorRelation::Buttons & | buttons | ) |
Defines the buttons which are shown.
Definition at line 238 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setWidgetConfig | ( | const QVariantMap & | config | ) |
Will set the config of this widget wrapper to the specified config.
config | The config for this wrapper |
Definition at line 312 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showLabel | ( | ) | const |
Defines if a title label should be shown for this widget.
Only has an effect after widget() has been called at least once.
Definition at line 147 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showLinkButton | ( | ) | const |
Determines if the "link feature" button should be shown.
Definition at line 217 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showSaveChildEditsButton | ( | ) | const |
Determines if the "Save child layer edits" button should be shown.
Definition at line 231 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showUnlinkButton | ( | ) | const |
Determines if the "unlink feature" button should be shown.
Definition at line 126 of file qgsrelationwidgetwrapper.cpp.
|
overrideprotectedvirtual |
Returns true
if the widget has been properly initialized.
This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint to the caller that he may try to find another suitable widget type instead.
Implements QgsWidgetWrapper.
Definition at line 212 of file qgsrelationwidgetwrapper.cpp.
QgsAttributeEditorRelation::Buttons QgsRelationWidgetWrapper::visibleButtons | ( | ) | const |
Returns the buttons which are shown.
Definition at line 248 of file qgsrelationwidgetwrapper.cpp.
QVariantMap QgsRelationWidgetWrapper::widgetConfig | ( | ) | const |
Returns the whole widget config.
Definition at line 318 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::widgetValueChanged | ( | const QString & | attribute, |
const QVariant & | newValue, | ||
bool | attributeChanged | ||
) |
Will be called when a value in the current edited form or table row changes.
Forward the signal to the embedded form
attribute | The name of the attribute that changed. |
newValue | The new value of the attribute. |
attributeChanged | If true , it corresponds to an actual change of the feature attribute |
Definition at line 109 of file qgsrelationwidgetwrapper.cpp.