QGIS API Documentation  2.99.0-Master (cd0ba91)
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 % End
36 #endif
37 
50 class GUI_EXPORT QgsWidgetWrapper : public QObject
51 {
52 
53 #ifdef SIP_RUN
55  if ( qobject_cast<QgsEditorWidgetWrapper *>( sipCpp ) )
56  sipType = sipType_QgsEditorWidgetWrapper;
57  else if ( qobject_cast<QgsRelationWidgetWrapper *>( sipCpp ) )
58  sipType = sipType_QgsRelationWidgetWrapper;
59  else
60  sipType = 0;
61  SIP_END
62 #endif
63 
64  Q_OBJECT
65  public:
66 
70  enum Property
71  {
72  RootPath = 0,
73  DocumentViewerContent
74  };
75 
80  static const QgsPropertiesDefinition &propertyDefinitions();
81 
89  explicit QgsWidgetWrapper( QgsVectorLayer *vl, QWidget *editor = nullptr, QWidget *parent = nullptr );
90 
96  QWidget *widget();
97 
106  template <class T> SIP_SKIP
107  T *widget() { return dynamic_cast<T>( mWidget ); }
108 
114  void setConfig( const QVariantMap &config );
115 
121  void setContext( const QgsAttributeEditorContext &context );
122 
131  QVariant config( const QString &key, const QVariant &defaultVal = QVariant() ) const;
132 
138  QVariantMap config() const;
139 
145  const QgsAttributeEditorContext &context() const;
146 
154  QgsVectorLayer *layer() const;
155 
161  static QgsWidgetWrapper *fromWidget( QWidget *widget );
162 
174  virtual bool valid() const = 0;
175 
176 
184  QgsPropertyCollection &dataDefinedProperties() { return mPropertyCollection; } SIP_SKIP
185 
191  const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; }
192 
199  void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mPropertyCollection = collection; }
200 
201  protected:
202 
214  virtual QWidget *createWidget( QWidget *parent ) = 0;
215 
221  virtual void initWidget( QWidget *editor );
222 
225 
226  public slots:
227 
234  virtual void setFeature( const QgsFeature &feature ) = 0;
235 
242  virtual void setEnabled( bool enabled );
243 
244  private:
245  QgsAttributeEditorContext mContext;
246  QVariantMap mConfig;
247  QWidget *mWidget = nullptr;
248  QWidget *mParent = nullptr;
249  QgsVectorLayer *mLayer = nullptr;
250  bool mInitialized;
251 };
252 
253 // We'll use this class inside a QVariant in the widgets properties
255 
256 #endif // QGSWIDGETWRAPPER_H
T * widget()
Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrap...
QgsPropertyCollection & dataDefinedProperties()
Returns a reference to the editor widget&#39;s property collection, used for data defined overrides...
This class contains context information for attribute editor widgets.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:62
Q_DECLARE_METATYPE(QModelIndex)
QgsPropertyCollection mPropertyCollection
Data defined property collection.
const QgsPropertyCollection & dataDefinedProperties() const
Returns a reference to the editor widget&#39;s property collection, used for data defined overrides...
#define SIP_SKIP
Definition: qgis_sip.h:119
#define SIP_END
Definition: qgis_sip.h:175
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the editor widget&#39;s property collection, used for data defined overrides.
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:165
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
Property
Data defined properties for different editor widgets.
Represents a vector layer which manages a vector based data sets.
Manages an editor widget Widget and wrapper share the same parent.