1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/***************************************************************************
qgsactionmanager.sip
These classes store and control the managment and execution of actions
associated with a particular Qgis layer. Actions are defined to be
external programs that are run with user-specified inputs that can
depend on the contents of layer attributes.
-------------------
begin : Oct 24 2004
copyright : (C) 2004 by Gavin Macaulay
email : gavin at macaulay dot co dot nz
***************************************************************************/
/***************************************************************************
* *
* 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. *
* *
***************************************************************************/
/** \class QgsActionManager
* \brief Storage and management of actions associated with Qgis layer
* attributes.
*/
class QgsActionManager
{
%TypeHeaderCode
#include <qgsactionmanager.h>
%End
public:
//! Constructor
QgsActionManager( QgsVectorLayer *layer );
//! Destructor
virtual ~QgsActionManager();
/** Add an action with the given name and action details.
* Will happily have duplicate names and actions. If
* capture is true, when running the action using doAction(),
* any stdout from the process will be captured and displayed in a
* dialog box.
*/
void addAction( QgsAction::ActionType type, const QString& name, const QString& action, bool capture = false );
/** Add an action with the given name and action details.
* Will happily have duplicate names and actions. If
* capture is true, when running the action using doAction(),
* any stdout from the process will be captured and displayed in a
* dialog box.
*/
void addAction( QgsAction::ActionType type, const QString& name, const QString& action, const QString& icon, bool capture = false );
/**
* Add a new action to this list.
*/
void addAction( const QgsAction& action );
//! Remove an action at given index
void removeAction( int index );
/**
* Does the given action.
*
* @param index Index of the action
* @param feat Feature to run action for
* @param defaultValueIndex Index of the field to be used if the action has a $currfield placeholder.
* @param scope Expression context scope to add during expression evaluation
*/
void doAction( int index,
const QgsFeature &feat,
int defaultValueIndex = 0,
const QgsExpressionContextScope &scope = QgsExpressionContextScope() ) /PyName=doActionFeature/;
/** Does the action using the expression engine to replace any embedded expressions
* in the action definition.
* @param index action index
* @param feature feature to run action for
* @param context expression context to evalute expressions under
* @param substitutionMap deprecated - kept for compatibility with projects, will be removed for 3.0
*/
// TODO QGIS 3.0 remove substition map - force use of expression variables
void doAction( int index,
const QgsFeature& feature,
const QgsExpressionContext& context,
const QMap<QString, QVariant> *substitutionMap = nullptr );
/** Does the action using the expression builder to expand it
* and getting values from the passed feature attribute map.
* substitutionMap is used to pass custom substitutions, to replace
* each key in the map with the associated value
* @note available in python bindings as doActionFeatureWithSubstitution
*/
void doAction( int index,
const QgsFeature &feat,
const QMap<QString, QVariant> *substitutionMap ) /PyName=doActionFeatureWithSubstitution/;
//! Removes all actions
void clearActions();
//! List all actions
QList<QgsAction> listActions() const;
//! Return the layer
QgsVectorLayer* layer() const;
/** Expands the given action, replacing all %'s with the value as
* given.
* @deprecated use QgsExpression::replaceExpressionText() instead
*/
QString expandAction( QString action, const QMap<int, QVariant> &attributes, uint defaultValueIndex ) /Deprecated/;
/** Expands the given action using the expression builder
* This function currently replaces each expression between [% and %]
* placeholders in the action with the result of its evaluation on
* the feature passed as argument.
*
* Additional substitutions can be passed through the substitutionMap
* parameter
* @deprecated use QgsExpression::replaceExpressionText() instead
*/
QString expandAction( const QString& action,
QgsFeature &feat,
const QMap<QString, QVariant> *substitutionMap = 0 ) /Deprecated/;
//! Writes the actions out in XML format
bool writeXML( QDomNode& layer_node, QDomDocument& doc ) const;
//! Reads the actions in in XML format
bool readXML( const QDomNode& layer_node );
int size() const;
/**
* Get the action at the specified index.
*/
QgsAction at( int idx ) const /Factory/;
%MethodCode
if ( a0 < 0 || a0 >= sipCpp->size() )
{
PyErr_SetString(PyExc_KeyError, QByteArray::number(a0));
sipIsErr = 1;
}
else
{
sipRes = new QgsAction( sipCpp->at( a0 ) );
}
%End
/**
* Get the action at the specified index.
*/
QgsAction operator[]( int idx ) const;
%MethodCode
if ( a0 < 0 || a0 >= sipCpp->size() )
{
PyErr_SetString(PyExc_KeyError, QByteArray::number(a0));
sipIsErr = 1;
}
else
{
sipRes = new QgsAction( sipCpp->at( a0 ) );
}
%End
/** @deprecated Initialize QgsPythonRunner instead
* @note not available in Python bindings
*/
// Q_DECL_DEPRECATED static void setPythonExecute( void ( * )( const QString & ) );
/**
* Returns the index of the default action, or -1 if no default action is available.
* @see setDefaultAction()
*/
int defaultAction() const;
/**
* Set the index of the default action.
* @param actionNumber index of action which should be made the default for the layer
* @see defaultAction()
*/
void setDefaultAction( int actionNumber );
};
|
