qgseditorwidgetfactory.h

Go to the documentation of this file.

/***************************************************************************
    qgseditorwidgetfactory.h
     --------------------------------------
    Date                 : 21.4.2013
    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 QGSEDITORWIDGETFACTORY_H
#define QGSEDITORWIDGETFACTORY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QDomNode>
#include <QIcon>
#include <QMap>
#include <QString>
#include <QVariant>
 
class QgsEditorConfigWidget;
class QgsEditorWidgetWrapper;
class QgsVectorLayer;
class QWidget;
class QgsSearchWidgetWrapper;

class GUI_EXPORT QgsEditorWidgetFactory
{
  public:

    QgsEditorWidgetFactory( const QString &name, const QIcon &icon = QIcon() );
 
    virtual ~QgsEditorWidgetFactory() = default;

    virtual QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const = 0 SIP_FACTORY;
 
    virtual QgsSearchWidgetWrapper *createSearchWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const SIP_FACTORY;

    QString name() const;

    QIcon icon() const;

    virtual bool isReadOnly() const { return false; }

    virtual QgsEditorConfigWidget *configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const = 0 SIP_FACTORY;

    inline bool supportsField( const QgsVectorLayer *vl, int fieldIdx ) const { return fieldScore( vl, fieldIdx ) > 0; }

    virtual QHash<const char *, int> supportedWidgetTypes() SIP_SKIP
    {
      return QHash<const char *, int>();
    }

    virtual unsigned int fieldScore( const QgsVectorLayer *vl, int fieldIdx ) const;
 
  private:
    QString mName;
    QIcon mIcon;
};
 
#endif // QGSEDITORWIDGETFACTORY_H