QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsCheckboxWidgetFactory Class Reference

#include <qgscheckboxwidgetfactory.h>

Inheritance diagram for QgsCheckboxWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Note
not available in Python bindings

Definition at line 30 of file qgscheckboxwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsCheckboxWidgetFactory()

QgsCheckboxWidgetFactory::QgsCheckboxWidgetFactory ( const QString &  name)
explicit

Constructor for QgsCheckboxWidgetFactory, where name is a human-readable name for the factory.

Definition at line 21 of file qgscheckboxwidgetfactory.cpp.

Member Function Documentation

◆ configWidget()

QgsEditorConfigWidget * QgsCheckboxWidgetFactory::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 qgscheckboxwidgetfactory.cpp.

◆ create()

QgsEditorWidgetWrapper * QgsCheckboxWidgetFactory::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 nullptr 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 26 of file qgscheckboxwidgetfactory.cpp.

◆ createSearchWidget()

QgsSearchWidgetWrapper * QgsCheckboxWidgetFactory::createSearchWidget ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent 
) const
overridevirtual

By default a simple QgsFilterLineEdit is returned as search widget.

Override in own factory to get something different than the default.

Reimplemented from QgsEditorWidgetFactory.

Definition at line 31 of file qgscheckboxwidgetfactory.cpp.

◆ fieldScore()

unsigned int QgsCheckboxWidgetFactory::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()

Reimplemented from QgsEditorWidgetFactory.

Definition at line 49 of file qgscheckboxwidgetfactory.cpp.

◆ supportedWidgetTypes()

QHash< const char *, int > QgsCheckboxWidgetFactory::supportedWidgetTypes ( )
overridevirtual

Returns a list of widget types which this editor widget supports.

Each widget type can have a priority value attached, the factory with the highest one will be used.

Returns
A map of widget type names and weight values
Note
not available in Python bindings

Reimplemented from QgsEditorWidgetFactory.

Definition at line 41 of file qgscheckboxwidgetfactory.cpp.


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