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. More...

void	executePython (const QString &commands)
	Emitted when the provider needs to execute python commands in the Processing context. More...

Public Member Functions
	QgsProcessingHistoryProvider ()

QgsHistoryEntryNode *	createNodeForEntry (const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context) override
	Creates a new history node for the given entry. More...

QString	id () const override
	Returns the provider's unique id, which is used to associate existing history entries with the provider. More...

void	portOldLog ()
	Ports the old text log to the history framework. More...

Public Member Functions inherited from QgsAbstractHistoryProvider
virtual	~QgsAbstractHistoryProvider ()

virtual QgsHistoryEntryNode *	createNodeForEntry (const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
	Creates a new history node for the given entry. More...

virtual QString	id () const =0
	Returns the provider's unique id, which is used to associate existing history entries with the provider. More...

virtual void	updateNodeForEntry (QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
	Updates an existing history node for the given entry. More...

Friends
class	ProcessingHistoryNode

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 37 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 260 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 41 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 46 of file qgsprocessinghistoryprovider.cpp.

Friends And Related Function Documentation

◆ ProcessingHistoryNode

friend class ProcessingHistoryNode

friend

Definition at line 75 of file qgsprocessinghistoryprovider.h.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/processing/qgsprocessinghistoryprovider.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/processing/qgsprocessinghistoryprovider.cpp

Signals

Public Member Functions

Friends