qgsactionscope.h

Go to the documentation of this file.

/***************************************************************************
  qgsactionscope.h - QgsActionScope
 
 ---------------------
 begin                : 1.11.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : matthias@opengis.ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSACTIONSCOPE_H
#define QGSACTIONSCOPE_H
 
#include "qgis_core.h"
#include "qgsexpressioncontext.h"
 
#include <QString>

class CORE_EXPORT QgsActionScope
{
  public:
#ifdef SIP_RUN
    // clang-format off
    % TypeCode
#include <QHash>
    % End
// clang-format on
#endif

      explicit QgsActionScope();

    explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
 
    bool operator==( const QgsActionScope &other ) const;

    QgsExpressionContextScope expressionContextScope() const;

    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );

    QString id() const;

    void setId( const QString &id );

    QString title() const;

    void setTitle( const QString &title );

    QString description() const;

    void setDescription( const QString &description );

    bool isValid() const;
 
    // clang-format off
#ifdef SIP_RUN
    long __hash__();
    % MethodCode
    sipRes = qHash( *sipCpp );
    % End
#endif
 
  private:
    // clang-format on
    QString mId;
    QString mTitle;
    QString mDescription;
    QgsExpressionContextScope mExpressionContextScope;
};
 
CORE_EXPORT size_t qHash( const QgsActionScope &key, size_t seed = 0 ) SIP_SKIP;
 
#endif // QGSACTIONSCOPE_H