Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgscheckboxfieldformatter.h - QgsCheckBoxFieldFormatter
       3                 :            : 
       4                 :            :  ---------------------
       5                 :            :  begin                : 23.09.2019
       6                 :            :  copyright            : (C) 2019 by Denis Rouzaud
       7                 :            :  email                : denis@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 QGSCHECKBOXFIELDFORMATTER_H
      17                 :            : #define QGSCHECKBOXFIELDFORMATTER_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsfieldformatter.h"
      21                 :            : 
      22                 :            : 
      23                 :            : /**
      24                 :            :  * \ingroup core
      25                 :            :  * \brief Field formatter for a checkbox field.
      26                 :            :  *
      27                 :            :  * \since QGIS 3.10
      28                 :            :  */
      29                 :         10 : class CORE_EXPORT QgsCheckBoxFieldFormatter : public QgsFieldFormatter
      30                 :            : {
      31                 :            :   public:
      32                 :            : 
      33                 :            :     /**
      34                 :            :      * Method to use when displaying the checkbox values as plain text.
      35                 :            :      *
      36                 :            :      * \since QGIS 3.18
      37                 :            :      */
      38                 :            :     enum TextDisplayMethod
      39                 :            :     {
      40                 :            :       ShowTrueFalse, //!< Shows "True" or "False" strings
      41                 :            :       ShowStoredValues, //!< Shows actual stored field value
      42                 :            :     };
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Constructor for QgsCheckBoxFieldFormatter.
      46                 :            :      */
      47                 :          5 :     QgsCheckBoxFieldFormatter() = default;
      48                 :            : 
      49                 :            :     QString id() const override;
      50                 :            : 
      51                 :            :     QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
      52                 :            : };
      53                 :            : 
      54                 :            : 
      55                 :            : #endif // QGSCHECKBOXFIELDFORMATTER_H