QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsAbstractHistoryProvider Class Referenceabstract

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

#include <qgshistoryprovider.h>

Inheritance diagram for QgsAbstractHistoryProvider:

Public Member Functions

 ~QgsAbstractHistoryProvider () override
virtual QgsHistoryEntryNodecreateNodeForEntry (const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
 Creates a new history node for the given entry.
virtual QString id () const =0
 Returns the provider's unique id, which is used to associate existing history entries with the provider.
virtual void updateNodeForEntry (QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
 Updates an existing history node for the given entry.

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 37 of file qgshistoryprovider.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractHistoryProvider()

QgsAbstractHistoryProvider::~QgsAbstractHistoryProvider ( )
overridedefault

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 QgsDatabaseQueryHistoryProvider, and QgsProcessingHistoryProvider.

Definition at line 23 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 QgsDatabaseQueryHistoryProvider, and QgsProcessingHistoryProvider.

◆ 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, and QgsProcessingHistoryProvider.

Definition at line 28 of file qgshistoryprovider.cpp.


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