QGIS API Documentation 4.3.0-Master (6313fb5bce0)
Loading...
Searching...
No Matches
QgsProcessingActionContext Class Reference

Encapsulates the context in which a Processing action is executed. More...

#include <qgsprocessingprovideractions.h>

Public Member Functions

QString algorithmName () const
 Returns the name of the algorithm associated with the action.
QWidget * parentWidget () const
 Returns the parent widget to use for dialogs constructed when triggering the action.
QString providerId () const
 Returns the ID of the provider associated with the action.
void setAlgorithmName (const QString &name)
 Sets the name of the algorithm associated with the action.
void setParentWidget (QWidget *widget)
 Sets the parent widget to use for dialogs constructed when triggering the action.
void setProviderId (const QString &id)
 Sets the ID of the provider associated with the action.

Detailed Description

Encapsulates the context in which a Processing action is executed.

Since
QGIS 4.4

Definition at line 34 of file qgsprocessingprovideractions.h.

Member Function Documentation

◆ algorithmName()

QString QgsProcessingActionContext::algorithmName ( ) const

Returns the name of the algorithm associated with the action.

See also
setAlgorithmName()

Definition at line 37 of file qgsprocessingprovideractions.cpp.

◆ parentWidget()

QWidget * QgsProcessingActionContext::parentWidget ( ) const

Returns the parent widget to use for dialogs constructed when triggering the action.

See also
setParentWidget()

Definition at line 27 of file qgsprocessingprovideractions.cpp.

◆ providerId()

QString QgsProcessingActionContext::providerId ( ) const

Returns the ID of the provider associated with the action.

See also
setProviderId()

Definition at line 47 of file qgsprocessingprovideractions.cpp.

◆ setAlgorithmName()

void QgsProcessingActionContext::setAlgorithmName ( const QString & name)

Sets the name of the algorithm associated with the action.

See also
algorithmName()

Definition at line 42 of file qgsprocessingprovideractions.cpp.

◆ setParentWidget()

void QgsProcessingActionContext::setParentWidget ( QWidget * widget)

Sets the parent widget to use for dialogs constructed when triggering the action.

See also
parentWidget()

Definition at line 32 of file qgsprocessingprovideractions.cpp.

◆ setProviderId()

void QgsProcessingActionContext::setProviderId ( const QString & id)

Sets the ID of the provider associated with the action.

See also
providerId()

Definition at line 52 of file qgsprocessingprovideractions.cpp.


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