Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgstemporalproperty.h
       3                 :            :                          ---------------
       4                 :            :     begin                : January 2020
       5                 :            :     copyright            : (C) 2020 by Samweli Mwakisambwe
       6                 :            :     email                : samweli at kartoza 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 QGSTEMPORALPROPERTY_H
      19                 :            : #define QGSTEMPORALPROPERTY_H
      20                 :            : 
      21                 :            : 
      22                 :            : #include "qgis_core.h"
      23                 :            : #include "qgis_sip.h"
      24                 :            : 
      25                 :            : #include <QObject>
      26                 :            : 
      27                 :            : /**
      28                 :            :  * \class QgsTemporalProperty
      29                 :            :  * \ingroup core
      30                 :            :  * \brief Base class for temporal property.
      31                 :            :  *
      32                 :            :  * \since QGIS 3.14
      33                 :            :  */
      34                 :            : 
      35                 :          0 : class CORE_EXPORT QgsTemporalProperty : public QObject
      36                 :            : {
      37                 :            :     Q_OBJECT
      38                 :            : 
      39                 :            :   public:
      40                 :            : 
      41                 :            :     /**
      42                 :            :      * Flags attached to the temporal property.
      43                 :            :      */
      44                 :            :     enum Flag
      45                 :            :     {
      46                 :            :       FlagDontInvalidateCachedRendersWhenRangeChanges = 1  //!< Any cached rendering will not be invalidated when temporal range context is modified.
      47                 :            :     };
      48                 :            :     Q_DECLARE_FLAGS( Flags, Flag )
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * Constructor for QgsTemporalProperty, with the specified \a parent object.
      52                 :            :      *
      53                 :            :      * The \a active argument specifies whether the property is initially active (see isActive()).
      54                 :            :      */
      55                 :            :     QgsTemporalProperty( QObject *parent SIP_TRANSFERTHIS = nullptr, bool enabled = false );
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * Sets whether the temporal property is \a active.
      59                 :            :      *
      60                 :            :      * \see isActive()
      61                 :            :      */
      62                 :            :     void setIsActive( bool active );
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Returns TRUE if the temporal property is active.
      66                 :            :      *
      67                 :            :      * \see setIsActive()
      68                 :            :     */
      69                 :            :     bool isActive() const;
      70                 :            : 
      71                 :            :     /**
      72                 :            :      * Returns flags associated to the temporal property.
      73                 :            :      */
      74                 :            :     virtual QgsTemporalProperty::Flags flags() const { return QgsTemporalProperty::Flags(); }
      75                 :            : 
      76                 :            :   signals:
      77                 :            : 
      78                 :            :     /**
      79                 :            :      * Emitted when the temporal properties have changed.
      80                 :            :      */
      81                 :            :     void changed();
      82                 :            : 
      83                 :            :   private:
      84                 :            : 
      85                 :            :     //! Active status of the properties
      86                 :            :     bool mActive = false;
      87                 :            : 
      88                 :            : };
      89                 :            : 
      90                 :            : #endif // QGSTEMPORALPROPERTY_H