QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsMapLayerActionContext Class Reference

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

#include <qgsmaplayeractioncontext.h>

Public Member Functions

 QgsMapLayerActionContext ()
 
QgsAttributeDialogattributeDialog () const
 Returns the attribute dialog associated with the action's execution.
 
QgsMessageBarmessageBar () const
 Returns the message bar associated with the action's execution.
 
void setAttributeDialog (QgsAttributeDialog *dialog)
 Sets the attribute dialog associated with the action's execution.
 
void setMessageBar (QgsMessageBar *bar)
 Sets the message bar associated with the action's execution.
 

Detailed Description

Encapsulates the context in which a QgsMapLayerAction action is executed.

Since
QGIS 3.30

Definition at line 33 of file qgsmaplayeractioncontext.h.

Constructor & Destructor Documentation

◆ QgsMapLayerActionContext()

QgsMapLayerActionContext::QgsMapLayerActionContext ( )
default

Member Function Documentation

◆ attributeDialog()

QgsAttributeDialog * QgsMapLayerActionContext::attributeDialog ( ) const

Returns the attribute dialog associated with the action's execution.

May be nullptr if the action is not being executed from an attribute dialog.

See also
setAttributeDialog()

Definition at line 23 of file qgsmaplayeractioncontext.cpp.

◆ messageBar()

QgsMessageBar * QgsMapLayerActionContext::messageBar ( ) const

Returns the message bar associated with the action's execution.

May be nullptr.

See also
setMessageBar()

Definition at line 33 of file qgsmaplayeractioncontext.cpp.

◆ setAttributeDialog()

void QgsMapLayerActionContext::setAttributeDialog ( QgsAttributeDialog dialog)

Sets the attribute dialog associated with the action's execution.

See also
attributeDialog()

Definition at line 28 of file qgsmaplayeractioncontext.cpp.

◆ setMessageBar()

void QgsMapLayerActionContext::setMessageBar ( QgsMessageBar bar)

Sets the message bar associated with the action's execution.

See also
messageBar()

Definition at line 38 of file qgsmaplayeractioncontext.cpp.


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