qgseditorwidgetregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgseditorwidgetregistry.h
     --------------------------------------
    Date                 : 24.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 QGSEDITORWIDGETREGISTRY_H
#define QGSEDITORWIDGETREGISTRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsattributeeditorcontext.h"
#include "qgseditorwidgetautoconf.h"
#include "qgseditorwidgetfactory.h"
 
#include <QMap>
#include <QObject>
 
class QgsMapLayer;
class QDomNode;
class QgsMapCanvas;
class QgsMessageBar;
class QgsSearchWidgetWrapper;
class QgsEditorWidgetWrapper;
class QgsEditorConfigWidget;
class QgsVectorLayer;
 

class GUI_EXPORT QgsEditorWidgetRegistry : public QObject
{
    Q_OBJECT
 
  public:
    QgsEditorWidgetRegistry();

    void initEditors( QgsMapCanvas *mapCanvas = nullptr, QgsMessageBar *messageBar = nullptr );

    ~QgsEditorWidgetRegistry() override;

    QgsEditorWidgetSetup findBest( const QgsVectorLayer *vl, const QString &fieldName ) const;

    QgsEditorWidgetWrapper *create(
      const QString &widgetId,
      QgsVectorLayer *vl,
      int fieldIdx,
      const QVariantMap &config,
      QWidget *editor,
      QWidget *parent SIP_TRANSFERTHIS,
      const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext()
    ) SIP_FACTORY;

    // clang-format off
    QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent SIP_TRANSFERTHIS, const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext() ) SIP_FACTORY;
    // clang-format on
 
    QgsSearchWidgetWrapper *createSearchWidget(
      const QString &widgetId,
      QgsVectorLayer *vl,
      int fieldIdx,
      const QVariantMap &config,
      QWidget *parent SIP_TRANSFERTHIS,
      const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext()
    ) SIP_FACTORY;

    QgsEditorConfigWidget *createConfigWidget( const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, QWidget *parent SIP_TRANSFERTHIS ) SIP_FACTORY;

    QString name( const QString &widgetId );

    QIcon icon( const QString &widgetId );

    bool isReadOnly( const QString &widgetId );

    QMap<QString, QgsEditorWidgetFactory *> factories();

    QgsEditorWidgetFactory *factory( const QString &widgetId );

    bool registerWidget( const QString &widgetId, QgsEditorWidgetFactory *widgetFactory SIP_TRANSFER );

    void registerAutoConfPlugin( QgsEditorWidgetAutoConfPlugin *plugin ) { mAutoConf.registerPlugin( plugin ); }
 
  private:
    QString findSuitableWrapper( QWidget *editor, const QString &defaultWidget );
 
    QMap<QString, QgsEditorWidgetFactory *> mWidgetFactories;
    QMap<const char *, QPair<int, QString>> mFactoriesByType;
    QgsEditorWidgetAutoConf mAutoConf;
    std::unique_ptr<QgsEditorWidgetFactory> mFallbackWidgetFactory = nullptr;
};
 
#endif // QGSEDITORWIDGETREGISTRY_H