QGIS API Documentation  2.99.0-Master (0cba29c)
Public Member Functions | List of all members
QgsListWidgetFactory Class Reference

Factory for widgets for editing a QVariantList or a QStringList. More...

#include <qgslistwidgetfactory.h>

Inheritance diagram for QgsListWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsListWidgetFactory (const QString &name)
 Constructor. More...
 
QgsEditorConfigWidgetconfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 Override this in your implementation. More...
 
QgsEditorWidgetWrappercreate (QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent) const override
 Override this in your implementation. More...
 
unsigned int fieldScore (const QgsVectorLayer *vl, int fieldIdx) const override
 This method allows disabling this editor widget type for a certain field. More...
 
- Public Member Functions inherited from QgsEditorWidgetFactory
 QgsEditorWidgetFactory (const QString &name)
 Constructor. More...
 
virtual ~QgsEditorWidgetFactory ()=default
 
virtual QgsSearchWidgetWrappercreateSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const
 By default a simple QgsFilterLineEdit is returned as search widget. More...
 
QString name ()
 Return The human readable identifier name of this widget type. More...
 
virtual QHash< const char *, int > supportedWidgetTypes ()
 Returns a list of widget types which this editor widget supports. More...
 
bool supportsField (const QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field. More...
 

Detailed Description

Factory for widgets for editing a QVariantList or a QStringList.

Since
QGIS 3.0
Note
not available in Python bindings

Definition at line 29 of file qgslistwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsListWidgetFactory()

QgsListWidgetFactory::QgsListWidgetFactory ( const QString &  name)

Constructor.

Definition at line 26 of file qgslistwidgetfactory.cpp.

Member Function Documentation

◆ configWidget()

QgsEditorConfigWidget * QgsListWidgetFactory::configWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent 
) const
overridevirtual

Override this in your implementation.

Create a new configuration widget for this widget type.

Parameters
vlThe layer for which the widget will be created
fieldIdxThe field index for which the widget will be created
parentThe parent widget of the created config widget
Returns
A configuration widget

Implements QgsEditorWidgetFactory.

Definition at line 36 of file qgslistwidgetfactory.cpp.

◆ create()

QgsEditorWidgetWrapper * QgsListWidgetFactory::create ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  editor,
QWidget *  parent 
) const
overridevirtual

Override this in your implementation.

Create a new editor widget wrapper. Call QgsEditorWidgetRegistry::create() instead of calling this method directly.

Parameters
vlThe vector layer on which this widget will act
fieldIdxThe field index on which this widget will act
editorAn editor widget if already existent. If NULL is provided, a new widget will be created.
parentThe parent for the wrapper class and any created widget.
Returns
A new widget wrapper

Implements QgsEditorWidgetFactory.

Definition at line 31 of file qgslistwidgetfactory.cpp.

◆ fieldScore()

unsigned int QgsListWidgetFactory::fieldScore ( const QgsVectorLayer vl,
int  fieldIdx 
) const
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:

  • 0: not supported
  • 5: maybe support (for example, Datetime support strings depending on their content)
  • 10: basic support (this is what returns TextEdit for example, since it supports everything in a crude way)
  • 20: specialized support
Parameters
vl
fieldIdx
Returns
0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be taken by default). The default implementation returns 5..
See also
supportsField( QgsVectorLayer* vl, fieldIdx )

Reimplemented from QgsEditorWidgetFactory.

Definition at line 44 of file qgslistwidgetfactory.cpp.


The documentation for this class was generated from the following files: