QgsMapLayerAction Class Reference

An action which can run on map layers. More...

#include <qgsmaplayeractionregistry.h>

Public Types
enum	Target { Layer = 1, SingleFeature = 2, MultipleFeatures = 4, AllActions = Layer | SingleFeature | MultipleFeatures }

Signals
void	triggeredForFeatures (QgsMapLayer *layer, const QList< QgsFeature > featureList)
	Triggered when action has been run for a specific list of features.
void	triggeredForFeature (QgsMapLayer *layer, const QgsFeature &feature)
	Triggered when action has been run for a specific feature.
void	triggeredForLayer (QgsMapLayer *layer)
	Triggered when action has been run for a specific layer.

Public Member Functions
	QgsMapLayerAction (QString name, QObject *parent, Targets targets=AllActions)
	Creates a map layer action which can run on any layer.
	QgsMapLayerAction (QString name, QObject *parent, QgsMapLayer *layer, Targets targets=AllActions)
	Creates a map layer action which can run only on a specific layer.
	QgsMapLayerAction (QString name, QObject *parent, QgsMapLayer::LayerType layerType, Targets targets=AllActions)
	Creates a map layer action which can run on a specific type of layer.
	~QgsMapLayerAction ()
bool	canRunUsingLayer (QgsMapLayer *layer) const
	True if action can run using the specified layer.
void	triggerForFeatures (QgsMapLayer *layer, const QList< QgsFeature > featureList)
	Triggers the action with the specified layer and list of feature.
void	triggerForFeature (QgsMapLayer *layer, const QgsFeature *feature)
	Triggers the action with the specified layer and feature.
void	triggerForLayer (QgsMapLayer *layer)
	Triggers the action with the specified layer.
void	setTargets (Targets targets)
	Define the targets of the action.
const Targets &	targets () const
	Return availibity of action.

Detailed Description

An action which can run on map layers.

Member Enumeration Documentation

enum QgsMapLayerAction::Target

Enumerator:

Layer
SingleFeature
MultipleFeatures
AllActions

Constructor & Destructor Documentation

QgsMapLayerAction::QgsMapLayerAction	(	QString	name,
		QObject *	parent,
		Targets	targets = AllActions
	)

Creates a map layer action which can run on any layer.

Note

using AllActions as a target probably does not make a lot of sense. This default action was settled for API compatiblity reasons.

QgsMapLayerAction::QgsMapLayerAction	(	QString	name,
		QObject *	parent,
		QgsMapLayer *	layer,
		Targets	targets = AllActions
	)

Creates a map layer action which can run only on a specific layer.

QgsMapLayerAction::QgsMapLayerAction	(	QString	name,
		QObject *	parent,
		QgsMapLayer::LayerType	layerType,
		Targets	targets = AllActions
	)

Creates a map layer action which can run on a specific type of layer.

QgsMapLayerAction::~QgsMapLayerAction

(

)

Member Function Documentation

bool QgsMapLayerAction::canRunUsingLayer

(

QgsMapLayer *

layer

)

const

True if action can run using the specified layer.

void QgsMapLayerAction::setTargets ( Targets  targets )

inline

Define the targets of the action.

const Targets& QgsMapLayerAction::targets ( ) const

inline

Return availibity of action.

void QgsMapLayerAction::triggeredForFeature ( QgsMapLayer *  layer, const QgsFeature &  feature  )

signal

Triggered when action has been run for a specific feature.

void QgsMapLayerAction::triggeredForFeatures ( QgsMapLayer *  layer, const QList< QgsFeature >  featureList  )

signal

Triggered when action has been run for a specific list of features.

void QgsMapLayerAction::triggeredForLayer ( QgsMapLayer *  layer )

signal

Triggered when action has been run for a specific layer.

void QgsMapLayerAction::triggerForFeature	(	QgsMapLayer *	layer,
		const QgsFeature *	feature
	)

Triggers the action with the specified layer and feature.

void QgsMapLayerAction::triggerForFeatures	(	QgsMapLayer *	layer,
		const QList< QgsFeature >	featureList
	)

Triggers the action with the specified layer and list of feature.

void QgsMapLayerAction::triggerForLayer

(

QgsMapLayer *

layer

)

Triggers the action with the specified layer.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaplayeractionregistry.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaplayeractionregistry.cpp