QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Field formatter for a checkbox field. More...
#include <qgscheckboxfieldformatter.h>
Public Types | |
enum | TextDisplayMethod { ShowTrueFalse , ShowStoredValues } |
Method to use when displaying the checkbox values as plain text. More... | |
Public Types inherited from QgsFieldFormatter | |
typedef QFlags< Flag > | Flags |
Public Member Functions | |
QgsCheckBoxFieldFormatter ()=default | |
QString | id () const override |
Returns a unique id for this field formatter. | |
QString | representValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const override |
Create a pretty String representation of the value. | |
Public Member Functions inherited from QgsFieldFormatter | |
QgsFieldFormatter ()=default | |
virtual | ~QgsFieldFormatter ()=default |
virtual Qt::AlignmentFlag | alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const |
Returns the alignment for a particular field. | |
virtual QVariantList | availableValues (const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context) const |
Returns a list of the values that would be possible to select with this widget type On a RelationReference that would be the parents ids or on ValueMap all the configured keys according to the settings in the config. | |
virtual QVariant | createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const |
Create a cache for a given field. | |
Flags | flags () const |
Returns the flags. | |
virtual QList< QgsVectorLayerRef > | layerDependencies (const QVariantMap &config) const SIP_SKIP |
Returns a list of weak layer references to other layers required by this formatter for the given config. | |
void | setFlags (const Flags &flags) |
Sets the flags. | |
enum Flag | SIP_ENUM_BASETYPE (IntFlag) |
Flags for the abilities of the formatter. | |
virtual QVariant | sortValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &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. | |
Field formatter for a checkbox field.
Definition at line 29 of file qgscheckboxfieldformatter.h.
Method to use when displaying the checkbox values as plain text.
Enumerator | |
---|---|
ShowTrueFalse | Shows "True" or "False" strings. |
ShowStoredValues | Shows actual stored field value. |
Definition at line 38 of file qgscheckboxfieldformatter.h.
|
default |
|
overridevirtual |
Returns a unique id for this field formatter.
This id will later be used to identify this field formatter in the registry with QgsFieldFormatterRegistry::fieldFormatter().
This id matches the id of a QgsEditorWidgetFactory.
Implements QgsFieldFormatter.
Definition at line 24 of file qgscheckboxfieldformatter.cpp.
|
overridevirtual |
Create a pretty String representation of the value.
Reimplemented from QgsFieldFormatter.
Definition at line 29 of file qgscheckboxfieldformatter.cpp.