QGIS API Documentation 3.37.0-Master (fa0c88a90b0)
Public Member Functions | List of all members
QgsAbstractHistoryProvider Class Referenceabstract

Abstract base class for objects which track user history (i.e. More...

#include <qgshistoryprovider.h>

Inheritance diagram for QgsAbstractHistoryProvider:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsAbstractHistoryProvider ()
 
virtual QgsHistoryEntryNodecreateNodeForEntry (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...
 

Detailed Description

Abstract base class for objects which track user history (i.e.

operations performed through the GUI).

QgsAbstractHistoryProvider subclasses are accessible through the QgsHistoryProviderRegistry class.

Since
QGIS 3.24

Definition at line 36 of file qgshistoryprovider.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractHistoryProvider()

QgsAbstractHistoryProvider::~QgsAbstractHistoryProvider ( )
virtualdefault

Member Function Documentation

◆ createNodeForEntry()

QgsHistoryEntryNode * QgsAbstractHistoryProvider::createNodeForEntry ( const QgsHistoryEntry entry,
const QgsHistoryWidgetContext context 
)
virtual

Creates a new history node for the given entry.

Since
QGIS 3.32

Reimplemented in QgsProcessingHistoryProvider, and QgsDatabaseQueryHistoryProvider.

Definition at line 21 of file qgshistoryprovider.cpp.

◆ id()

virtual QString QgsAbstractHistoryProvider::id ( ) const
pure virtual

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

Implemented in QgsProcessingHistoryProvider, and QgsDatabaseQueryHistoryProvider.

◆ updateNodeForEntry()

void QgsAbstractHistoryProvider::updateNodeForEntry ( QgsHistoryEntryNode node,
const QgsHistoryEntry entry,
const QgsHistoryWidgetContext context 
)
virtual

Updates an existing history node for the given entry.

Since
QGIS 3.32

Reimplemented in QgsDatabaseQueryHistoryProvider.

Definition at line 26 of file qgshistoryprovider.cpp.


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