qgswidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
    qgswidgetwrapper.h
     --------------------------------------
    Date                 : 14.5.2014
    Copyright            : (C) 2013 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSWIDGETWRAPPER_H
#define QGSWIDGETWRAPPER_H
 
#include <QObject>
#include <QMap>
#include <QVariant>
 
class QgsVectorLayer;
 
#include "qgsattributeeditorcontext.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgspropertycollection.h"
 
#ifdef SIP_RUN
// This is required for the ConvertToSubClassCode to work properly
// so RTTI for casting is available in the whole module.
% ModuleCode
#include "qgsrelationwidgetwrapper.h"
#include "qgsqmlwidgetwrapper.h"
#include "qgshtmlwidgetwrapper.h"
% End
#endif
 
class GUI_EXPORT QgsWidgetWrapper : public QObject
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsEditorWidgetWrapper *>( sipCpp ) )
      sipType = sipType_QgsEditorWidgetWrapper;
    else if ( qobject_cast<QgsRelationWidgetWrapper *>( sipCpp ) )
      sipType = sipType_QgsRelationWidgetWrapper;
    else if ( qobject_cast<QgsQmlWidgetWrapper *>( sipCpp ) )
      sipType = sipType_QgsQmlWidgetWrapper;
    else if ( qobject_cast<QgsHtmlWidgetWrapper *>( sipCpp ) )
      sipType = sipType_QgsHtmlWidgetWrapper;
    else
      sipType = 0;
    SIP_END
#endif
 
    Q_OBJECT
  public:
 
    // *INDENT-OFF*
 
    enum class Property SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsWidgetWrapper, Property ) : int
    {
      RootPath = 0, 
      DocumentViewerContent, 
      StorageUrl 
    };
    // *INDENT-ON*
 
    static const QgsPropertiesDefinition &propertyDefinitions();
 
    explicit QgsWidgetWrapper( QgsVectorLayer *vl, QWidget *editor = nullptr, QWidget *parent = nullptr );
 
    QWidget *widget();
 
    template <class T> SIP_SKIP
    T *widget() { return dynamic_cast<T>( mWidget ); }
 
    void setConfig( const QVariantMap &config );
 
    void setContext( const QgsAttributeEditorContext &context );
 
    QVariant config( const QString &key, const QVariant &defaultVal = QVariant() ) const;
 
    QVariantMap config() const;
 
    const QgsAttributeEditorContext &context() const;
 
    QgsVectorLayer *layer() const;
 
    static QgsWidgetWrapper *fromWidget( QWidget *widget );
 
    virtual bool valid() const = 0;
 
 
    QgsPropertyCollection &dataDefinedProperties() { return mPropertyCollection; } SIP_SKIP
 
    const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; }
 
    void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mPropertyCollection = collection; }
 
    void notifyAboutToSave();
 
  signals:
 
    void contextChanged();
 
  protected:
 
    virtual QWidget *createWidget( QWidget *parent ) = 0;
 
    virtual void initWidget( QWidget *editor );
 
    QgsPropertyCollection mPropertyCollection;
 
  public slots:
 
    virtual void setFeature( const QgsFeature &feature ) = 0;
 
    virtual void setEnabled( bool enabled );
 
  private:
 
    virtual void aboutToSave();
 
    QgsAttributeEditorContext mContext;
    QVariantMap mConfig;
    QWidget *mWidget = nullptr;
    QWidget *mParent = nullptr;
    QgsVectorLayer *mLayer = nullptr;
    bool mInitialized;
};
 
// We'll use this class inside a QVariant in the widgets properties
Q_DECLARE_METATYPE( QgsWidgetWrapper * )
 
#endif // QGSWIDGETWRAPPER_H