QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | List of all members
QgsVectorFileWriter::FieldValueConverter Class Reference

Interface to convert raw field values to their user-friendly value. More...

#include <qgsvectorfilewriter.h>

Public Member Functions

 FieldValueConverter ()=default
 Constructor. More...
 
virtual ~FieldValueConverter ()=default
 
virtual QgsVectorFileWriter::FieldValueConverterclone () const
 Creates a clone of the FieldValueConverter. More...
 
virtual QVariant convert (int fieldIdxInLayer, const QVariant &value)
 Convert the provided value, for field fieldIdxInLayer. More...
 
virtual QgsField fieldDefinition (const QgsField &field)
 Returns a possibly modified field definition. More...
 

Detailed Description

Interface to convert raw field values to their user-friendly value.

Since
QGIS 2.16

Definition at line 218 of file qgsvectorfilewriter.h.

Constructor & Destructor Documentation

◆ FieldValueConverter()

QgsVectorFileWriter::FieldValueConverter::FieldValueConverter ( )
default

Constructor.

◆ ~FieldValueConverter()

virtual QgsVectorFileWriter::FieldValueConverter::~FieldValueConverter ( )
virtualdefault

Member Function Documentation

◆ clone()

QgsVectorFileWriter::FieldValueConverter * QgsVectorFileWriter::FieldValueConverter::clone ( ) const
virtual

Creates a clone of the FieldValueConverter.

Definition at line 73 of file qgsvectorfilewriter.cpp.

◆ convert()

QVariant QgsVectorFileWriter::FieldValueConverter::convert ( int  fieldIdxInLayer,
const QVariant &  value 
)
virtual

Convert the provided value, for field fieldIdxInLayer.

Default implementation will return provided value unmodified.

Parameters
fieldIdxInLayerfield index
valueoriginal raw value
Returns
possibly modified value.

Definition at line 68 of file qgsvectorfilewriter.cpp.

◆ fieldDefinition()

QgsField QgsVectorFileWriter::FieldValueConverter::fieldDefinition ( const QgsField field)
virtual

Returns a possibly modified field definition.

Default implementation will return provided field unmodified.

Parameters
fieldoriginal field definition
Returns
possibly modified field definition

Definition at line 63 of file qgsvectorfilewriter.cpp.


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