QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
Public Member Functions | List of all members
QgsActionScope Class Reference

An action scope defines a "place" for an action to be shown and may add additional expression variables. More...

#include <qgsactionscope.h>

Public Member Functions

 QgsActionScope ()
 Creates a new invalid action scope. More...
 
 QgsActionScope (const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope=QgsExpressionContextScope())
 Creates a new action scope. More...
 
QString description () const
 The description should be a longer description of where actions in this scope are available. More...
 
QgsExpressionContextScope expressionContextScope () const
 An expression scope may offer additional variables for an action scope. More...
 
QString id () const
 A unique identifier for this action scope. More...
 
bool isValid () const
 Returns if this scope is valid. More...
 
bool operator== (const QgsActionScope &other) const
 Compares two action scopes. More...
 
void setDescription (const QString &description)
 The description should be a longer description of where actions in this scope are available. More...
 
void setExpressionContextScope (const QgsExpressionContextScope &expressionContextScope)
 An expression scope may offer additional variables for an action scope. More...
 
void setId (const QString &id)
 A unique identifier for this action scope. More...
 
void setTitle (const QString &title)
 The title is a human readable and translated string that will be presented to the user in the properties dialog. More...
 
QString title () const
 The title is a human readable and translated string that will be presented to the user in the properties dialog. More...
 

Detailed Description

An action scope defines a "place" for an action to be shown and may add additional expression variables.

Each QgsAction can be available in one or several action scopes.

Examples:

Canvas
Show for canvas tools. Adds @click_x and @click_y in map coordinates.
Feature
Show in feature specific places like the attribute table or feature form.
Field
Show in context menus for individual fields (e.g. attribute table). Adds @field_index, @field_name and @field_value.
Layer
Show in attribute table and work on the layer or selection.
Since
QGIS 3.0

Definition at line 47 of file qgsactionscope.h.

Constructor & Destructor Documentation

◆ QgsActionScope() [1/2]

QgsActionScope::QgsActionScope ( )
explicit

Creates a new invalid action scope.

Since
QGIS 3.0

Definition at line 19 of file qgsactionscope.cpp.

◆ QgsActionScope() [2/2]

QgsActionScope::QgsActionScope ( const QString &  id,
const QString &  title,
const QString &  description,
const QgsExpressionContextScope expressionContextScope = QgsExpressionContextScope() 
)
explicit

Creates a new action scope.

For details concerning the parameters check the documentation of the corresponding properties.

Definition at line 24 of file qgsactionscope.cpp.

Member Function Documentation

◆ description()

QString QgsActionScope::description ( ) const

The description should be a longer description of where actions in this scope are available.

It is not necessary to list the available expression variables in here, they are extracted automatically from the expressionContextScope().

Since
QGIS 3.0

Definition at line 72 of file qgsactionscope.cpp.

◆ expressionContextScope()

QgsExpressionContextScope QgsActionScope::expressionContextScope ( ) const

An expression scope may offer additional variables for an action scope.

This can be an field_name for the attribute which was clicked or click_x and click_y for actions which are available as map canvas clicks.

Since
QGIS 3.0

Definition at line 37 of file qgsactionscope.cpp.

◆ id()

QString QgsActionScope::id ( ) const

A unique identifier for this action scope.

Since
QGIS 3.0

Definition at line 47 of file qgsactionscope.cpp.

◆ isValid()

bool QgsActionScope::isValid ( ) const

Returns if this scope is valid.

Since
QGIS 3.0

Definition at line 57 of file qgsactionscope.cpp.

◆ operator==()

bool QgsActionScope::operator== ( const QgsActionScope other) const

Compares two action scopes.

Definition at line 32 of file qgsactionscope.cpp.

◆ setDescription()

void QgsActionScope::setDescription ( const QString &  description)

The description should be a longer description of where actions in this scope are available.

It is not necessary to list the available expression variables in here, they are extracted automatically from the expressionContextScope().

Since
QGIS 3.0

Definition at line 77 of file qgsactionscope.cpp.

◆ setExpressionContextScope()

void QgsActionScope::setExpressionContextScope ( const QgsExpressionContextScope expressionContextScope)

An expression scope may offer additional variables for an action scope.

This can be an field_name for the attribute which was clicked or click_x and click_y for actions which are available as map canvas clicks.

Since
QGIS 3.0

Definition at line 42 of file qgsactionscope.cpp.

◆ setId()

void QgsActionScope::setId ( const QString &  id)

A unique identifier for this action scope.

Since
QGIS 3.0

Definition at line 52 of file qgsactionscope.cpp.

◆ setTitle()

void QgsActionScope::setTitle ( const QString &  title)

The title is a human readable and translated string that will be presented to the user in the properties dialog.

Since
QGIS 3.0

Definition at line 67 of file qgsactionscope.cpp.

◆ title()

QString QgsActionScope::title ( ) const

The title is a human readable and translated string that will be presented to the user in the properties dialog.

Since
QGIS 3.0

Definition at line 62 of file qgsactionscope.cpp.


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