Class: QgsAbstractHistoryProvider

Abstract base class for objects which track user history (i.e. operations performed through the GUI).

QgsAbstractHistoryProvider subclasses are accessible through the QgsHistoryProviderRegistry class.

Added in version 3.24.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: id()

Class Hierarchy

Inheritance diagram of qgis.gui.QgsAbstractHistoryProvider

Base classes

QObject

Subclasses

QgsProcessingHistoryProvider

History provider for operations performed through the Processing framework.

Abstract Methods

id

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

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAbstractHistoryProvider. See the FAQ for more details.

createNodeForEntry

Creates a new history node for the given entry.

updateNodeForEntry

Updates an existing history node for the given entry.
class qgis.gui.QgsAbstractHistoryProvider[source]

Bases: QObject

virtual createNodeForEntry(self, entry: QgsHistoryEntry, context: QgsHistoryWidgetContext) → QgsHistoryEntryNode | None[source]

Creates a new history node for the given entry.

Added in version 3.32.

Parameters:
Return type:

Optional[QgsHistoryEntryNode]

abstract id(self) → str[source]

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

Return type:

str

virtual updateNodeForEntry(self, node: QgsHistoryEntryNode | None, entry: QgsHistoryEntry, context: QgsHistoryWidgetContext)[source]

Updates an existing history node for the given entry.

Added in version 3.32.

Parameters: