QGIS API Documentation
3.0.2-Girona (307d082)
|
#include <qgsrelationwidgetwrapper.h>
Public Slots | |
void | setFeature (const QgsFeature &feature) override |
void | setVisible (bool visible) |
Sets the visibility of the wrapper's widget. More... | |
Public Slots inherited from QgsWidgetWrapper | |
virtual void | setEnabled (bool enabled) |
Is used to enable or disable the edit functionality of the managed widget. More... | |
virtual void | setFeature (const QgsFeature &feature)=0 |
Is called, when the value of the widget needs to be changed. More... | |
Public Member Functions | |
QgsRelationWidgetWrapper (QgsVectorLayer *vl, const QgsRelation &relation, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Constructor for QgsRelationWidgetWrapper. More... | |
QgsRelation | relation () const |
The relation for which this wrapper is created. More... | |
void | setShowLabel (bool showLabel) |
Defines if a title lable should be shown for this widget. More... | |
void | setShowLinkButton (bool showLinkButton) |
Determines if the "link feature" button should be shown. More... | |
void | setShowUnlinkButton (bool showUnlinkButton) |
Determines if the "unlink feature" button should be shown. More... | |
bool | showLabel () const |
Defines if a title lable should be shown for this widget. More... | |
bool | showLinkButton () const |
Determines if the "link feature" button should be shown. More... | |
bool | showUnlinkButton () const |
Determines if the "unlink feature" button should be shown. More... | |
Public Member Functions inherited from QgsWidgetWrapper | |
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... | |
QVariantMap | config () const |
Returns the whole config. More... | |
const QgsAttributeEditorContext & | context () const |
Returns information about the context in which this widget is shown. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the editor widget's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the editor widget's property collection, used for data defined overrides. More... | |
QgsVectorLayer * | layer () const |
Access the QgsVectorLayer, you are working on. More... | |
void | setConfig (const QVariantMap &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... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the editor widget's property collection, used for data defined overrides. 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... | |
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... | |
Additional Inherited Members | |
Public Types inherited from QgsWidgetWrapper | |
enum | Property { RootPath = 0, DocumentViewerContent } |
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. More... | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the editor widget property definitions. More... | |
Protected Attributes inherited from QgsWidgetWrapper | |
QgsPropertyCollection | mPropertyCollection |
Data defined property collection. More... | |
Definition at line 31 of file qgsrelationwidgetwrapper.h.
|
explicit |
Constructor for QgsRelationWidgetWrapper.
Definition at line 25 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 32 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 79 of file qgsrelationwidgetwrapper.cpp.
QgsRelation QgsRelationWidgetWrapper::relation | ( | ) | const |
The relation for which this wrapper is created.
Definition at line 49 of file qgsrelationwidgetwrapper.cpp.
|
overrideslot |
Definition at line 37 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowLabel | ( | bool | showLabel | ) |
Defines if a title lable should be shown for this widget.
Only has an effect after widget() has been called at least once.
Definition at line 73 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowLinkButton | ( | bool | showLinkButton | ) |
Determines if the "link feature" button should be shown.
Definition at line 131 of file qgsrelationwidgetwrapper.cpp.
void QgsRelationWidgetWrapper::setShowUnlinkButton | ( | bool | showUnlinkButton | ) |
Determines if the "unlink feature" button should be shown.
Definition at line 59 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 43 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showLabel | ( | ) | const |
Defines if a title lable should be shown for this widget.
Only has an effect after widget() has been called at least once.
Definition at line 65 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showLinkButton | ( | ) | const |
Determines if the "link feature" button should be shown.
Definition at line 126 of file qgsrelationwidgetwrapper.cpp.
bool QgsRelationWidgetWrapper::showUnlinkButton | ( | ) | const |
Determines if the "unlink feature" button should be shown.
Definition at line 54 of file qgsrelationwidgetwrapper.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 to the caller that he may try to find another suitable widget type instead.
Implements QgsWidgetWrapper.
Definition at line 121 of file qgsrelationwidgetwrapper.cpp.