QGIS API Documentation 3.41.0-Master (092dc69654e)
|
Wraps a QQuickWidget to display QML code. More...
#include <qgsqmlwidgetwrapper.h>
Public Slots | |
void | setFeature (const QgsFeature &feature) override |
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. | |
Public Member Functions | |
QgsQmlWidgetWrapper (QgsVectorLayer *layer, QWidget *editor, QWidget *parent) | |
Create a qml widget wrapper. | |
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. | |
void | reinitWidget () |
Clears the content and makes new initialization. | |
void | setQmlCode (const QString &qmlCode) |
writes the qmlCode into a temporary file | |
bool | valid () const override |
Returns true if the widget has been properly initialized. | |
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. | |
Additional Inherited Members | |
Public Types inherited from QgsWidgetWrapper | |
enum class | Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl } |
Data defined properties for different editor widgets. More... | |
Signals inherited from QgsWidgetWrapper | |
void | contextChanged () |
Signal when QgsAttributeEditorContext mContext changed. | |
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. | |
Wraps a QQuickWidget to display QML code.
Definition at line 30 of file qgsqmlwidgetwrapper.h.
QgsQmlWidgetWrapper::QgsQmlWidgetWrapper | ( | QgsVectorLayer * | layer, |
QWidget * | editor, | ||
QWidget * | parent | ||
) |
Create a qml widget wrapper.
layer | The layer on which the feature is |
editor | An editor widget. Can be nullptr if one should be autogenerated. |
parent | A parent widget |
Definition at line 28 of file qgsqmlwidgetwrapper.cpp.
|
overridevirtual |
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 qgsqmlwidgetwrapper.cpp.
|
overridevirtual |
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 62 of file qgsqmlwidgetwrapper.cpp.
void QgsQmlWidgetWrapper::reinitWidget | ( | ) |
Clears the content and makes new initialization.
Definition at line 82 of file qgsqmlwidgetwrapper.cpp.
|
overrideslot |
Definition at line 145 of file qgsqmlwidgetwrapper.cpp.
void QgsQmlWidgetWrapper::setQmlCode | ( | const QString & | qmlCode | ) |
writes the qmlCode into a temporary file
Definition at line 92 of file qgsqmlwidgetwrapper.cpp.
|
overridevirtual |
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 34 of file qgsqmlwidgetwrapper.cpp.