QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgswidgetwrapper.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgswidgetwrapper.h
3  --------------------------------------
4  Date : 14.5.2014
5  Copyright : (C) 2013 Matthias Kuhn
6  Email : matthias at opengis dot ch
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSWIDGETWRAPPER_H
17 #define QGSWIDGETWRAPPER_H
18 
19 #include <QObject>
20 #include <QMap>
21 #include <QVariant>
22 
23 class QgsVectorLayer;
24 
26 #include "qgis_gui.h"
27 #include "qgis_sip.h"
28 #include "qgspropertycollection.h"
29 
30 #ifdef SIP_RUN
31 // This is required for the ConvertToSubClassCode to work properly
32 // so RTTI for casting is available in the whole module.
33 % ModuleCode
35 #include "qgsqmlwidgetwrapper.h"
36 #include "qgshtmlwidgetwrapper.h"
37 % End
38 #endif
39 
52 class GUI_EXPORT QgsWidgetWrapper : public QObject
53 {
54 
55 #ifdef SIP_RUN
57  if ( qobject_cast<QgsEditorWidgetWrapper *>( sipCpp ) )
58  sipType = sipType_QgsEditorWidgetWrapper;
59  else if ( qobject_cast<QgsRelationWidgetWrapper *>( sipCpp ) )
60  sipType = sipType_QgsRelationWidgetWrapper;
61  else if ( qobject_cast<QgsQmlWidgetWrapper *>( sipCpp ) )
62  sipType = sipType_QgsQmlWidgetWrapper;
63  else if ( qobject_cast<QgsHtmlWidgetWrapper *>( sipCpp ) )
64  sipType = sipType_QgsHtmlWidgetWrapper;
65  else
66  sipType = 0;
67  SIP_END
68 #endif
69 
70  Q_OBJECT
71  public:
72 
76  enum Property
77  {
78  RootPath = 0,
79  DocumentViewerContent
80  };
81 
86  static const QgsPropertiesDefinition &propertyDefinitions();
87 
95  explicit QgsWidgetWrapper( QgsVectorLayer *vl, QWidget *editor = nullptr, QWidget *parent = nullptr );
96 
102  QWidget *widget();
103 
115  template <class T> SIP_SKIP
116  T *widget() { return dynamic_cast<T>( mWidget ); }
117 
123  void setConfig( const QVariantMap &config );
124 
130  void setContext( const QgsAttributeEditorContext &context );
131 
140  QVariant config( const QString &key, const QVariant &defaultVal = QVariant() ) const;
141 
145  QVariantMap config() const;
146 
150  const QgsAttributeEditorContext &context() const;
151 
155  QgsVectorLayer *layer() const;
156 
162  static QgsWidgetWrapper *fromWidget( QWidget *widget );
163 
175  virtual bool valid() const = 0;
176 
177 
185  QgsPropertyCollection &dataDefinedProperties() { return mPropertyCollection; } SIP_SKIP
186 
193  const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; }
194 
202  void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mPropertyCollection = collection; }
203 
211  void notifyAboutToSave();
212 
213  signals:
214 
221 
222  protected:
223 
235  virtual QWidget *createWidget( QWidget *parent ) = 0;
236 
242  virtual void initWidget( QWidget *editor );
243 
246 
247  public slots:
248 
255  virtual void setFeature( const QgsFeature &feature ) = 0;
256 
263  virtual void setEnabled( bool enabled );
264 
265  private:
266 
273  virtual void aboutToSave();
274 
275  QgsAttributeEditorContext mContext;
276  QVariantMap mConfig;
277  QWidget *mWidget = nullptr;
278  QWidget *mParent = nullptr;
279  QgsVectorLayer *mLayer = nullptr;
280  bool mInitialized;
281 };
282 
283 // We'll use this class inside a QVariant in the widgets properties
285 
286 #endif // QGSWIDGETWRAPPER_H
QgsWidgetWrapper::setDataDefinedProperties
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the editor widget's property collection, used for data defined overrides.
Definition: qgswidgetwrapper.h:202
QgsWidgetWrapper::valid
virtual bool valid() const =0
Returns true if the widget has been properly initialized.
QgsWidgetWrapper
Manages an editor widget Widget and wrapper share the same parent.
Definition: qgswidgetwrapper.h:53
QgsWidgetWrapper::Property
Property
Data defined properties for different editor widgets.
Definition: qgswidgetwrapper.h:77
Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
QgsWidgetWrapper::contextChanged
void contextChanged()
Signal when QgsAttributeEditorContext mContext changed.
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:177
QgsPropertiesDefinition
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
Definition: qgspropertycollection.h:29
QgsWidgetWrapper::widget
T * widget()
Access the widget managed by this wrapper and cast it to a given type.
Definition: qgswidgetwrapper.h:116
qgsqmlwidgetwrapper.h
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
qgis_sip.h
qgsattributeeditorcontext.h
QgsWidgetWrapper::dataDefinedProperties
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the editor widget's property collection, used for data defined overrides.
Definition: qgswidgetwrapper.h:185
QgsPropertyCollection
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
Definition: qgspropertycollection.h:319
QgsWidgetWrapper::setFeature
virtual void setFeature(const QgsFeature &feature)=0
Is called when the value of the widget needs to be changed.
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:387
QgsWidgetWrapper::mPropertyCollection
QgsPropertyCollection mPropertyCollection
Data defined property collection.
Definition: qgswidgetwrapper.h:245
QgsWidgetWrapper::dataDefinedProperties
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the editor widget's property collection, used for data defined overrides.
Definition: qgswidgetwrapper.h:193
qgspropertycollection.h
QgsFeature
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:56
QgsAttributeEditorContext
This class contains context information for attribute editor widgets.
Definition: qgsattributeeditorcontext.h:41
qgsrelationwidgetwrapper.h
qgshtmlwidgetwrapper.h
SIP_END
#define SIP_END
Definition: qgis_sip.h:194
QgsWidgetWrapper::createWidget
virtual QWidget * createWidget(QWidget *parent)=0
This method should create a new widget with the provided parent.