QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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)
 
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...
 
QgsSearchWidgetWrappercreateSearchWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent) const override
 By default a simple QgsFilterLineEdit is returned as search widget. More...
 
QgsEditorWidgetConfig readConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx) override
 Read the config from an XML file and map it to a proper QgsEditorWidgetConfig. More...
 
QMap< const char *, int > supportedWidgetTypes () override
 Returns a list of widget types which this editor widget supports. More...
 
void writeConfig (const QgsEditorWidgetConfig &config, QDomElement &configElement, QDomDocument &doc, const QgsVectorLayer *layer, int fieldIdx) override
 Serialize your configuration and save it in a xml doc. More...
 
- Public Member Functions inherited from QgsEditorWidgetFactory
 QgsEditorWidgetFactory (const QString &name)
 Constructor. More...
 
virtual ~QgsEditorWidgetFactory ()
 
virtual Qt::AlignmentFlag alignmentFlag (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config) const
 Return the alignment for a particular field. More...
 
virtual QVariant createCache (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config)
 Create a cache for a given field. More...
 
QString name ()
 Return The human readable identifier name of this widget type. More...
 
QgsEditorWidgetConfig readEditorConfig (const QDomElement &configElement, QgsVectorLayer *layer, int fieldIdx)
 Read the config from an XML file and map it to a proper QgsEditorWidgetConfig. More...
 
virtual QString representValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const
 Create a pretty String representation of the value. More...
 
virtual QVariant sortValue (QgsVectorLayer *vl, int fieldIdx, const QgsEditorWidgetConfig &config, const QVariant &cache, const QVariant &value) const
 If the default sort order should be overwritten for this widget, you can transform the value in here. More...
 
bool supportsField (QgsVectorLayer *vl, int fieldIdx)
 Check if this editor widget type supports a certain field. More...
 

Detailed Description

Note
not available in Python bindings

Definition at line 26 of file qgscheckboxwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsCheckboxWidgetFactory()

QgsCheckboxWidgetFactory::QgsCheckboxWidgetFactory ( const QString name)
explicit

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 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 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.

◆ readConfig()

QgsEditorWidgetConfig QgsCheckboxWidgetFactory::readConfig ( const QDomElement configElement,
QgsVectorLayer layer,
int  fieldIdx 
)
overridevirtual

Read the config from an XML file and map it to a proper QgsEditorWidgetConfig.

Parameters
configElementThe configuration element from the project file
layerThe layer for which this configuration applies
fieldIdxThe field on the layer for which this configuration applies
Returns
A configuration object. This will be passed to your widget wrapper later on

Reimplemented from QgsEditorWidgetFactory.

Definition at line 41 of file qgscheckboxwidgetfactory.cpp.

◆ supportedWidgetTypes()

QMap< 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 64 of file qgscheckboxwidgetfactory.cpp.

◆ writeConfig()

void QgsCheckboxWidgetFactory::writeConfig ( const QgsEditorWidgetConfig config,
QDomElement configElement,
QDomDocument doc,
const QgsVectorLayer layer,
int  fieldIdx 
)
overridevirtual

Serialize your configuration and save it in a xml doc.

Parameters
configThe configuration to serialize
configElementThe element, where you can write your configuration into
docThe document. You can use this to create new nodes
layerThe layer for which this configuration applies
fieldIdxThe field on the layer for which this configuration applies

Reimplemented from QgsEditorWidgetFactory.

Definition at line 54 of file qgscheckboxwidgetfactory.cpp.


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