QGIS API Documentation  3.25.0-Master (349eb7cb1e)
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
7  email : [email protected]
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>
21 #include "qgsexpressioncontext.h"
22 
47 class CORE_EXPORT QgsActionScope
48 {
49  public:
50 #ifdef SIP_RUN
51  % TypeCode
52 #include <QHash>
53  % End
54 #endif
55 
61  explicit QgsActionScope();
62 
68  explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
69 
73  bool operator==( const QgsActionScope &other ) const;
74 
82  QgsExpressionContextScope expressionContextScope() const;
83 
87  void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
88 
94  QString id() const;
95 
97  void setId( const QString &id );
98 
105  QString title() const;
107  void setTitle( const QString &title );
108 
116  QString description() const;
118  void setDescription( const QString &description );
119 
125  bool isValid() const;
126 #ifdef SIP_RUN
127  long __hash__();
128  % MethodCode
129  sipRes = qHash( *sipCpp );
130  % End
131 #endif
132 
133  private:
134  QString mId;
135  QString mTitle;
136  QString mDescription;
137  QgsExpressionContextScope mExpressionContextScope;
138 };
139 
140 CORE_EXPORT uint qHash( const QgsActionScope &key, uint seed = 0 ) SIP_SKIP;
141 
142 #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)