QgsProcessingToolboxAction Class Reference

A custom action to show in the Processing toolbox. More...

#include <qgsprocessingprovideractions.h>

Public Member Functions
	QgsProcessingToolboxAction (const QString &name=QString(), const QString &group=QString())
	Constructor for QgsProcessingToolboxAction.
virtual	~QgsProcessingToolboxAction ()
QString	actionName () const
	Returns the action's (translated, user visible) name.
Q_DECL_DEPRECATED QgsDockWidget *	data () const
	Returns the parent toolbox widget the action will be shown in.
virtual Q_DECL_DEPRECATED void	execute ()
	Executes the action.
virtual Q_DECL_DEPRECATED QIcon	getIcon () const
	Returns the icon to use for the action.
QString	groupName () const
	Returns the action's (translated, user visible) group name.
virtual QIcon	icon () const
	Returns the icon to use for the action.
Q_DECL_DEPRECATED void	setActionName (const QString &name)
	Sets the action's (translated, user visible) name.
Q_DECL_DEPRECATED void	setData (QgsDockWidget *widget)
	Sets the parent toolbox widget the action will be shown in.
Q_DECL_DEPRECATED void	setGroupName (const QString &group)
	Sets the action's (translated, user visible) group name.
virtual void	trigger (const QgsProcessingActionContext &context)
	Triggers the action.

Detailed Description

A custom action to show in the Processing toolbox.

Since

QGIS 4.4

Definition at line 92 of file qgsprocessingprovideractions.h.

Constructor & Destructor Documentation

QgsProcessingToolboxAction()

QgsProcessingToolboxAction::QgsProcessingToolboxAction	(	const QString &	name = QString(),
		const QString &	group = QString() )

Constructor for QgsProcessingToolboxAction.

Definition at line 61 of file qgsprocessingprovideractions.cpp.

~QgsProcessingToolboxAction()

QgsProcessingToolboxAction::~QgsProcessingToolboxAction ( )

virtualdefault

Member Function Documentation

actionName()

QString QgsProcessingToolboxAction::actionName ( ) const

inline

Returns the action's (translated, user visible) name.

Definition at line 106 of file qgsprocessingprovideractions.h.

data()

QgsDockWidget * QgsProcessingToolboxAction::data

(

)

const

Returns the parent toolbox widget the action will be shown in.

Deprecated

QGIS 4.4

Definition at line 123 of file qgsprocessingprovideractions.cpp.

execute()

void QgsProcessingToolboxAction::execute ( )

virtual

Executes the action.

Deprecated

QGIS 4.4. Use trigger() instead.

Definition at line 113 of file qgsprocessingprovideractions.cpp.

getIcon()

QIcon QgsProcessingToolboxAction::getIcon ( ) const

virtual

Returns the icon to use for the action.

Deprecated

QGIS 4.4. Use icon() instead.

Definition at line 83 of file qgsprocessingprovideractions.cpp.

groupName()

QString QgsProcessingToolboxAction::groupName ( ) const

inline

Returns the action's (translated, user visible) group name.

Definition at line 118 of file qgsprocessingprovideractions.h.

icon()

QIcon QgsProcessingToolboxAction::icon ( ) const

virtual

Returns the icon to use for the action.

Definition at line 68 of file qgsprocessingprovideractions.cpp.

setActionName()

Q_DECL_DEPRECATED void QgsProcessingToolboxAction::setActionName ( const QString & name )

inline

Sets the action's (translated, user visible) name.

Deprecated

QGIS 4.4. Use the constructor setter instead.

Definition at line 113 of file qgsprocessingprovideractions.h.

setData()

void QgsProcessingToolboxAction::setData

(

QgsDockWidget *

widget

)

Sets the parent toolbox widget the action will be shown in.

Deprecated

QGIS 4.4

Definition at line 96 of file qgsprocessingprovideractions.cpp.

setGroupName()

Q_DECL_DEPRECATED void QgsProcessingToolboxAction::setGroupName ( const QString & group )

inline

Sets the action's (translated, user visible) group name.

Deprecated

QGIS 4.4. Use the constructor setter instead.

Definition at line 125 of file qgsprocessingprovideractions.h.

trigger()

void QgsProcessingToolboxAction::trigger ( const QgsProcessingActionContext & context )

virtual

Triggers the action.

Definition at line 101 of file qgsprocessingprovideractions.cpp.

---

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

• /build/qgis-4.3.0+git20260918+6313fb5bce0+99sid/src/gui/processing/qgsprocessingprovideractions.h
• /build/qgis-4.3.0+git20260918+6313fb5bce0+99sid/src/gui/processing/qgsprocessingprovideractions.cpp