Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsrelationreferencefieldformatter.h - QgsRelationReferenceFieldFormatter
       3                 :            : 
       4                 :            :  ---------------------
       5                 :            :  begin                : 3.12.2016
       6                 :            :  copyright            : (C) 2016 by Matthias Kuhn
       7                 :            :  email                : matthias@opengis.ch
       8                 :            :  ***************************************************************************
       9                 :            :  *                                                                         *
      10                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      11                 :            :  *   it under the terms of the GNU General Public License as published by  *
      12                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      13                 :            :  *   (at your option) any later version.                                   *
      14                 :            :  *                                                                         *
      15                 :            :  ***************************************************************************/
      16                 :            : #ifndef QGSRELATIONREFERENCEFIELDKIT_H
      17                 :            : #define QGSRELATIONREFERENCEFIELDKIT_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsfieldformatter.h"
      21                 :            : 
      22                 :            : /**
      23                 :            :  * \ingroup core
      24                 :            :  * \brief Field formatter for a relation reference field.
      25                 :            :  *
      26                 :            :  * A value relation field formatter looks up the values from
      27                 :            :  * features on another layer.
      28                 :            :  *
      29                 :            :  * \since QGIS 3.0
      30                 :            :  */
      31                 :         10 : class CORE_EXPORT QgsRelationReferenceFieldFormatter : public QgsFieldFormatter
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     /**
      36                 :            :       * Default constructor of field formatter for a relation reference field.
      37                 :            :       */
      38                 :            :     QgsRelationReferenceFieldFormatter();
      39                 :            : 
      40                 :            :     QString id() const override;
      41                 :            : 
      42                 :            :     QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
      43                 :            : 
      44                 :            :     QVariant sortValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
      45                 :            : 
      46                 :            :     QVariant createCache( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config ) const override;
      47                 :            : 
      48                 :            :     QList<QgsVectorLayerRef> layerDependencies( const QVariantMap &config ) const override SIP_SKIP;
      49                 :            : 
      50                 :            :     QVariantList availableValues( const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context ) const override;
      51                 :            : 
      52                 :            :     //friend class TestQgsRelationReferenceFieldFormatter;
      53                 :            : 
      54                 :            : };
      55                 :            : 
      56                 :            : #endif // QGSRELATIONREFERENCEFIELDKIT_H