QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Field formatter for a value relation field. More...
#include <qgsvaluerelationfieldformatter.h>
Classes | |
struct | ValueRelationItem |
Public Types | |
typedef QVector< QgsValueRelationFieldFormatter::ValueRelationItem > | ValueRelationCache |
Public Types inherited from QgsFieldFormatter | |
typedef QFlags< Flag > | Flags |
Public Member Functions | |
QgsValueRelationFieldFormatter () | |
Constructor for QgsValueRelationFieldFormatter. | |
QVariantList | availableValues (const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context) const override |
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. | |
QVariant | createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const override |
Create a cache for a given field. | |
QString | id () const override |
Returns a unique id for this field formatter. | |
QList< QgsVectorLayerRef > | layerDependencies (const QVariantMap &config) const override |
Returns a list of weak layer references to other layers required by this formatter for the given config. | |
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. | |
QVariant | sortValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const override |
If the default sort order should be overwritten for this widget, you can transform the value in here. | |
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. | |
Flags | flags () const |
Returns the flags. | |
void | setFlags (const Flags &flags) |
Sets the flags. | |
enum Flag | SIP_ENUM_BASETYPE (IntFlag) |
Flags for the abilities of the formatter. | |
Static Public Member Functions | |
static QgsValueRelationFieldFormatter::ValueRelationCache | createCache (const QVariantMap &config, const QgsFeature &formFeature=QgsFeature(), const QgsFeature &parentFormFeature=QgsFeature()) |
Create a cache for a value relation field. | |
static QSet< QString > | expressionFormAttributes (const QString &expression) |
Returns a list of attributes required by the form context expression. | |
static QSet< QString > | expressionFormVariables (const QString &expression) |
Returns a list of variables required by the form context expression. | |
static bool | expressionIsUsable (const QString &expression, const QgsFeature &feature, const QgsFeature &parentFeature=QgsFeature()) |
Check whether the feature has all values required by the expression, optionally checks for parentFeature. | |
static QSet< QString > | expressionParentFormAttributes (const QString &expression) |
Returns a list of attributes required by the parent form's form context expression. | |
static QSet< QString > | expressionParentFormVariables (const QString &expression) |
Returns a list of variables required by the parent form's form context expression. | |
static bool | expressionRequiresFormScope (const QString &expression) |
Check if the expression requires a form scope (i.e. | |
static bool | expressionRequiresParentFormScope (const QString &expression) |
Check if the expression requires a parent form scope (i.e. | |
static QgsVectorLayer * | resolveLayer (const QVariantMap &config, const QgsProject *project) |
Returns the (possibly nullptr ) layer from the widget's config and project. | |
static QStringList | valueToStringList (const QVariant &value) |
Utility to convert a list or a string representation of an (hstore style: {1,2...}) list in value to a string list. | |
Field formatter for a value relation field.
A value relation field formatter looks up the values from features on another layer.
Definition at line 36 of file qgsvaluerelationfieldformatter.h.
typedef QVector< QgsValueRelationFieldFormatter::ValueRelationItem > QgsValueRelationFieldFormatter::ValueRelationCache |
Definition at line 58 of file qgsvaluerelationfieldformatter.h.
QgsValueRelationFieldFormatter::QgsValueRelationFieldFormatter | ( | ) |
Constructor for QgsValueRelationFieldFormatter.
Definition at line 44 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
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.
Reimplemented from QgsFieldFormatter.
Definition at line 220 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Create a cache for a value relation field.
This can be used to keep the value map in the local memory if doing multiple lookups in a loop.
config | The widget configuration |
formFeature | The feature currently being edited with current attribute values |
parentFormFeature | For embedded forms only, the feature currently being edited in the parent form with current attribute values |
Definition at line 125 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
Create a cache for a given field.
This will be used in situations where a field is being represented various times in a loop. And will be passed to other methods on QgsFieldKit and QgsEditorWidgetWrapper.
For example, the attribute table will create a cache once for each field and then use this cache for representation. The QgsValueRelationFieldFormatter and QgsValueRelationEditorWidget implement this functionality to create a lookuptable once (a QVariantMap / dict) and are make use of a cache if present.
Reimplemented from QgsFieldFormatter.
Definition at line 117 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Returns a list of attributes required by the form context expression.
expression | Form filter expression |
Definition at line 352 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Returns a list of variables required by the form context expression.
expression | Form filter expression |
Definition at line 299 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Check whether the feature has all values required by the expression, optionally checks for parentFeature.
true
if the expression can be used Definition at line 377 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Returns a list of attributes required by the parent form's form context expression.
expression | Form filter expression |
Definition at line 327 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Returns a list of variables required by the parent form's form context expression.
expression | Form filter expression |
Definition at line 308 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Check if the expression requires a form scope (i.e.
if it uses fields or geometry of the currently edited feature).
expression | The widget's filter expression |
true
if the expression requires a form scope Definition at line 317 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Check if the expression requires a parent form scope (i.e.
if it uses fields or geometry of the parent form's currently edited feature).
expression | The widget's filter expression |
true
if the expression requires a parent form scope Definition at line 322 of file qgsvaluerelationfieldformatter.cpp.
|
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 49 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
Returns a list of weak layer references to other layers required by this formatter for the given config.
The default implementation returns an empty list.
This method should be reimplemented by formatters that handle relations with other layers, (e.g. ValueRelation) and can be used by client code to warn the user about missing required dependencies or to add some resolution logic in order to load the missing dependency.
Reimplemented from QgsFieldFormatter.
Definition at line 206 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
Create a pretty String representation of the value.
Reimplemented from QgsFieldFormatter.
Definition at line 54 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Returns the (possibly nullptr
) layer from the widget's config and project.
Definition at line 405 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
If the default sort order should be overwritten for this widget, you can transform the value in here.
Reimplemented from QgsFieldFormatter.
Definition at line 112 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Utility to convert a list or a string representation of an (hstore style: {1,2...}) list in value to a string list.
Definition at line 236 of file qgsvaluerelationfieldformatter.cpp.