Encapsulates a history entry. More...

#include <qgshistoryentry.h>

Public Member Functions
	QgsHistoryEntry ()=default
	Constructor for an invalid entry.

	QgsHistoryEntry (const QString &providerId, const QDateTime &timestamp, const QVariantMap &entry)
	Constructor for QgsHistoryEntry entry, with the specified providerId and timestamp.

	QgsHistoryEntry (const QVariantMap &entry)
	Constructor for QgsHistoryEntry entry.

bool	isValid () const
	Returns `true` if the entry is valid.

Public Attributes
QVariantMap	entry
	Entry details.

long long	id = 0
	Entry ID.

QString	providerId
	Associated history provider ID.

QDateTime	timestamp
	Entry timestamp.

Detailed Description

Encapsulates a history entry.

Since: QGIS 3.24

Definition at line 34 of file qgshistoryentry.h.

Constructor & Destructor Documentation

◆ QgsHistoryEntry() [1/3]

QgsHistoryEntry::QgsHistoryEntry ( )

default

Constructor for an invalid entry.

◆ QgsHistoryEntry() [2/3]

QgsHistoryEntry::QgsHistoryEntry	(	const QString &	providerId,
		const QDateTime &	timestamp,
		const QVariantMap &	entry
	)

explicit

Constructor for QgsHistoryEntry entry, with the specified providerId and timestamp.

Definition at line 19 of file qgshistoryentry.cpp.

◆ QgsHistoryEntry() [3/3]

QgsHistoryEntry::QgsHistoryEntry ( const QVariantMap & entry )

explicit

Constructor for QgsHistoryEntry entry.

The entry timestamp will be automatically set to the current date/time.

Definition at line 26 of file qgshistoryentry.cpp.

Member Function Documentation

◆ isValid()

bool QgsHistoryEntry::isValid ( ) const

Returns true if the entry is valid.

Since: QGIS 3.32

Definition at line 32 of file qgshistoryentry.cpp.

Member Data Documentation

◆ entry

QVariantMap QgsHistoryEntry::entry

Entry details.

Entries details are stored as a free-form map. Interpretation of this map is the responsibility of the associated history provider.

Definition at line 80 of file qgshistoryentry.h.

◆ id

long long QgsHistoryEntry::id = 0

Entry ID.

Since: QGIS 3.32

Definition at line 66 of file qgshistoryentry.h.

◆ providerId

QString QgsHistoryEntry::providerId

Associated history provider ID.

Definition at line 72 of file qgshistoryentry.h.

◆ timestamp

QDateTime QgsHistoryEntry::timestamp

Entry timestamp.

Definition at line 69 of file qgshistoryentry.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/history/qgshistoryentry.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/history/qgshistoryentry.cpp

Public Member Functions

Public Attributes