Storage and management of actions associated with Qgis layer attributes. More...

#include <qgsattributeaction.h>

Collaboration diagram for QgsAttributeAction:

Public Member Functions
	QgsAttributeAction (QgsVectorLayer *layer)
	Constructor.
virtual	~QgsAttributeAction ()
	Destructor.
void	addAction (QgsAction::ActionType type, QString name, QString action, bool capture=false)
	Add an action with the given name and action details.
Q_DECL_DEPRECATED void	doAction (int index, const QgsAttributeMap &attributes, int defaultValueIndex=0, void(*executePython)(const QString &)=0)
void	doAction (int index, QgsFeature &feat, int defaultValueIndex=0)
void	doAction (int index, QgsFeature &feat, const QMap< QString, QVariant > *substitutionMap=0)
void	clearActions ()
	Removes all actions.
QgsVectorLayer *	layer ()
	Return the layer.
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.
bool	readXML (const QDomNode &layer_node)
	Reads the actions in in XML format.
int	size () const
QgsAction &	at (int idx)
QgsAction &	operator[] (int idx)
int	defaultAction () const
	Whether the action is the default action.
void	setDefaultAction (int actionNumber)
Static Public Member Functions
static void	setPythonExecute (void(*)(const QString &))
Private Member Functions
void	runAction (const QgsAction &action, void(*executePython)(const QString &)=0)
Private Attributes
QList< QgsAction >	mActions
QgsVectorLayer *	mLayer
int	mDefaultAction
Static Private Attributes
static void(*	smPythonExecute )(const QString &)

Detailed Description

Storage and management of actions associated with Qgis layer attributes.

Definition at line 96 of file qgsattributeaction.h.

Constructor & Destructor Documentation

QgsAttributeAction::QgsAttributeAction ( QgsVectorLayer * layer ) [inline]

Constructor.

Definition at line 100 of file qgsattributeaction.h.

virtual QgsAttributeAction::~QgsAttributeAction ( ) [inline, virtual]

Destructor.

Definition at line 103 of file qgsattributeaction.h.

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.

Definition at line 43 of file qgsattributeaction.cpp.

References mActions.

Referenced by readXML().

QgsAction& QgsAttributeAction::at ( int idx ) [inline]

Definition at line 174 of file qgsattributeaction.h.

Referenced by doAction().

void QgsAttributeAction::clearActions ( ) [inline]

Removes all actions.

Definition at line 142 of file qgsattributeaction.h.

int QgsAttributeAction::defaultAction ( ) const [inline]

Whether the action is the default action.

Definition at line 181 of file qgsattributeaction.h.

References size.

void QgsAttributeAction::doAction	(	int	index,
		const QgsAttributeMap &	attributes,
		int	defaultValueIndex = `0`,
		void(*)(const QString &)	executePython = `0`
	)

Does the action using the given values. defaultValueIndex is an index into values which indicates which value in the values vector is to be used if the action has a default placeholder.

Note:: parameter executePython deprecated (and missing in python binding)

Deprecated:

Definition at line 48 of file qgsattributeaction.cpp.

References QgsAction::action(), at(), QgsAction::capture(), expandAction(), QgsAction::name(), QgsAction::runable(), runAction(), size(), and QgsAction::type().

Referenced by doAction().

void QgsAttributeAction::doAction	(	int	index,
		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

Definition at line 76 of file qgsattributeaction.cpp.

References QgsFeature::attributeMap(), and doAction().

void QgsAttributeAction::doAction	(	int	index,
		QgsFeature &	feat,
		const QMap< QString, QVariant > *	substitutionMap = `0`
	)

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

Definition at line 88 of file qgsattributeaction.cpp.

References QgsAction::action(), at(), QgsAction::capture(), expandAction(), QgsAction::name(), QgsAction::runable(), runAction(), size(), and QgsAction::type().

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 143 of file qgsattributeaction.cpp.

References QgsVectorLayer::attributeDisplayName(), mLayer, and QgsVectorLayer::pendingFields().

Referenced by doAction().

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