QGIS API Documentation
3.0.2-Girona (307d082)
|
This class should be subclassed for every configurable editor widget type. More...
#include <qgseditorconfigwidget.h>
Signals | |
void | changed () |
Emitted when the configuration of the widget is changed. More... | |
Public Member Functions | |
QgsEditorConfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) | |
Create a new configuration widget. More... | |
virtual QVariantMap | config ()=0 |
Create a configuration from the current GUI state. More... | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. More... | |
int | field () |
Returns the field for which this configuration widget applies. More... | |
QgsVectorLayer * | layer () |
Returns the layer for which this configuration widget applies. More... | |
virtual void | setConfig (const QVariantMap &config)=0 |
Update the configuration widget to represent the given configuration. More... | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Protected Member Functions | |
void | initializeDataDefinedButton (QgsPropertyOverrideButton *button, QgsWidgetWrapper::Property key) |
Registers a property override button, setting up its initial value, connections and description. More... | |
void | updateDataDefinedButton (QgsPropertyOverrideButton *button) |
Updates a specific property override button to reflect the widgets's current properties. More... | |
void | updateDataDefinedButtons () |
Updates all property override buttons to reflect the widgets's current properties. More... | |
Protected Attributes | |
QgsPropertyCollection | mPropertyCollection |
Temporary property collection for config widgets. More... | |
This class should be subclassed for every configurable editor widget type.
It implements the GUI configuration widget and transforms this to/from a configuration.
It will only be instantiated by {
Definition at line 38 of file qgseditorconfigwidget.h.
|
explicit |
Create a new configuration widget.
vl | The layer for which the configuration dialog will be created |
fieldIdx | The index of the field on the layer for which this dialog will be created |
parent | A parent widget |
Definition at line 19 of file qgseditorconfigwidget.cpp.
|
signal |
Emitted when the configuration of the widget is changed.
|
pure virtual |
Create a configuration from the current GUI state.
Implemented in QgsValueRelationConfigDlg, QgsExternalResourceConfigDlg, QgsDummyConfigDlg, QgsTextEditConfigDlg, QgsUniqueValuesConfigDlg, QgsCheckBoxConfigDlg, QgsValueMapConfigDlg, QgsRelationReferenceConfigDlg, QgsRangeConfigDlg, and QgsDateTimeEditConfig.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 37 of file qgseditorconfigwidget.cpp.
int QgsEditorConfigWidget::field | ( | ) |
Returns the field for which this configuration widget applies.
Definition at line 27 of file qgseditorconfigwidget.cpp.
|
protected |
Registers a property override button, setting up its initial value, connections and description.
button | button to register |
key | corresponding data defined property key |
Definition at line 42 of file qgseditorconfigwidget.cpp.
QgsVectorLayer * QgsEditorConfigWidget::layer | ( | ) |
Returns the layer for which this configuration widget applies.
Definition at line 32 of file qgseditorconfigwidget.cpp.
|
pure virtual |
Update the configuration widget to represent the given configuration.
config | The configuration which should be represented by this widget |
Implemented in QgsValueRelationConfigDlg, QgsExternalResourceConfigDlg, QgsDummyConfigDlg, QgsTextEditConfigDlg, QgsUniqueValuesConfigDlg, QgsCheckBoxConfigDlg, QgsValueMapConfigDlg, QgsRelationReferenceConfigDlg, QgsRangeConfigDlg, and QgsDateTimeEditConfig.
|
protected |
Updates a specific property override button to reflect the widgets's current properties.
Definition at line 59 of file qgseditorconfigwidget.cpp.
|
protected |
Updates all property override buttons to reflect the widgets's current properties.
Definition at line 51 of file qgseditorconfigwidget.cpp.
|
protected |
Temporary property collection for config widgets.
Definition at line 110 of file qgseditorconfigwidget.h.