QGIS API Documentation
2.12.0-Lyon
|
Storage and management of actions associated with Qgis layer attributes. More...
#include <qgsattributeaction.h>
Public Member Functions | |
QgsAttributeAction (QgsVectorLayer *layer) | |
Constructor. More... | |
virtual | ~QgsAttributeAction () |
Destructor. More... | |
void | addAction (QgsAction::ActionType type, const QString &name, const QString &action, bool capture=false) |
Add an action with the given name and action details. More... | |
void | addAction (QgsAction::ActionType type, const QString &name, const QString &action, const QString &icon, bool capture=false) |
Add an action with the given name and action details. More... | |
QgsAction & | at (int idx) |
void | clearActions () |
Removes all actions. More... | |
int | defaultAction () const |
Whether the action is the default action. More... | |
void | doAction (int index, const QgsFeature &feat, int defaultValueIndex=0) |
Does the given values. More... | |
void | doAction (int index, const QgsFeature &feat, const QMap< QString, QVariant > *substitutionMap) |
Does the action using the expression builder to expand it and getting values from the passed feature attribute map. More... | |
QString | expandAction (QString action, const QgsAttributeMap &attributes, uint defaultValueIndex) |
Expands the given action, replacing all 's with the value as given. More... | |
QString | expandAction (const QString &action, QgsFeature &feat, const QMap< QString, QVariant > *substitutionMap=0) |
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. More... | |
QgsVectorLayer * | layer () |
Return the layer. More... | |
const QList< QgsAction > & | listActions () |
List all actions. More... | |
QgsAction & | operator[] (int idx) |
bool | readXML (const QDomNode &layer_node) |
Reads the actions in in XML format. More... | |
void | removeAction (int index) |
Remove an action at given index. More... | |
void | setDefaultAction (int actionNumber) |
int | size () const |
bool | writeXML (QDomNode &layer_node, QDomDocument &doc) const |
Writes the actions out in XML format. More... | |
Static Public Member Functions | |
static void | setPythonExecute (void(*)(const QString &)) |
Storage and management of actions associated with Qgis layer attributes.
Definition at line 107 of file qgsattributeaction.h.
|
inline |
Constructor.
Definition at line 111 of file qgsattributeaction.h.
|
inlinevirtual |
Destructor.
Definition at line 114 of file qgsattributeaction.h.
void QgsAttributeAction::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.
Definition at line 43 of file qgsattributeaction.cpp.
void QgsAttributeAction::addAction | ( | QgsAction::ActionType | type, |
const QString & | name, | ||
const QString & | action, | ||
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 48 of file qgsattributeaction.cpp.
|
inline |
Definition at line 187 of file qgsattributeaction.h.
|
inline |
Removes all actions.
Definition at line 154 of file qgsattributeaction.h.
|
inline |
Whether the action is the default action.
Definition at line 194 of file qgsattributeaction.h.
void QgsAttributeAction::doAction | ( | int | index, |
const QgsFeature & | feat, | ||
int | defaultValueIndex = 0 |
||
) |
Does the given values.
defaultValueIndex is the index of the field to be used if the action has a $currfield placeholder.
Definition at line 61 of file qgsattributeaction.cpp.
void QgsAttributeAction::doAction | ( | int | index, |
const QgsFeature & | feat, | ||
const QMap< QString, QVariant > * | substitutionMap | ||
) |
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
Definition at line 74 of file qgsattributeaction.cpp.
QString QgsAttributeAction::expandAction | ( | QString | action, |
const QgsAttributeMap & | attributes, | ||
uint | defaultValueIndex | ||
) |
Expands the given action, replacing all 's with the value as given.
Definition at line 141 of file qgsattributeaction.cpp.
QString QgsAttributeAction::expandAction | ( | const QString & | action, |
QgsFeature & | feat, | ||
const QMap< QString, QVariant > * | substitutionMap = 0 |
||
) |
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
Definition at line 191 of file qgsattributeaction.cpp.
|
inline |
Return the layer.
Definition at line 160 of file qgsattributeaction.h.
List all actions.
Definition at line 157 of file qgsattributeaction.h.
|
inline |
Definition at line 188 of file qgsattributeaction.h.
bool QgsAttributeAction::readXML | ( | const QDomNode & | layer_node | ) |
Reads the actions in in XML format.
Definition at line 270 of file qgsattributeaction.cpp.
void QgsAttributeAction::removeAction | ( | int | index | ) |
Remove an action at given index.
Definition at line 53 of file qgsattributeaction.cpp.
|
inline |
Definition at line 195 of file qgsattributeaction.h.
|
static |
Definition at line 294 of file qgsattributeaction.cpp.
|
inline |
Definition at line 186 of file qgsattributeaction.h.
bool QgsAttributeAction::writeXML | ( | QDomNode & | layer_node, |
QDomDocument & | doc | ||
) | const |
Writes the actions out in XML format.
Definition at line 251 of file qgsattributeaction.cpp.