Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsprocessingmodelcomment.h
       3                 :            :                          --------------------------
       4                 :            :     begin                : February 2020
       5                 :            :     copyright            : (C) 2020 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPROCESSINGMODELCOMMENT_H
      19                 :            : #define QGSPROCESSINGMODELCOMMENT_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include "qgsprocessingmodelcomponent.h"
      24                 :            : #include "qgsprocessingparameters.h"
      25                 :            : 
      26                 :            : ///@cond NOT_STABLE
      27                 :            : 
      28                 :            : /**
      29                 :            :  * \brief Represents a comment in a model.
      30                 :            :  * \ingroup core
      31                 :            :  * \since QGIS 3.14
      32                 :            :  */
      33                 :          0 : class CORE_EXPORT QgsProcessingModelComment : public QgsProcessingModelComponent
      34                 :            : {
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsProcessingModelComment with the specified \a description.
      39                 :            :      */
      40                 :            :     QgsProcessingModelComment( const QString &description = QString() );
      41                 :            : 
      42                 :            :     QgsProcessingModelComment *clone() const override SIP_FACTORY;
      43                 :            : 
      44                 :            :     /**
      45                 :            :      * Saves this comment to a QVariant.
      46                 :            :      * \see loadVariant()
      47                 :            :      */
      48                 :            :     QVariant toVariant() const;
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * Loads this comment from a QVariantMap.
      52                 :            :      * \see toVariant()
      53                 :            :      */
      54                 :            :     bool loadVariant( const QVariantMap &map );
      55                 :            : };
      56                 :            : 
      57                 :            : ///@endcond
      58                 :            : 
      59                 :            : #endif // QGSPROCESSINGMODELCOMMENT_H