This class tracks map layer actions. More...

#include <qgsmaplayeractionregistry.h>

Inheritance diagram for QgsMapLayerActionRegistry:

Signals
void	changed ()
	Triggered when an action is added or removed from the registry.

Public Member Functions
	QgsMapLayerActionRegistry (QObject *parent=nullptr)
	Constructor for QgsMapLayerActionRegistry.

void	addMapLayerAction (QgsMapLayerAction *action)
	Adds a map layer action to the registry.

QgsMapLayerAction *	defaultActionForLayer (QgsMapLayer *layer)
	Returns the default action for a layer.

QList< QgsMapLayerAction * >	mapLayerActions (QgsMapLayer *layer, Qgis::MapLayerActionTargets targets=Qgis::MapLayerActionTarget::AllActions, const QgsMapLayerActionContext &context=QgsMapLayerActionContext())
	Returns the map layer actions which can run on the specified layer.

bool	removeMapLayerAction (QgsMapLayerAction *action)
	Removes a map layer action from the registry.

void	setDefaultActionForLayer (QgsMapLayer layer, QgsMapLayerAction action)
	Sets the default action for a layer.

Protected Attributes
QList< QgsMapLayerAction * >	mMapLayerActionList

Detailed Description

This class tracks map layer actions.

QgsMapLayerActionRegistry is not usually directly created, but rather accessed through QgsGui::mapLayerActionRegistry().

Definition at line 40 of file qgsmaplayeractionregistry.h.

Constructor & Destructor Documentation

◆ QgsMapLayerActionRegistry()

QgsMapLayerActionRegistry::QgsMapLayerActionRegistry ( QObject * parent = nullptr )

Constructor for QgsMapLayerActionRegistry.

QgsMapLayerActionRegistry is not usually directly created, but rather accessed through QgsGui::mapLayerActionRegistry().

Definition at line 19 of file qgsmaplayeractionregistry.cpp.

Member Function Documentation

◆ addMapLayerAction()

void QgsMapLayerActionRegistry::addMapLayerAction ( QgsMapLayerAction * action )

Adds a map layer action to the registry.

Definition at line 24 of file qgsmaplayeractionregistry.cpp.

◆ changed

void QgsMapLayerActionRegistry::changed ( )

signal

Triggered when an action is added or removed from the registry.

◆ defaultActionForLayer()

QgsMapLayerAction * QgsMapLayerActionRegistry::defaultActionForLayer ( QgsMapLayer * layer )

Returns the default action for a layer.

Definition at line 79 of file qgsmaplayeractionregistry.cpp.

◆ mapLayerActions()

QList< QgsMapLayerAction * > QgsMapLayerActionRegistry::mapLayerActions	(	QgsMapLayer *	layer,
		Qgis::MapLayerActionTargets	targets = `Qgis::MapLayerActionTarget::AllActions`,
		const QgsMapLayerActionContext &	context = `QgsMapLayerActionContext()`
	)

Returns the map layer actions which can run on the specified layer.

The context argument was added in QGIS 3.30.

Definition at line 30 of file qgsmaplayeractionregistry.cpp.

◆ removeMapLayerAction()

bool QgsMapLayerActionRegistry::removeMapLayerAction ( QgsMapLayerAction * action )

Removes a map layer action from the registry.

Definition at line 52 of file qgsmaplayeractionregistry.cpp.

◆ setDefaultActionForLayer()

void QgsMapLayerActionRegistry::setDefaultActionForLayer	(	QgsMapLayer *	layer,
		QgsMapLayerAction *	action
	)

Sets the default action for a layer.

Definition at line 74 of file qgsmaplayeractionregistry.cpp.

Member Data Documentation

◆ mMapLayerActionList

QList< QgsMapLayerAction * > QgsMapLayerActionRegistry::mMapLayerActionList

protected

Definition at line 74 of file qgsmaplayeractionregistry.h.

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

/build/qgis-3.34.0+99sid/src/gui/actions/qgsmaplayeractionregistry.h
/build/qgis-3.34.0+99sid/src/gui/actions/qgsmaplayeractionregistry.cpp

Signals

Public Member Functions

Protected Attributes