QGIS API Documentation  3.23.0-Master (22c16f2067)
qgseditorwidgetautoconf.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgseditorwidgetautoconf.h
3  ---------------------
4  begin : July 2016
5  copyright : (C) 2016 by Patrick Valsecchi
6  email : patrick.valsecchi at camptocamp.com
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 #ifndef QGSEDITORWIDGETAUTOCONF_H
16 #define QGSEDITORWIDGETAUTOCONF_H
17 
18 #include <QList>
19 #include "qgis_sip.h"
20 #include "qgis_gui.h"
21 #include <memory>
22 
23 class QgsVectorLayer;
25 
33 {
34  public:
35 
36  virtual ~QgsEditorWidgetAutoConfPlugin() = default;
37 
51  virtual QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName, int &score SIP_OUT ) const = 0;
52 
53 };
54 
55 
57 
67 class GUI_EXPORT QgsEditorWidgetAutoConf SIP_SKIP
68 {
69  public:
70 
74  QgsEditorWidgetAutoConf();
75 
84  QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName ) const;
85 
91  void registerPlugin( QgsEditorWidgetAutoConfPlugin *plugin );
92 
93  private:
94  QList<std::shared_ptr<QgsEditorWidgetAutoConfPlugin> > mPlugins;
95 };
97 
98 #endif // QGSEDITORWIDGETAUTOCONF_H
Base class for plugins allowing to pick automatically a widget type for editing fields.
virtual QgsEditorWidgetSetup editorWidgetSetup(const QgsVectorLayer *vl, const QString &fieldName, int &score) const =0
Typical scores are:
virtual ~QgsEditorWidgetAutoConfPlugin()=default
Holder for the widget type and its configuration for a field.
Represents a vector layer which manages a vector based data sets.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_OUT
Definition: qgis_sip.h:58