QGIS API Documentation  2.99.0-Master (b698612)
Signals | Public Member Functions | Protected Attributes | List of all members
QgsMapLayerActionRegistry Class Reference

This class tracks map layer actions. More...

#include <qgsmaplayeractionregistry.h>

Inheritance diagram for QgsMapLayerActionRegistry:
Inheritance graph
[legend]

Signals

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

Public Member Functions

 QgsMapLayerActionRegistry (QObject *parent=nullptr)
 Constructor for QgsMapLayerActionRegistry. More...
 
void addMapLayerAction (QgsMapLayerAction *action)
 Adds a map layer action to the registry. More...
 
QgsMapLayerActiondefaultActionForLayer (QgsMapLayer *layer)
 Returns the default action for a layer. More...
 
QList< QgsMapLayerAction * > mapLayerActions (QgsMapLayer *layer, QgsMapLayerAction::Targets targets=QgsMapLayerAction::AllActions)
 Returns the map layer actions which can run on the specified layer. More...
 
bool removeMapLayerAction (QgsMapLayerAction *action)
 Removes a map layer action from the registry. More...
 
void setDefaultActionForLayer (QgsMapLayer *layer, QgsMapLayerAction *action)
 Sets the default action for a layer. More...
 

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 111 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 97 of file qgsmaplayeractionregistry.cpp.

Member Function Documentation

◆ addMapLayerAction()

void QgsMapLayerActionRegistry::addMapLayerAction ( QgsMapLayerAction action)

Adds a map layer action to the registry.

Definition at line 102 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 150 of file qgsmaplayeractionregistry.cpp.

◆ mapLayerActions()

QList< QgsMapLayerAction *> QgsMapLayerActionRegistry::mapLayerActions ( QgsMapLayer layer,
QgsMapLayerAction::Targets  targets = QgsMapLayerAction::AllActions 
)

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

Definition at line 108 of file qgsmaplayeractionregistry.cpp.

◆ removeMapLayerAction()

bool QgsMapLayerActionRegistry::removeMapLayerAction ( QgsMapLayerAction action)

Removes a map layer action from the registry.

Definition at line 123 of file qgsmaplayeractionregistry.cpp.

◆ setDefaultActionForLayer()

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

Sets the default action for a layer.

Definition at line 145 of file qgsmaplayeractionregistry.cpp.

Member Data Documentation

◆ mMapLayerActionList

QList< QgsMapLayerAction * > QgsMapLayerActionRegistry::mMapLayerActionList
protected

Definition at line 141 of file qgsmaplayeractionregistry.h.


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