Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                qgseditorwidgetsetup.h - Holder for the widget configuration.
       3                 :            :                      --------------------------------------
       4                 :            :                Date                 : 01-Sep-2016
       5                 :            :                Copyright            : (C) 2016 by Patrick Valsecchi
       6                 :            :                email                : patrick.valsecchi at camptocamp.com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSEDITORWIDGETSETUP_H
      17                 :            : #define QGSEDITORWIDGETSETUP_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include <QVariantMap>
      21                 :            : 
      22                 :            : /**
      23                 :            :  * \ingroup core
      24                 :            :  * \brief Holder for the widget type and its configuration for a field.
      25                 :            :  *
      26                 :            :  * \since QGIS 3.0
      27                 :            :  */
      28                 :        238 : class CORE_EXPORT QgsEditorWidgetSetup
      29                 :            : {
      30                 :            :   public:
      31                 :            : 
      32                 :            :     /**
      33                 :            :      * Constructor
      34                 :            :      */
      35                 :          0 :     QgsEditorWidgetSetup( const QString &type, const QVariantMap &config )
      36                 :          0 :       : mType( type )
      37                 :          0 :       , mConfig( config )
      38                 :          0 :     {}
      39                 :            : 
      40                 :            :     //! Constructor for QgsEditorWidgetSetup
      41                 :        246 :     QgsEditorWidgetSetup() = default;
      42                 :            : 
      43                 :            :     /**
      44                 :            :      * \returns the widget type to use
      45                 :            :      */
      46                 :          0 :     QString type() const { return mType; }
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * \returns the widget configuration to used
      50                 :            :      */
      51                 :          0 :     QVariantMap config() const { return mConfig; }
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * \returns TRUE if there is no widget configured.
      55                 :            :      */
      56                 :          0 :     bool isNull() const { return mType.isEmpty(); }
      57                 :            : 
      58                 :            :   private:
      59                 :            :     QString mType;
      60                 :            :     QVariantMap mConfig;
      61                 :            : };
      62                 :            : 
      63                 :            : #endif // QGSEDITORWIDGETSETUP_H