qgsdefaultvalue.h

Go to the documentation of this file.

/***************************************************************************
  qgsdefaultvalue.h
 
 ---------------------
 begin                : 19.9.2017
 copyright            : (C) 2017 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSDEFAULTVALUE_H
#define QGSDEFAULTVALUE_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsDefaultValue
{
    // clang-format off
  Q_GADGET SIP_SKIP
 
  Q_PROPERTY( QString expression READ expression WRITE setExpression )
  Q_PROPERTY( bool applyOnUpdate READ applyOnUpdate WRITE setApplyOnUpdate )
 
  public:
    // clang-format on

    explicit QgsDefaultValue( const QString &expression = QString(), bool applyOnUpdate = false );
 
    // TODO c++20 - replace with = default
    bool operator==( const QgsDefaultValue &other ) const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = sipCpp->isValid() ? u"<QgsDefaultValue: %1>"_s.arg(
                          sipCpp->expression().length() > 1000 ? sipCpp->expression().left( 1000 ) + u"..."_s
                          : sipCpp->expression() )
                        : u"<QgsDefaultValue: invalid>"_s;
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

        QString expression() const;

    void setExpression( const QString &expression );

    bool applyOnUpdate() const;

    void setApplyOnUpdate( bool applyOnUpdate );

    bool isValid() const;

    explicit operator bool() const SIP_PYTHON_SPECIAL_BOOL( isValid );
 
  private:
    QString mExpression;
    bool mApplyOnUpdate = false;
};
 
Q_DECLARE_METATYPE( QgsDefaultValue )
 
#endif // QGSDEFAULTVALUE_H