QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
QgsAttributeAction Class Reference

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, QString name, QString action, bool capture=false)
 Add an action with the given name and action details. More...
 
void addAction (QgsAction::ActionType type, QString name, QString action, const QString &icon, bool capture=false)
 Add an action with the given name and action details. More...
 
void removeAction (int index)
 Remove an action at given index. More...
 
void doAction (int index, const QgsFeature &feat, int defaultValueIndex=0)
 
void doAction (int index, const QgsFeature &feat, const QMap< QString, QVariant > *substitutionMap)
 
void clearActions ()
 Removes all actions. More...
 
const QList< QgsAction > & listActions ()
 List all actions. More...
 
QgsVectorLayerlayer ()
 Return the layer. More...
 
QString expandAction (QString action, const QgsAttributeMap &attributes, uint defaultValueIndex)
 
QString expandAction (QString action, QgsFeature &feat, const QMap< QString, QVariant > *substitutionMap=0)
 
bool writeXML (QDomNode &layer_node, QDomDocument &doc) const
 Writes the actions out in XML format. More...
 
bool readXML (const QDomNode &layer_node)
 Reads the actions in in XML format. More...
 
int size () const
 
QgsActionat (int idx)
 
QgsActionoperator[] (int idx)
 
int defaultAction () const
 Whether the action is the default action. More...
 
void setDefaultAction (int actionNumber)
 

Static Public Member Functions

static void setPythonExecute (void(*)(const QString &))
 

Detailed Description

Storage and management of actions associated with Qgis layer attributes.

Constructor & Destructor Documentation

QgsAttributeAction::QgsAttributeAction ( QgsVectorLayer layer)
inline

Constructor.

virtual QgsAttributeAction::~QgsAttributeAction ( )
inlinevirtual

Destructor.

Member Function Documentation

void QgsAttributeAction::addAction ( QgsAction::ActionType  type,
QString  name,
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 QgsAttributeAction::addAction ( QgsAction::ActionType  type,
QString  name,
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.

QgsAction& QgsAttributeAction::at ( int  idx)
inline
void QgsAttributeAction::clearActions ( )
inline

Removes all actions.

int QgsAttributeAction::defaultAction ( ) const
inline

Whether the action is the default action.

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.

Note
added in 1.9
available in python bindings as doActionFeature
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

Note
added in 1.9
available in python bindings as doActionFeatureWithSubstitution
QString QgsAttributeAction::expandAction ( QString  action,
const QgsAttributeMap attributes,
uint  defaultValueIndex 
)

Expands the given action, replacing all 's with the value as given.

QString QgsAttributeAction::expandAction ( 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

Note
added in 1.9
QgsVectorLayer* QgsAttributeAction::layer ( )
inline

Return the layer.

const QList<QgsAction>& QgsAttributeAction::listActions ( )
inline

List all actions.

QgsAction& QgsAttributeAction::operator[] ( int  idx)
inline
bool QgsAttributeAction::readXML ( const QDomNode &  layer_node)

Reads the actions in in XML format.

void QgsAttributeAction::removeAction ( int  index)

Remove an action at given index.

void QgsAttributeAction::setDefaultAction ( int  actionNumber)
inline
void QgsAttributeAction::setPythonExecute ( void(*)(const QString &)  runPython)
static
Deprecated:
Initialize QgsPythonRunner instead
int QgsAttributeAction::size ( ) const
inline
bool QgsAttributeAction::writeXML ( QDomNode &  layer_node,
QDomDocument &  doc 
) const

Writes the actions out in XML format.


The documentation for this class was generated from the following files: