QGIS API Documentation  2.99.0-Master (19b062c)
Public Member Functions | List of all members
QgsActionManager Class Reference

Storage and management of actions associated with a layer. More...

#include <qgsactionmanager.h>

Inheritance diagram for QgsActionManager:
Inheritance graph
[legend]

Public Member Functions

 QgsActionManager (QgsVectorLayer *layer)
 Constructor. More...
 
QgsAction action (const QUuid &id)
 Get an action by its id. More...
 
QList< QgsActionactions (const QString &actionScope=QString()) const
 Return a list of actions that are available in the given action scope. More...
 
QUuid addAction (QgsAction::ActionType type, const QString &name, const QString &command, bool capture=false)
 Add an action with the given name and action details. More...
 
QUuid addAction (QgsAction::ActionType type, const QString &name, const QString &command, const QString &icon, bool capture=false)
 Add an action with the given name and action details. More...
 
void addAction (const QgsAction &action)
 Add a new action to this list. More...
 
void clearActions ()
 Removes all actions. More...
 
QgsAction defaultAction (const QString &actionScope)
 Each scope can have a default action. More...
 
void doAction (const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex=0, const QgsExpressionContextScope &scope=QgsExpressionContextScope())
 Does the given action. More...
 
void doAction (const QUuid &actionId, const QgsFeature &feature, const QgsExpressionContext &context)
 Does the action using the expression engine to replace any embedded expressions in the action definition. More...
 
QgsVectorLayerlayer () const
 Return the layer. More...
 
bool readXml (const QDomNode &layer_node)
 Reads the actions in in XML format. More...
 
void removeAction (const QUuid &actionId)
 Remove an action by its id. More...
 
void setDefaultAction (const QString &actionScope, const QUuid &actionId)
 Each scope can have a default action. More...
 
bool writeXml (QDomNode &layer_node) const
 Writes the actions out in XML format. More...
 

Detailed Description

Storage and management of actions associated with a layer.

Actions can trigger custom code or applications to be executed based on attributes of a given feature.

Definition at line 51 of file qgsactionmanager.h.

Constructor & Destructor Documentation

◆ QgsActionManager()

QgsActionManager::QgsActionManager ( QgsVectorLayer layer)
inline

Constructor.

Definition at line 57 of file qgsactionmanager.h.

Member Function Documentation

◆ action()

QgsAction QgsActionManager::action ( const QUuid &  id)

Get an action by its id.

Since
QGIS 3.0

Definition at line 270 of file qgsactionmanager.cpp.

◆ actions()

QList< QgsAction > QgsActionManager::actions ( const QString &  actionScope = QString()) const

Return a list of actions that are available in the given action scope.

If no action scope is provided, all actions will be returned.

Since
QGIS 3.0

Definition at line 171 of file qgsactionmanager.cpp.

◆ addAction() [1/3]

QUuid QgsActionManager::addAction ( QgsAction::ActionType  type,
const QString &  name,
const QString &  command,
bool  capture = false 
)

Add an action with the given name and action details.

Will happily have duplicate names and actions. If capture is true, when running the action using doAction(), any stdout from the process will be captured and displayed in a dialog box.

Definition at line 45 of file qgsactionmanager.cpp.

◆ addAction() [2/3]

QUuid QgsActionManager::addAction ( QgsAction::ActionType  type,
const QString &  name,
const QString &  command,
const QString &  icon,
bool  capture = false 
)

Add an action with the given name and action details.

Will happily have duplicate names and actions. If capture is true, when running the action using doAction(), any stdout from the process will be captured and displayed in a dialog box.

Definition at line 52 of file qgsactionmanager.cpp.

◆ addAction() [3/3]

void QgsActionManager::addAction ( const QgsAction action)

Add a new action to this list.

Definition at line 59 of file qgsactionmanager.cpp.

◆ clearActions()

void QgsActionManager::clearActions ( )

Removes all actions.

Definition at line 159 of file qgsactionmanager.cpp.

◆ defaultAction()

QgsAction QgsActionManager::defaultAction ( const QString &  actionScope)

Each scope can have a default action.

This will be saved in the project file.

Since
QGIS 3.0

Definition at line 286 of file qgsactionmanager.cpp.

◆ doAction() [1/2]

void QgsActionManager::doAction ( const QUuid &  actionId,
const QgsFeature feature,
int  defaultValueIndex = 0,
const QgsExpressionContextScope scope = QgsExpressionContextScope() 
)

Does the given action.

Parameters
actionIdaction id
featurefeature to run action for
defaultValueIndexindex of the field to be used if the action has a $currfield placeholder.
scopeexpression context scope to add during expression evaluation
Note
available in Python bindings as doActionFeature

Definition at line 126 of file qgsactionmanager.cpp.

◆ doAction() [2/2]

void QgsActionManager::doAction ( const QUuid &  actionId,
const QgsFeature feature,
const QgsExpressionContext context 
)

Does the action using the expression engine to replace any embedded expressions in the action definition.

Parameters
actionIdaction id
featurefeature to run action for
contextexpression context to evaluate expressions under

Definition at line 138 of file qgsactionmanager.cpp.

◆ layer()

QgsVectorLayer* QgsActionManager::layer ( ) const
inline

Return the layer.

Definition at line 124 of file qgsactionmanager.h.

◆ readXml()

bool QgsActionManager::readXml ( const QDomNode &  layer_node)

Reads the actions in in XML format.

Definition at line 243 of file qgsactionmanager.cpp.

◆ removeAction()

void QgsActionManager::removeAction ( const QUuid &  actionId)

Remove an action by its id.

Since
QGIS 3.0

Definition at line 98 of file qgsactionmanager.cpp.

◆ setDefaultAction()

void QgsActionManager::setDefaultAction ( const QString &  actionScope,
const QUuid &  actionId 
)

Each scope can have a default action.

This will be saved in the project file.

Since
QGIS 3.0

Definition at line 281 of file qgsactionmanager.cpp.

◆ writeXml()

bool QgsActionManager::writeXml ( QDomNode &  layer_node) const

Writes the actions out in XML format.

Definition at line 223 of file qgsactionmanager.cpp.


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