QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
qgsactionmenu.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsactionmenu.h
3 --------------------------------------
4 Date : 11.8.2014
5 Copyright : (C) 2014 Matthias Kuhn
6 Email : matthias at opengis dot ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSACTIONMENU_H
17#define QGSACTIONMENU_H
18
19#include <QMenu>
20#include "qgis_sip.h"
21
22#include "qgsfeature.h"
24#include "qgsaction.h"
25#include "qgis_gui.h"
26
27class QgsMapLayer;
29class QgsVectorLayer;
32
38class GUI_EXPORT QgsActionMenu : public QMenu
39{
40 Q_OBJECT
41
42 public:
43
44 struct GUI_EXPORT ActionData
45 {
46
50 ActionData() = default;
51 ActionData( const QgsAction &action, QgsFeatureId featureId, QgsMapLayer *mapLayer );
52 ActionData( QgsMapLayerAction *action, QgsFeatureId featureId, QgsMapLayer *mapLayer );
53
55 QVariant actionData;
56 QgsFeatureId featureId = 0;
57 QgsMapLayer *mapLayer = nullptr;
58 };
59
69 explicit QgsActionMenu( QgsVectorLayer *layer, const QgsFeature &feature, const QString &actionScope, QWidget *parent SIP_TRANSFERTHIS = nullptr );
70
79 explicit QgsActionMenu( QgsVectorLayer *layer, QgsFeatureId fid, const QString &actionScope, QWidget *parent SIP_TRANSFERTHIS = nullptr );
80
88 void setActionContextGenerator( QgsMapLayerActionContextGenerator *generator );
89
96 void setFeature( const QgsFeature &feature );
97
103 void setMode( QgsAttributeEditorContext::Mode mode );
104
110 void setExpressionContextScope( const QgsExpressionContextScope &scope );
111
117 QgsExpressionContextScope expressionContextScope() const;
118
124 QList<QgsAction> menuActions();
125
131 bool isEmpty() const;
132
133 signals:
134 void reinit();
135
136 private slots:
137 void triggerAction();
138 void reloadActions();
139 void layerWillBeDeleted();
140
141 private:
142 void init();
143 QgsFeature feature();
144
145 QgsVectorLayer *mLayer = nullptr;
146 int mVisibleActionCount = 0;
147 QList<QgsAction> mActions;
148 QgsFeature mFeature;
149 QgsFeatureId mFeatureId;
150 QString mActionScope;
151 QgsExpressionContextScope mExpressionContextScope;
153
154 QgsMapLayerActionContextGenerator *mContextGenerator = nullptr;
155};
156
157
159
160#endif // QGSACTIONMENU_H
ActionType
Action types.
Definition: qgis.h:2749
@ Invalid
Invalid.
Storage and management of actions associated with a layer.
This class is a menu that is populated automatically with the actions defined for a given layer.
Definition: qgsactionmenu.h:39
Utility class that encapsulates an action based on vector attributes.
Definition: qgsaction.h:37
@ SingleEditMode
Single edit mode, for editing a single feature.
Single scope for storing variables and functions for use within a QgsExpressionContext.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
An interface for objects which can create a QgsMapLayerActionContext.
An action which can run on map layers The class can be used in two manners:
Base class for all map layer types.
Definition: qgsmaplayer.h:73
Represents a vector layer which manages a vector based data sets.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
ActionData()=default
Constructor for ActionData.