Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsdefaultvalue.h
       3                 :            : 
       4                 :            :  ---------------------
       5                 :            :  begin                : 19.9.2017
       6                 :            :  copyright            : (C) 2017 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 QGSDEFAULTVALUE_H
      17                 :            : #define QGSDEFAULTVALUE_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgis_sip.h"
      21                 :            : 
      22                 :            : #include <QString>
      23                 :            : #include <QObject>
      24                 :            : 
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  *
      29                 :            :  * \brief The QgsDefaultValue class provides a container for managing client
      30                 :            :  *        side default values for fields.
      31                 :            :  *
      32                 :            :  * A QgsDefaultValue consists of an expression string that will be evaluated
      33                 :            :  * on the client when a default field value needs to be generated.
      34                 :            :  *
      35                 :            :  * Usual values for such an expression are
      36                 :            :  *
      37                 :            :  * - `now()` for a timestamp for a record
      38                 :            :  * - `@some_variable` to insert a project or application level variable like
      39                 :            :  *   the username of the one digitizing a feature
      40                 :            :  * - `$length` to insert a derived attribute of a geometry
      41                 :            :  *
      42                 :            :  * QgsDefaultValue also has a `applyOnUpdate` flag which will indicate that a
      43                 :            :  * default value should also be applied when a feature is updated. If this is
      44                 :            :  * not set, the default value will only be used when a feature is created.
      45                 :            :  *
      46                 :            :  * \since QGIS 3.0
      47                 :            :  */
      48                 :          0 : class CORE_EXPORT QgsDefaultValue
      49                 :            : {
      50                 :            :     Q_GADGET SIP_SKIP
      51                 :            : 
      52                 :            :     Q_PROPERTY( QString expression READ expression WRITE setExpression )
      53                 :            :     Q_PROPERTY( bool applyOnUpdate READ applyOnUpdate WRITE setApplyOnUpdate )
      54                 :            : 
      55                 :            :   public:
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * Create a new default value with the given \a expression and \a applyOnUpdate flag.
      59                 :            :      * \see QgsVectorLayer::setDefaultValueDefinition
      60                 :            :      */
      61                 :            :     explicit QgsDefaultValue( const QString &expression = QString(), bool applyOnUpdate = false );
      62                 :            :     bool operator==( const QgsDefaultValue &other ) const;
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * The expression will be evaluated whenever a default value needs
      66                 :            :      * to be calculated for a field.
      67                 :            :      */
      68                 :            :     QString expression() const;
      69                 :            : 
      70                 :            :     /**
      71                 :            :      * The expression will be evaluated whenever a default value needs
      72                 :            :      * to be calculated for a field.
      73                 :            :      */
      74                 :            :     void setExpression( const QString &expression );
      75                 :            : 
      76                 :            :     /**
      77                 :            :      * The applyOnUpdate flag determines if this expression should also be
      78                 :            :      * applied when a feature is updated or only when it's created.
      79                 :            :      */
      80                 :            :     bool applyOnUpdate() const;
      81                 :            : 
      82                 :            :     /**
      83                 :            :      * The applyOnUpdate flag determines if this expression should also be
      84                 :            :      * applied when a feature is updated or only when it's created.
      85                 :            :      */
      86                 :            :     void setApplyOnUpdate( bool applyOnUpdate );
      87                 :            : 
      88                 :            :     /**
      89                 :            :      * Returns if this default value should be applied.
      90                 :            :      * \returns FALSE if the expression is a null string.
      91                 :            :      */
      92                 :            :     bool isValid() const;
      93                 :            : 
      94                 :            :     /**
      95                 :            :      * Checks if a default value is set. Alias for isValid().
      96                 :            :      * \returns FALSE if the expression is a null string.
      97                 :            :      */
      98                 :            :     operator bool() const SIP_PYTHON_SPECIAL_BOOL( isValid );
      99                 :            : 
     100                 :            :   private:
     101                 :            :     QString mExpression;
     102                 :            :     bool mApplyOnUpdate = false;
     103                 :            : };
     104                 :            : 
     105                 :            : Q_DECLARE_METATYPE( QgsDefaultValue )
     106                 :            : 
     107                 :            : #endif // QGSDEFAULTVALUE_H