QGIS API Documentation 3.41.0-Master (cea29feecf2)
|
Editor widget factory for geometry widgets. More...
#include <qgsgeometrywidgetfactory.h>
Public Member Functions | |
QgsGeometryWidgetFactory (const QString &name, QgsMessageBar *messageBar) | |
Constructor for QgsGeometryWidgetFactory, where name is a human-readable name for the factory. | |
QgsEditorConfigWidget * | configWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override |
Override this in your implementation. | |
QgsEditorWidgetWrapper * | create (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override |
Override this in your implementation. | |
unsigned int | fieldScore (const QgsVectorLayer *vl, int fieldIdx) const override |
This method allows disabling this editor widget type for a certain field. | |
Public Member Functions inherited from QgsEditorWidgetFactory | |
QgsEditorWidgetFactory (const QString &name) | |
Constructor. | |
virtual | ~QgsEditorWidgetFactory ()=default |
virtual QgsSearchWidgetWrapper * | createSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const |
By default a simple QgsFilterLineEdit is returned as search widget. | |
QString | name () const |
Returns The human readable identifier name of this widget type. | |
virtual QHash< const char *, int > | supportedWidgetTypes () |
Returns a list of widget types which this editor widget supports. | |
bool | supportsField (const QgsVectorLayer *vl, int fieldIdx) const |
Check if this editor widget type supports a certain field. | |
Editor widget factory for geometry widgets.
Definition at line 34 of file qgsgeometrywidgetfactory.h.
|
explicit |
Constructor for QgsGeometryWidgetFactory, where name is a human-readable name for the factory.
The messageBar argument can be used to link the widget to a QgsMessageBar for providing user feedback.
Definition at line 22 of file qgsgeometrywidgetfactory.cpp.
|
overridevirtual |
Override this in your implementation.
Create a new configuration widget for this widget type.
vl | The layer for which the widget will be created |
fieldIdx | The field index for which the widget will be created |
parent | The parent widget of the created config widget |
Implements QgsEditorWidgetFactory.
Definition at line 33 of file qgsgeometrywidgetfactory.cpp.
|
overridevirtual |
Override this in your implementation.
Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() instead of calling this method directly.
vl | The vector layer on which this widget will act |
fieldIdx | The field index on which this widget will act |
editor | An editor widget if already existent. If nullptr is provided, a new widget will be created. |
parent | The parent for the wrapper class and any created widget. |
Implements QgsEditorWidgetFactory.
Definition at line 28 of file qgsgeometrywidgetfactory.cpp.
|
overridevirtual |
This method allows disabling this editor widget type for a certain field.
By default, it returns 5 for every fields. Reimplement this if you only support certain fields.
Typical return values are:
vl | |
fieldIdx |
Reimplemented from QgsEditorWidgetFactory.
Definition at line 38 of file qgsgeometrywidgetfactory.cpp.