QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsactionscope.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsactionscope.h - QgsActionScope
3
4 ---------------------
5 begin : 1.11.2016
6 copyright : (C) 2016 by Matthias Kuhn
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 QGSACTIONSCOPE_H
17#define QGSACTIONSCOPE_H
18
19#include "qgis_core.h"
20#include <QString>
22
46class CORE_EXPORT QgsActionScope
47{
48 public:
49#ifdef SIP_RUN
50 % TypeCode
51#include <QHash>
52 % End
53#endif
54
59 explicit QgsActionScope();
60
66 explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
67
71 bool operator==( const QgsActionScope &other ) const;
72
79 QgsExpressionContextScope expressionContextScope() const;
80
84 void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
85
90 QString id() const;
91
93 void setId( const QString &id );
94
100 QString title() const;
102 void setTitle( const QString &title );
103
110 QString description() const;
112 void setDescription( const QString &description );
113
118 bool isValid() const;
119#ifdef SIP_RUN
120 long __hash__();
121 % MethodCode
122 sipRes = qHash( *sipCpp );
123 % End
124#endif
125
126 private:
127 QString mId;
128 QString mTitle;
129 QString mDescription;
130 QgsExpressionContextScope mExpressionContextScope;
131};
132
133CORE_EXPORT uint qHash( const QgsActionScope &key, uint seed = 0 ) SIP_SKIP;
134
135#endif // QGSACTIONSCOPE_H
An action scope defines a "place" for an action to be shown and may add additional expression variabl...
Single scope for storing variables and functions for use within a QgsExpressionContext.
#define SIP_SKIP
Definition: qgis_sip.h:126
CORE_EXPORT uint qHash(const QgsActionScope &key, uint seed=0)
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)