Class: QgsActionScope¶
- class qgis.core.QgsActionScope¶
Bases:
sip.wrapper
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:¶
<dl> <dt>Canvas</dt> <dd>Show for canvas tools. Adds @click_x and @click_y in map coordinates.</dd> <dt>Feature</dt> <dd>Show in feature specific places like the attribute table or feature form.</dd> <dt>Field</dt> <dd>Show in context menus for individual fields (e.g. attribute table). Adds @field_index, @field_name and @field_value.</dd> <dt>Layer</dt> <dd>Show in attribute table and work on the layer or selection.</dd> </dl>
QgsActionScope() Creates a new invalid action scope.
QgsActionScope(id: str, title: str, description: str, expressionContextScope:
QgsExpressionContextScope
= QgsExpressionContextScope()) Creates a new action scope. For details concerning the parameters check the documentation of the corresponding properties.QgsActionScope(
QgsActionScope
)Methods
The description should be a longer description of where actions in this scope are available.
An expression scope may offer additional variables for an action scope.
A unique identifier for this action scope.
Returns if this scope is valid.
copydoc
description()
copydoc
expressionContextScope()
copydoc
id()
copydoc
title()
The title is a human readable and translated string that will be presented to the user in the properties dialog.
- description(self) str ¶
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()
.- Return type:
str
- expressionContextScope(self) QgsExpressionContextScope ¶
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.
- Return type:
- id(self) str ¶
A unique identifier for this action scope.
- Return type:
str
- isValid(self) bool ¶
Returns if this scope is valid.
- Return type:
bool
- setDescription(self, description: str)¶
copydoc
description()
- Parameters:
description (str)
- setExpressionContextScope(self, expressionContextScope: QgsExpressionContextScope)¶
copydoc
expressionContextScope()
- Parameters:
expressionContextScope (QgsExpressionContextScope)
- title(self) str ¶
The title is a human readable and translated string that will be presented to the user in the properties dialog.
- Return type:
str