Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsvaluemapfieldformatter.h - QgsValueMapFieldFormatter
       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 QGSVALUEMAPFIELDKIT_H
      17                 :            : #define QGSVALUEMAPFIELDKIT_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsfieldformatter.h"
      21                 :            : 
      22                 :            : /**
      23                 :            :  * \ingroup core
      24                 :            :  * \brief Field formatter for a ValueMap field.
      25                 :            :  *
      26                 :            :  * A value relation field formatter looks up the values a map.
      27                 :            :  *
      28                 :            :  * The map is defined in the configuration as dictionary under the key "map".
      29                 :            :  *
      30                 :            :  * { "map": { 1: "one", 2: "two", 3: "three" } }
      31                 :            :  *
      32                 :            :  * Values that are not on the map will be wrapped in parentheses. So with the above
      33                 :            :  * configuration:
      34                 :            :  *
      35                 :            :  * - 3 => "three"
      36                 :            :  * - 5 => "(5)"
      37                 :            :  *
      38                 :            :  * \since QGIS 3.0
      39                 :            :  */
      40                 :         10 : class CORE_EXPORT QgsValueMapFieldFormatter : public QgsFieldFormatter
      41                 :            : {
      42                 :            :   public:
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Will be saved in the configuration when a value is NULL.
      46                 :            :      * It's the magic UUID {2839923C-8B7D-419E-B84B-CA2FE9B80EC7}
      47                 :            :      */
      48                 :            :     static const QString NULL_VALUE;
      49                 :            : 
      50                 :            :     /**
      51                 :            :       * Default constructor of field formatter for a value map field.
      52                 :            :       */
      53                 :            :     QgsValueMapFieldFormatter();
      54                 :            : 
      55                 :            :     QString id() const override;
      56                 :            : 
      57                 :            :     QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
      58                 :            : 
      59                 :            :     QVariant sortValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
      60                 :            : 
      61                 :            :     QVariantList availableValues( const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context ) const override;
      62                 :            : };
      63                 :            : 
      64                 :            : #endif // QGSVALUEMAPFIELDKIT_H