mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
155 lines
4.8 KiB
Plaintext
155 lines
4.8 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsfieldformatter.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsFieldFormatterContext
|
|
{
|
|
%Docstring(signature="appended")
|
|
A context for field formatter containing information like the project.
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsfieldformatter.h"
|
|
%End
|
|
public:
|
|
|
|
QgsFieldFormatterContext();
|
|
|
|
QgsProject *project() const;
|
|
%Docstring
|
|
Returns the project used in field formatter
|
|
|
|
.. seealso:: :py:func:`setProject`
|
|
%End
|
|
|
|
void setProject( QgsProject *project );
|
|
%Docstring
|
|
Sets the ``project`` used in field formatter
|
|
|
|
.. seealso:: :py:func:`project`
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsFieldFormatter
|
|
{
|
|
%Docstring(signature="appended")
|
|
A field formatter helps to handle and display values for a field.
|
|
|
|
It allows for using a shared configuration with the editor widgets for
|
|
representation of attribute values. Field kits normally have one single
|
|
instance which is managed by the :py:class:`QgsFieldFormatterRegistry`.
|
|
Custom field formatters should be registered there and field formatters
|
|
for use within code should normally be obtained from there.
|
|
|
|
This is an abstract base class and will always need to be subclassed.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsfieldformatter.h"
|
|
%End
|
|
public:
|
|
|
|
QgsFieldFormatter();
|
|
|
|
virtual ~QgsFieldFormatter();
|
|
|
|
enum Flag
|
|
{
|
|
CanProvideAvailableValues
|
|
};
|
|
typedef QFlags<QgsFieldFormatter::Flag> Flags;
|
|
|
|
|
|
virtual QString id() const = 0;
|
|
%Docstring
|
|
Returns a unique id for this field formatter. This id will later be used
|
|
to identify this field formatter in the registry with
|
|
:py:func:`QgsFieldFormatterRegistry.fieldFormatter()`.
|
|
|
|
This id matches the id of a :py:class:`QgsEditorWidgetFactory`.
|
|
%End
|
|
|
|
virtual QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const;
|
|
%Docstring
|
|
Create a pretty String representation of the value.
|
|
|
|
:return: By default the string representation of the provided value as
|
|
implied by the field definition is returned.
|
|
%End
|
|
|
|
virtual QVariant sortValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const;
|
|
%Docstring
|
|
If the default sort order should be overwritten for this widget, you can
|
|
transform the value in here.
|
|
|
|
:return: an unmodified value by default.
|
|
%End
|
|
|
|
virtual Qt::AlignmentFlag alignmentFlag( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config ) const;
|
|
%Docstring
|
|
Returns the alignment for a particular field. By default this will
|
|
consider the field type but can be overwritten if mapped values are
|
|
represented.
|
|
%End
|
|
|
|
virtual QVariant createCache( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config ) const;
|
|
%Docstring
|
|
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
|
|
:py:class:`QgsFieldKit` and :py:class:`QgsEditorWidgetWrapper`.
|
|
|
|
For example, the attribute table will create a cache once for each field
|
|
and then use this cache for representation. The
|
|
:py:class:`QgsValueRelationFieldFormatter` and
|
|
:py:class:`QgsValueRelationEditorWidget` implement this functionality to
|
|
create a lookuptable once (a QVariantMap / dict) and are make use of a
|
|
cache if present.
|
|
%End
|
|
|
|
|
|
virtual QVariantList availableValues( const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context ) const;
|
|
%Docstring
|
|
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``
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
Flags flags() const;
|
|
%Docstring
|
|
Returns the flags
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
void setFlags( const Flags &flags );
|
|
%Docstring
|
|
Sets the ``flags``
|
|
|
|
.. versionadded:: 3.12
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsfieldformatter.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|