QGIS API Documentation
3.0.2-Girona (307d082)
|
Storage and management of actions associated with a layer. More...
#include <qgsactionmanager.h>
Public Member Functions | |
QgsActionManager (QgsVectorLayer *layer) | |
Constructor. More... | |
QgsAction | action (QUuid id) |
Get an action by its id. More... | |
QList< QgsAction > | actions (const QString &actionScope=QString()) const |
Return a list of actions that are available in the given action scope. More... | |
QUuid | addAction (QgsAction::ActionType type, const QString &name, const QString &command, bool capture=false) |
Add an action with the given name and action details. More... | |
QUuid | addAction (QgsAction::ActionType type, const QString &name, const QString &command, const QString &icon, bool capture=false) |
Add an action with the given name and action details. More... | |
void | addAction (const QgsAction &action) |
Add a new action to this list. More... | |
void | clearActions () |
Removes all actions. More... | |
QgsAction | defaultAction (const QString &actionScope) |
Each scope can have a default action. More... | |
void | doAction (QUuid actionId, const QgsFeature &feature, int defaultValueIndex=0, const QgsExpressionContextScope &scope=QgsExpressionContextScope()) |
Does the given action. More... | |
void | doAction (QUuid actionId, const QgsFeature &feature, const QgsExpressionContext &context) |
Does the action using the expression engine to replace any embedded expressions in the action definition. More... | |
QgsVectorLayer * | layer () const |
Return the layer. More... | |
bool | readXml (const QDomNode &layer_node) |
Reads the actions in in XML format. More... | |
void | removeAction (QUuid actionId) |
Remove an action by its id. More... | |
void | setDefaultAction (const QString &actionScope, QUuid actionId) |
Each scope can have a default action. More... | |
bool | writeXml (QDomNode &layer_node) const |
Writes the actions out in XML format. More... | |
Storage and management of actions associated with a layer.
Actions can trigger custom code or applications to be executed based on attributes of a given feature.
Definition at line 51 of file qgsactionmanager.h.
|
inline |
Constructor.
Definition at line 57 of file qgsactionmanager.h.
QgsAction QgsActionManager::action | ( | QUuid | id | ) |
QList< QgsAction > QgsActionManager::actions | ( | const QString & | actionScope = QString() | ) | const |
Return a list of actions that are available in the given action scope.
If no action scope is provided, all actions will be returned.
Definition at line 171 of file qgsactionmanager.cpp.
QUuid QgsActionManager::addAction | ( | QgsAction::ActionType | type, |
const QString & | name, | ||
const QString & | command, | ||
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.
Definition at line 45 of file qgsactionmanager.cpp.
QUuid QgsActionManager::addAction | ( | QgsAction::ActionType | type, |
const QString & | name, | ||
const QString & | command, | ||
const QString & | icon, | ||
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.
Definition at line 52 of file qgsactionmanager.cpp.
void QgsActionManager::addAction | ( | const QgsAction & | action | ) |
Add a new action to this list.
Definition at line 59 of file qgsactionmanager.cpp.
void QgsActionManager::clearActions | ( | ) |
Removes all actions.
Definition at line 159 of file qgsactionmanager.cpp.
QgsAction QgsActionManager::defaultAction | ( | const QString & | actionScope | ) |
Each scope can have a default action.
This will be saved in the project file.
Definition at line 286 of file qgsactionmanager.cpp.
void QgsActionManager::doAction | ( | QUuid | actionId, |
const QgsFeature & | feature, | ||
int | defaultValueIndex = 0 , |
||
const QgsExpressionContextScope & | scope = QgsExpressionContextScope() |
||
) |
Does the given action.
actionId | action id |
feature | feature to run action for |
defaultValueIndex | index of the field to be used if the action has a $currfield placeholder. |
scope | expression context scope to add during expression evaluation |
Definition at line 126 of file qgsactionmanager.cpp.
void QgsActionManager::doAction | ( | QUuid | actionId, |
const QgsFeature & | feature, | ||
const QgsExpressionContext & | context | ||
) |
Does the action using the expression engine to replace any embedded expressions in the action definition.
actionId | action id |
feature | feature to run action for |
context | expression context to evaluate expressions under |
Definition at line 138 of file qgsactionmanager.cpp.
|
inline |
Return the layer.
Definition at line 124 of file qgsactionmanager.h.
bool QgsActionManager::readXml | ( | const QDomNode & | layer_node | ) |
Reads the actions in in XML format.
Definition at line 243 of file qgsactionmanager.cpp.
void QgsActionManager::removeAction | ( | QUuid | actionId | ) |
void QgsActionManager::setDefaultAction | ( | const QString & | actionScope, |
QUuid | actionId | ||
) |
Each scope can have a default action.
This will be saved in the project file.
Definition at line 281 of file qgsactionmanager.cpp.
bool QgsActionManager::writeXml | ( | QDomNode & | layer_node | ) | const |
Writes the actions out in XML format.
Definition at line 223 of file qgsactionmanager.cpp.