Class: QgsAction¶

Utility class that encapsulates an action based on vector attributes.

Enums

Methods

`actionScopes`	The action scopes define where an action will be available.
`capture`	Whether to capture output for display when this action is run
`command`	Returns the command that is executed by this action.
`expressionContextScope`	Returns an expression context scope used for running the action.
`html`	Returns an HTML table with the basic information about this action.
`icon`	The icon
`iconPath`	The path to the icon
`id`	Returns a unique id for this action.
`isEnabledOnlyWhenEditable`	Returns whether only enabled in editable mode
`isValid`	Returns `True` if this action was a default constructed one.
`name`	The name of the action.
`notificationMessage`	Returns the notification message that triggers the action
`readXml`	Reads an XML definition from actionNode into this object.
`run`	Run this action.
`runable`	Checks if the action is runable on the current platform
`setActionScopes`	The action scopes define where an action will be available.
`setCommand`	Sets the action command.
`setEnabledOnlyWhenEditable`	Set whether the action is only enabled in editable mode
`setExpressionContextScope`	Sets an expression context scope to use for running the action.
`shortTitle`	The short title is used to label user interface elements like buttons
`type`	The action type
`writeXml`	Appends an XML definition for this action as a new child node to actionsNode.

class qgis.core.QgsAction[source]¶

Bases: object

__init__(type: Qgis.AttributeActionType, description: str | None, command: str | None, capture: bool = False)

Create a new QgsAction

Parameters:

type (Qgis.AttributeActionType) – The type of this action
description (Optional[str]) – A human readable description string
command (Optional[str]) – The action text. Its interpretation depends on the type
capture (bool = False) – If this is set to True, the output will be captured when an action is run

Create a new QgsAction

Parameters:

type (Qgis.AttributeActionType) – The type of this action
description (Optional[str]) – A human readable description string
action (Optional[str]) – The action text. Its interpretation depends on the type
icon (Optional[str]) – Path to an icon for this action
capture (bool) – If this is set to True, the output will be captured when an action is run
shortTitle (Optional[str] = '') – A short string used to label user interface elements like buttons
actionScopes (Iterable[Optional[str]] = set()) – A set of scopes in which this action will be available
notificationMessage (Optional[str] = '') – A particular message which reception will trigger the action

Create a new QgsAction

Parameters:

id (QUuid) – The unique identifier of this action
type (Qgis.AttributeActionType) – The type of this action
description (Optional[str]) – A human readable description string
action (Optional[str]) – The action text. Its interpretation depends on the type
icon (Optional[str]) – Path to an icon for this action
capture (bool) – If this is set to True, the output will be captured when an action is run
shortTitle (Optional[str] = '') – A short string used to label user interface elements like buttons
actionScopes (Iterable[Optional[str]] = set()) – A set of scopes in which this action will be available
notificationMessage (Optional[str] = '') – A particular message which reception will trigger the action

__init__(a0: QgsAction)

actionScopes(self) → Set[str]¶

The action scopes define where an action will be available. Action scopes may offer additional variables like the clicked coordinate.