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 "qgseditorwidgetconfig.h"
#include "qgsattributeeditorcontext.h"

class GUI_EXPORT QgsWidgetWrapper : public QObject
{
    Q_OBJECT
  public:
    explicit QgsWidgetWrapper( QgsVectorLayer* vl, QWidget* editor = nullptr, QWidget* parent = nullptr );

    QWidget* widget();

    template <class T>
    T* widget() { return dynamic_cast<T>( mWidget ); }

    void setConfig( const QgsEditorWidgetConfig& config );

    void setContext( const QgsAttributeEditorContext& context );

    QVariant config( const QString& key, const QVariant& defaultVal = QVariant() ) const;

    QgsEditorWidgetConfig config() const;

    const QgsAttributeEditorContext& context() const;

    QgsVectorLayer* layer() const;

    static QgsWidgetWrapper* fromWidget( QWidget* widget );

    virtual bool valid() const = 0;

  protected:
    virtual QWidget* createWidget( QWidget* parent ) = 0;

    virtual void initWidget( QWidget* editor );

  public slots:
    virtual void setFeature( const QgsFeature& feature ) = 0;

    virtual void setEnabled( bool enabled );

  private:
    QgsAttributeEditorContext mContext;
    QgsEditorWidgetConfig mConfig;
    QWidget* mWidget;
    QWidget* mParent;
    QgsVectorLayer* mLayer;
    bool mInitialized;
};

// We'll use this class inside a QVariant in the widgets properties
Q_DECLARE_METATYPE( QgsWidgetWrapper* )

#endif // QGSWIDGETWRAPPER_H