qgsfieldformatter.h

Go to the documentation of this file.

/***************************************************************************
  qgsfieldformatter.h - QgsFieldFormatter
 
 ---------------------
 begin                : 2.12.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSFIELDKIT_H
#define QGSFIELDKIT_H
 
#include "qgis_core.h"
#include "qgsvectorlayerref.h"
 
#include <QString>
#include <QVariant>
 
class QgsVectorLayer;

class CORE_EXPORT QgsFieldFormatterContext
{
  public:
 
    QgsFieldFormatterContext() = default;

    QgsProject *project() const { return mProject; }

    void setProject( QgsProject *project ) { mProject = project; }
 
  private:
    QgsProject *mProject = nullptr;
};

class CORE_EXPORT QgsFieldFormatter
{
  public:
 
    QgsFieldFormatter() = default;
 
    virtual ~QgsFieldFormatter() = default;

    enum Flag SIP_ENUM_BASETYPE( IntFlag )
    {
      CanProvideAvailableValues =  1   
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    virtual QString id() const = 0;

    virtual QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const;

    virtual QVariant sortValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const;

    virtual Qt::AlignmentFlag alignmentFlag( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config ) const;

    virtual QVariant createCache( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config ) const;

    virtual QList< QgsVectorLayerRef > layerDependencies( const QVariantMap &config ) const SIP_SKIP;

    virtual QVariantList availableValues( const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context ) const;

    Flags flags() const { return mFlags; }

    void setFlags( const Flags &flags );
 
  private:
    Flags mFlags;
};
 
#endif // QGSFIELDKIT_H