QgsProcessingHistoryProvider Class Reference

History provider for operations performed through the Processing framework. More...

#include <qgsprocessinghistoryprovider.h>

Inheritance diagram for QgsProcessingHistoryProvider:

Signals
void	createTest (const QString &command)
	Emitted when the provider needs to create a Processing test with the given python command.
void	executePython (const QString &commands)
	Emitted when the provider needs to execute python commands in the Processing context.

Public Member Functions
	QgsProcessingHistoryProvider ()
QgsHistoryEntryNode *	createNodeForEntry (const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context) override
	Creates a new history node for the given entry.
QString	id () const override
	Returns the provider's unique id, which is used to associate existing history entries with the provider.
void	portOldLog ()
	Ports the old text log to the history framework.
void	updateNodeForEntry (QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context) override
	Updates an existing history node for the given entry.
Public Member Functions inherited from QgsAbstractHistoryProvider
virtual	~QgsAbstractHistoryProvider ()

Friends
class	ProcessingHistoryBaseNode

Detailed Description

History provider for operations performed through the Processing framework.

Since

QGIS 3.24

Definition at line 30 of file qgsprocessinghistoryprovider.h.

Constructor & Destructor Documentation

QgsProcessingHistoryProvider()

QgsProcessingHistoryProvider::QgsProcessingHistoryProvider

(

)

Definition at line 40 of file qgsprocessinghistoryprovider.cpp.

Member Function Documentation

createNodeForEntry()

QgsHistoryEntryNode * QgsProcessingHistoryProvider::createNodeForEntry ( const QgsHistoryEntry &  entry, const QgsHistoryWidgetContext &  context  )

overridevirtual

Creates a new history node for the given entry.

Since

QGIS 3.32

Reimplemented from QgsAbstractHistoryProvider.

Definition at line 413 of file qgsprocessinghistoryprovider.cpp.

createTest

void QgsProcessingHistoryProvider::createTest ( const QString &  command )

signal

Emitted when the provider needs to create a Processing test with the given python command.

Since

QGIS 3.32

executePython

void QgsProcessingHistoryProvider::executePython ( const QString &  commands )

signal

Emitted when the provider needs to execute python commands in the Processing context.

Since

QGIS 3.32

id()

QString QgsProcessingHistoryProvider::id ( ) const

overridevirtual

Returns the provider's unique id, which is used to associate existing history entries with the provider.

Implements QgsAbstractHistoryProvider.

Definition at line 44 of file qgsprocessinghistoryprovider.cpp.

portOldLog()

void QgsProcessingHistoryProvider::portOldLog

(

)

Ports the old text log to the history framework.

This should only be called once – calling multiple times will result in duplicate log entries

Definition at line 49 of file qgsprocessinghistoryprovider.cpp.

updateNodeForEntry()

void QgsProcessingHistoryProvider::updateNodeForEntry ( QgsHistoryEntryNode *  node, const QgsHistoryEntry &  entry, const QgsHistoryWidgetContext &  context  )

overridevirtual

Updates an existing history node for the given entry.

Since

QGIS 3.32

Reimplemented from QgsAbstractHistoryProvider.

Definition at line 418 of file qgsprocessinghistoryprovider.cpp.

Friends And Related Symbol Documentation

ProcessingHistoryBaseNode

friend class ProcessingHistoryBaseNode

friend

Definition at line 74 of file qgsprocessinghistoryprovider.h.

---

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

• /build/qgis-3.41.0+git20241228+57ec4277f5e+99sid/src/gui/processing/qgsprocessinghistoryprovider.h
• /build/qgis-3.41.0+git20241228+57ec4277f5e+99sid/src/gui/processing/qgsprocessinghistoryprovider.cpp