An action which can run on map layers The class can be used in two manners: More...

#include <qgsmaplayeractionregistry.h>

Inheritance diagram for QgsMapLayerAction:

Public Types
enum	Flag { EnabledOnlyWhenEditable = 1 << 1 }
	Flags which control action behavior /since QGIS 3.0. More...

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

Signals
void	triggeredForFeature (QgsMapLayer *layer, const QgsFeature &feature)
	Triggered when action has been run for a specific feature. More...

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

void	triggeredForLayer (QgsMapLayer *layer)
	Triggered when action has been run for a specific layer. More...

Public Member Functions
	QgsMapLayerAction (const QString &name, QObject parent, QgsMapLayer layer, Targets targets=AllActions, const QIcon &icon=QIcon(), QgsMapLayerAction::Flags flags=QgsMapLayerAction::Flags())
	Creates a map layer action which can run only on a specific layer. More...

	QgsMapLayerAction (const QString &name, QObject *parent, QgsMapLayerType layerType, Targets targets=AllActions, const QIcon &icon=QIcon(), QgsMapLayerAction::Flags flags=QgsMapLayerAction::Flags())
	Creates a map layer action which can run on a specific type of layer. More...

	QgsMapLayerAction (const QString &name, QObject *parent, Targets targets=AllActions, const QIcon &icon=QIcon(), QgsMapLayerAction::Flags flags=QgsMapLayerAction::Flags())
	Action behavior flags. More...

	~QgsMapLayerAction () override

virtual bool	canRunUsingLayer (QgsMapLayer *layer) const
	True if action can run using the specified layer. More...

QgsMapLayerAction::Flags	flags () const
	Layer behavior flags. More...

bool	isEnabledOnlyWhenEditable () const
	Returns `true` if the action is only enabled for layers in editable mode. More...

void	setTargets (Targets targets)
	Define the targets of the action. More...

const Targets &	targets () const
	Returns availibity of action. More...

virtual void	triggerForFeature (QgsMapLayer *layer, const QgsFeature &feature)
	Triggers the action with the specified layer and feature. More...

virtual void	triggerForFeatures (QgsMapLayer *layer, const QList< QgsFeature > &featureList)
	Triggers the action with the specified layer and list of feature. More...

virtual void	triggerForLayer (QgsMapLayer *layer)
	Triggers the action with the specified layer. More...

Detailed Description

An action which can run on map layers The class can be used in two manners:

by instantiating it and connecting to its signals to perform an action
by subclassing and reimplementing its method (only since QGIS 3.18.2)

Definition at line 38 of file qgsmaplayeractionregistry.h.

Member Enumeration Documentation

◆ Flag

enum QgsMapLayerAction::Flag

Flags which control action behavior /since QGIS 3.0.

Enumerator
EnabledOnlyWhenEditable	Action should be shown only for editable layers.

Definition at line 57 of file qgsmaplayeractionregistry.h.

◆ Target

enum QgsMapLayerAction::Target

Enumerator
Layer
SingleFeature
MultipleFeatures
AllActions

Definition at line 43 of file qgsmaplayeractionregistry.h.

Constructor & Destructor Documentation

◆ QgsMapLayerAction() [1/3]

QgsMapLayerAction::QgsMapLayerAction	(	const QString &	name,
		QObject *	parent,
		Targets	targets = `AllActions`,
		const QIcon &	icon = `QIcon()`,
		QgsMapLayerAction::Flags	flags = `QgsMapLayerAction::Flags()`
	)

Action behavior flags.

Since: QGIS 3.0 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 compatibility reasons.

Definition at line 20 of file qgsmaplayeractionregistry.cpp.

◆ QgsMapLayerAction() [2/3]

QgsMapLayerAction::QgsMapLayerAction	(	const QString &	name,
		QObject *	parent,
		QgsMapLayer *	layer,
		Targets	targets = `AllActions`,
		const QIcon &	icon = `QIcon()`,
		QgsMapLayerAction::Flags	flags = `QgsMapLayerAction::Flags()`
	)

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

Definition at line 27 of file qgsmaplayeractionregistry.cpp.

◆ QgsMapLayerAction() [3/3]

QgsMapLayerAction::QgsMapLayerAction	(	const QString &	name,
		QObject *	parent,
		QgsMapLayerType	layerType,
		Targets	targets = `AllActions`,
		const QIcon &	icon = `QIcon()`,
		QgsMapLayerAction::Flags	flags = `QgsMapLayerAction::Flags()`
	)

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

Definition at line 36 of file qgsmaplayeractionregistry.cpp.

◆ ~QgsMapLayerAction()

QgsMapLayerAction::~QgsMapLayerAction ( )

override

Definition at line 45 of file qgsmaplayeractionregistry.cpp.

Member Function Documentation

◆ canRunUsingLayer()

bool QgsMapLayerAction::canRunUsingLayer ( QgsMapLayer * layer ) const

virtual

True if action can run using the specified layer.

Definition at line 56 of file qgsmaplayeractionregistry.cpp.

◆ flags()

QgsMapLayerAction::Flags QgsMapLayerAction::flags ( ) const

Layer behavior flags.

Since: QGIS 3.0

Definition at line 51 of file qgsmaplayeractionregistry.cpp.

◆ isEnabledOnlyWhenEditable()

bool QgsMapLayerAction::isEnabledOnlyWhenEditable ( ) const

Returns true if the action is only enabled for layers in editable mode.

Since: QGIS 3.0

Definition at line 105 of file qgsmaplayeractionregistry.cpp.

◆ setTargets()

void QgsMapLayerAction::setTargets ( Targets targets )

inline

Define the targets of the action.

Definition at line 102 of file qgsmaplayeractionregistry.h.

◆ targets()

const Targets& QgsMapLayerAction::targets ( ) const

inline

Returns availibity of action.

Definition at line 104 of file qgsmaplayeractionregistry.h.

◆ triggeredForFeature

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

signal

Triggered when action has been run for a specific feature.

◆ triggeredForFeatures

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

signal

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

◆ triggeredForLayer

void QgsMapLayerAction::triggeredForLayer ( QgsMapLayer * layer )

signal

Triggered when action has been run for a specific layer.

◆ triggerForFeature()

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

virtual

Triggers the action with the specified layer and feature.

Definition at line 95 of file qgsmaplayeractionregistry.cpp.

◆ triggerForFeatures()

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

virtual

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

Definition at line 90 of file qgsmaplayeractionregistry.cpp.

◆ triggerForLayer()

void QgsMapLayerAction::triggerForLayer ( QgsMapLayer * layer )

virtual

Triggers the action with the specified layer.

Definition at line 100 of file qgsmaplayeractionregistry.cpp.

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

/build/qgis-3.20.0+99unstable/src/gui/qgsmaplayeractionregistry.h
/build/qgis-3.20.0+99unstable/src/gui/qgsmaplayeractionregistry.cpp

Public Types

Signals

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flag

◆ Target

Constructor & Destructor Documentation

◆ QgsMapLayerAction() [1/3]

◆ QgsMapLayerAction() [2/3]

◆ QgsMapLayerAction() [3/3]

◆ ~QgsMapLayerAction()

Member Function Documentation

◆ canRunUsingLayer()

◆ flags()

◆ isEnabledOnlyWhenEditable()

◆ setTargets()

◆ targets()

◆ triggeredForFeature

◆ triggeredForFeatures

◆ triggeredForLayer

◆ triggerForFeature()

◆ triggerForFeatures()

◆ triggerForLayer()