QGIS API Documentation
2.18.21-Las Palmas (9fba24a)
|
Wraps a value relation widget. More...
#include <qgsvaluerelationwidgetwrapper.h>
Public Types | |
typedef QVector< ValueRelationItem > | ValueRelationCache |
typedef QPair< QVariant, QString > | ValueRelationItem |
Public Slots | |
void | setValue (const QVariant &value) override |
![]() | |
void | setFeature (const QgsFeature &feature) override |
Will be called when the feature changes. More... | |
virtual void | setValue (const QVariant &value)=0 |
Is called, when the value of the widget needs to be changed. More... | |
![]() | |
virtual void | setFeature (const QgsFeature &feature)=0 |
Is called, when the value of the widget needs to be changed. More... | |
Public Member Functions | |
QgsValueRelationWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
void | setEnabled (bool enabled) override |
Is used to enable or disable the edit functionality of the managed widget. More... | |
void | showIndeterminateState () override |
Sets the widget to display in an indeterminate "mixed value" state. More... | |
QVariant | value () const override |
Will be used to access the widget's value. More... | |
![]() | |
QgsEditorWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Create a new widget wrapper. More... | |
QVariant | defaultValue () const |
Access the default value of the field. More... | |
QgsField | field () const |
Access the field. More... | |
int | fieldIdx () const |
Access the field index. More... | |
bool | isValidConstraint () const |
Get the current constraint status. More... | |
void | updateConstraint (const QgsFeature &featureContext) |
Update constraint. More... | |
![]() | |
QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Create a new widget wrapper. More... | |
QVariant | config (const QString &key, const QVariant &defaultVal=QVariant()) const |
Use this inside your overridden classes to access the configuration. More... | |
QgsEditorWidgetConfig | config () const |
Returns the whole config. More... | |
const QgsAttributeEditorContext & | context () const |
Returns information about the context in which this widget is shown. More... | |
QgsVectorLayer * | layer () const |
Access the QgsVectorLayer, you are working on. More... | |
void | setConfig (const QgsEditorWidgetConfig &config) |
Will set the config of this wrapper to the specified config. More... | |
void | setContext (const QgsAttributeEditorContext &context) |
Set the context in which this widget is shown. More... | |
QWidget * | widget () |
Access the widget managed by this wrapper. More... | |
template<class T > | |
T * | widget () |
Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrapper->widget<QPushButton*>();. More... | |
![]() | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (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< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) 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 QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () 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) |
QThread * | thread () const |
Static Public Member Functions | |
static ValueRelationCache | createCache (const QgsEditorWidgetConfig &config) |
static bool | orderByKeyLessThan (const QgsValueRelationWidgetWrapper::ValueRelationItem &p1, const QgsValueRelationWidgetWrapper::ValueRelationItem &p2) |
static bool | orderByValueLessThan (const QgsValueRelationWidgetWrapper::ValueRelationItem &p1, const QgsValueRelationWidgetWrapper::ValueRelationItem &p2) |
![]() | |
static QgsEditorWidgetWrapper * | fromWidget (QWidget *widget) |
Will return a wrapper for a given widget. More... | |
![]() | |
static QgsWidgetWrapper * | fromWidget (QWidget *widget) |
Will return a wrapper for a given widget. More... | |
![]() | |
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 | |
QWidget * | createWidget (QWidget *parent) override |
This method should create a new widget with the provided parent. More... | |
void | initWidget (QWidget *editor) override |
This method should initialize the editor widget with runtime data. More... | |
bool | valid () const override |
Return true if the widget has been properly initialized. More... | |
![]() | |
virtual void | updateConstraintWidgetStatus (bool constraintValid) |
This should update the widget with a visual cue if a constraint status changed. More... | |
![]() | |
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 |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Friends | |
class | QgsValueRelationWidgetFactory |
class | TestQgsValueRelationWidgetWrapper |
Additional Inherited Members | |
![]() | |
void | constraintStatusChanged (const QString &constraint, const QString &desc, const QString &err, bool status) |
Emit this signal when the constraint status changed. More... | |
void | valueChanged (const QVariant &value) |
Emit this signal, whenever the value changed. More... | |
![]() | |
void | valueChanged (const QString &value) |
If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More... | |
void | valueChanged (int value) |
If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More... | |
void | valueChanged (double value) |
If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More... | |
void | valueChanged (bool value) |
If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More... | |
void | valueChanged (qlonglong value) |
If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More... | |
void | valueChanged () |
Will call the value() method to determine the emitted value. More... | |
![]() | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
![]() | |
objectName | |
Wraps a value relation widget.
This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). This is useful for having value lists on a separate layer containing codes and their translation to human readable names.
Options:
Definition at line 47 of file qgsvaluerelationwidgetwrapper.h.
Definition at line 53 of file qgsvaluerelationwidgetwrapper.h.
Definition at line 52 of file qgsvaluerelationwidgetwrapper.h.
|
explicit |
Definition at line 40 of file qgsvaluerelationwidgetwrapper.cpp.
|
static |
Definition at line 193 of file qgsvaluerelationwidgetwrapper.cpp.
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(QWidget*).
parent | You should set this parent on the created widget. |
Implements QgsWidgetWrapper.
Definition at line 92 of file qgsvaluerelationwidgetwrapper.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 107 of file qgsvaluerelationwidgetwrapper.cpp.
|
static |
Definition at line 28 of file qgsvaluerelationwidgetwrapper.cpp.
|
static |
Definition at line 34 of file qgsvaluerelationwidgetwrapper.cpp.
|
overridevirtual |
Is used to enable or disable the edit functionality of the managed widget.
By default this will enable or disable the whole widget
enabled | Enable or Disable? |
Reimplemented from QgsEditorWidgetWrapper.
Definition at line 255 of file qgsvaluerelationwidgetwrapper.cpp.
|
overrideslot |
Definition at line 163 of file qgsvaluerelationwidgetwrapper.cpp.
|
overridevirtual |
Sets the widget to display in an indeterminate "mixed value" state.
Reimplemented from QgsEditorWidgetWrapper.
Definition at line 234 of file qgsvaluerelationwidgetwrapper.cpp.
|
overrideprotectedvirtual |
Return 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 tothe caller that he may try to find another suitable widget type instead.
Implements QgsWidgetWrapper.
Definition at line 158 of file qgsvaluerelationwidgetwrapper.cpp.
|
overridevirtual |
Will be used to access the widget's value.
Read the value from the widget and return it properly formatted to be saved in the attribute.
If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.
Implements QgsEditorWidgetWrapper.
Definition at line 51 of file qgsvaluerelationwidgetwrapper.cpp.
|
friend |
Definition at line 91 of file qgsvaluerelationwidgetwrapper.h.
|
friend |
Definition at line 92 of file qgsvaluerelationwidgetwrapper.h.